<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][7549] trunk/bp-notifications: Introduce `BP_Notifications_Notification` methods for handling LIMIT and ORDER BY MySQL to act as the foundation for customizing sorting and pagination arguments.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://buddypress.trac.wordpress.org/changeset/7549">7549</a></dd>
<dt>Author</dt> <dd>johnjamesjacoby</dd>
<dt>Date</dt> <dd>2013-11-09 17:04:41 +0000 (Sat, 09 Nov 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Introduce `BP_Notifications_Notification` methods for handling LIMIT and ORDER BY MySQL to act as the foundation for customizing sorting and pagination arguments. Also flip default notification order from ASC to DESC for a top-down view. See <a href="http://buddypress.trac.wordpress.org/ticket/5148">#5148</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpnotificationsbpnotificationsclassesphp">trunk/bp-notifications/bp-notifications-classes.php</a></li>
<li><a href="#trunkbpnotificationsbpnotificationstemplatephp">trunk/bp-notifications/bp-notifications-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpnotificationsbpnotificationsclassesphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-notifications/bp-notifications-classes.php (7548 => 7549)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-notifications/bp-notifications-classes.php 2013-11-09 15:47:14 UTC (rev 7548)
+++ trunk/bp-notifications/bp-notifications-classes.php 2013-11-09 17:04:41 UTC (rev 7549)
</span><span class="lines">@@ -254,6 +254,7 @@
</span><span class="cx"> global $wpdb;
</span><span class="cx">
</span><span class="cx"> $where_conditions = array();
</span><ins>+ $where = '';
</ins><span class="cx">
</span><span class="cx"> // id
</span><span class="cx"> if ( ! empty( $args['id'] ) ) {
</span><span class="lines">@@ -326,16 +327,81 @@
</span><span class="cx"> $where_conditions['search_terms'] = "( component_name LIKE '%%$search_terms%%' OR component_action LIKE '%%$search_terms%%' )";
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ // Custom WHERE
</ins><span class="cx"> if ( ! empty( $where_conditions ) ) {
</span><span class="cx"> $where = 'WHERE ' . implode( ' AND ', $where_conditions );
</span><del>- } else {
- $where = '';
</del><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> return $where;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Assemble the ORDER BY clause of a get() SQL statement.
+ *
+ * Used by BP_Notifications_Notification::get() to create its ORDER BY
+ * clause.
+ *
+ * @since BuddyPress (1.9.0)
+ *
+ * @param array $args See {@link BP_Notifications_Notification::get()}
+ * for more details.
+ * @return string ORDER BY clause.
+ */
+ protected static function get_order_by_sql( $args = array() ) {
+
+ // Setup local variable
+ $conditions = array();
+ $retval = '';
+
+ // Order by
+ if ( ! empty( $args['order_by'] ) ) {
+ $order_by = implode( ', ', (array) $args['order_by'] );
+ $conditions['order_by'] = "{$order_by}";
+ }
+
+ // Sort order direction
+ if ( ! empty( $args['sort_order'] ) && in_array( $args['sort_order'], array( 'ASC', 'DESC' ) ) ) {
+ $sort_order = $args['sort_order'];
+ $conditions['sort_order'] = "{$sort_order}";
+ }
+
+ // Custom ORDER BY
+ if ( ! empty( $conditions ) ) {
+ $retval = 'ORDER BY ' . implode( ' ', $conditions );
+ }
+
+ return $retval;
+ }
+
+ /**
+ * Assemble the LIMIT clause of a get() SQL statement.
+ *
+ * Used by BP_Notifications_Notification::get() to create its LIMIT clause.
+ *
+ * @since BuddyPress (1.9.0)
+ *
+ * @param array $args See {@link BP_Notifications_Notification::get()}
+ * for more details.
+ * @return string LIMIT clause.
+ */
+ protected static function get_paged_sql( $args = array() ) {
+ global $wpdb;
+
+ // Setup local variable
+ $retval = '';
+
+ // Custom LIMIT
+ if ( ! empty( $args['page'] ) && ! empty( $args['per_page'] ) ) {
+ $page = absint( $args['page'] );
+ $per_page = absint( $args['per_page'] );
+ $offset = $per_page * ( $page - 1 );
+ $retval = $wpdb->prepare( "LIMIT %d, %d", $offset, $per_page );
+ }
+
+ return $retval;
+ }
+
+ /**
</ins><span class="cx"> * Assemble query clauses, based on arrguments, to pass to $wpdb methods.
</span><span class="cx"> *
</span><span class="cx"> * The insert(), update(), and delete() methods of {@link wpdb} expect
</span><span class="lines">@@ -481,7 +547,8 @@
</span><span class="cx"> public static function get( $args = array() ) {
</span><span class="cx"> global $wpdb;
</span><span class="cx">
</span><del>- $r = wp_parse_args( $args, array(
</del><ins>+ // Parse the arguments
+ $r = wp_parse_args( $args, array(
</ins><span class="cx"> 'id' => false,
</span><span class="cx"> 'user_id' => false,
</span><span class="cx"> 'item_id' => false,
</span><span class="lines">@@ -490,14 +557,19 @@
</span><span class="cx"> 'component_action' => false,
</span><span class="cx"> 'is_new' => true,
</span><span class="cx"> 'search_terms' => '',
</span><ins>+ 'order_by' => false,
+ 'sort_order' => false,
</ins><span class="cx"> 'page' => false,
</span><span class="cx"> 'per_page' => false,
</span><span class="cx"> ) );
</span><span class="cx">
</span><del>- $bp = buddypress();
- $pag_sql = '';
</del><ins>+ // SELECT
</ins><span class="cx"> $select_sql = "SELECT *";
</span><del>- $from_sql = "FROM {$bp->notifications->table_name}";
</del><ins>+
+ // FROM
+ $from_sql = "FROM " . buddypress()->notifications->table_name;
+
+ // WHERE
</ins><span class="cx"> $where_sql = self::get_where_sql( array(
</span><span class="cx"> 'id' => $r['id'],
</span><span class="cx"> 'user_id' => $r['user_id'],
</span><span class="lines">@@ -509,15 +581,20 @@
</span><span class="cx"> 'search_terms' => $r['search_terms'],
</span><span class="cx"> ) );
</span><span class="cx">
</span><del>- if ( ! empty( $r['page'] ) && ! empty( $r['per_page'] ) ) {
- $page = absint( $r['page'] );
- $per_page = absint( $r['per_page'] );
- $offset = $per_page * ( $page - 1 );
- $pag_sql = $wpdb->prepare( "LIMIT %d, %d", $offset, $per_page );
- }
</del><ins>+ // ORDER BY
+ $order_sql = self::get_order_by_sql( array(
+ 'order_by' => $r['order_by'],
+ 'sort_order' => $r['sort_order']
+ ) );
</ins><span class="cx">
</span><del>- $sql = "{$select_sql} {$from_sql} {$where_sql} {$pag_sql}";
</del><ins>+ // LIMIT %d, %d
+ $pag_sql = self::get_paged_sql( array(
+ 'page' => $r['page'],
+ 'per_page' => $r['per_page'],
+ ) );
</ins><span class="cx">
</span><ins>+ $sql = "{$select_sql} {$from_sql} {$where_sql} {$order_sql} {$pag_sql}";
+
</ins><span class="cx"> return $wpdb->get_results( $sql );
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre></div>
<a id="trunkbpnotificationsbpnotificationstemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/bp-notifications/bp-notifications-template.php (7548 => 7549)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-notifications/bp-notifications-template.php 2013-11-09 15:47:14 UTC (rev 7548)
+++ trunk/bp-notifications/bp-notifications-template.php 2013-11-09 17:04:41 UTC (rev 7549)
</span><span class="lines">@@ -226,6 +226,8 @@
</span><span class="cx"> 'is_new' => true,
</span><span class="cx"> 'page' => 1,
</span><span class="cx"> 'per_page' => 25,
</span><ins>+ 'order_by' => 'date_notified',
+ 'sort_order' => 'DESC',
</ins><span class="cx"> 'max' => null,
</span><span class="cx"> 'search_terms' => '',
</span><span class="cx"> 'page_arg' => 'npage',
</span><span class="lines">@@ -238,6 +240,8 @@
</span><span class="cx"> $this->is_new = $r['is_new'];
</span><span class="cx"> $this->search_terms = $r['search_terms'];
</span><span class="cx"> $this->page_arg = $r['page_arg'];
</span><ins>+ $this->order_by = $r['order_by'];
+ $this->sort_order = $r['sort_order'];
</ins><span class="cx">
</span><span class="cx"> // Get the notifications
</span><span class="cx"> $notifications = BP_Notifications_Notification::get_current_notifications_for_user( array(
</span><span class="lines">@@ -246,6 +250,8 @@
</span><span class="cx"> 'page' => $this->pag_page,
</span><span class="cx"> 'per_page' => $this->pag_num,
</span><span class="cx"> 'search_terms' => $this->search_terms,
</span><ins>+ 'order_by' => $this->order_by,
+ 'sort_order' => $this->sort_order,
</ins><span class="cx"> ) );
</span><span class="cx">
</span><span class="cx"> // Setup the notifications to loop through
</span></span></pre>
</div>
</div>
</body>
</html>