Changeset 7549 for trunk/bp-notifications/bp-notifications-classes.php

Timestamp:

11/09/2013 05:04:41 PM (13 years ago)

Author:

johnjamesjacoby

Message:

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 #5148.

File:

• trunk/bp-notifications/bp-notifications-classes.php (modified) (5 diffs)

trunk/bp-notifications/bp-notifications-classes.php

@@ -255 +255 @@
 
                 $where_conditions = array();
+                $where            = '';
 
                 // id
@@ -327 +328 @@
                 }
 
+                // Custom WHERE
                 if ( ! empty( $where_conditions ) ) {
                         $where = 'WHERE ' . implode( ' AND ', $where_conditions );
-                } else {
-                        $where = '';
                 }
 
                 return $where;
+        }
+
+        /**
+         * 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;
         }
 
@@ -482 +548 @@
                 global $wpdb;
 
-                $r = wp_parse_args( $args, array(
+                // Parse the arguments
+                $r  = wp_parse_args( $args, array(
                         'id'                => false,
                         'user_id'           => false,
@@ -491 +558 @@
                         'is_new'            => true,
                         'search_terms'      => '',
+                        'order_by'          => false,
+                        'sort_order'        => false,
                         'page'              => false,
                         'per_page'          => false,
                 ) );
 
-                $bp         = buddypress();
-                $pag_sql    = '';
+                // SELECT
                 $select_sql = "SELECT *";
-                $from_sql   = "FROM {$bp->notifications->table_name}";
+
+                // FROM
+                $from_sql   = "FROM " . buddypress()->notifications->table_name;
+
+                // WHERE
                 $where_sql  = self::get_where_sql( array(
                         'id'                => $r['id'],
@@ -510 +582 @@
                 ) );
 
-                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 );
-                }
-
-                $sql = "{$select_sql} {$from_sql} {$where_sql} {$pag_sql}";
+                // ORDER BY
+                $order_sql  = self::get_order_by_sql( array(
+                        'order_by'   => $r['order_by'],
+                        'sort_order' => $r['sort_order']
+                ) );
+
+                // LIMIT %d, %d
+                $pag_sql    = self::get_paged_sql( array(
+                        'page'     => $r['page'],
+                        'per_page' => $r['per_page'],
+                ) );
+
+                $sql = "{$select_sql} {$from_sql} {$where_sql} {$order_sql} {$pag_sql}";
 
                 return $wpdb->get_results( $sql );