Changeset 8787 for trunk/src/bp-activity/bp-activity-classes.php

Timestamp:

08/11/2014 03:13:23 PM (12 years ago)

Author:

r-a-y

Message:

Add ability to query activity items by date.

This commit:

• Introduces the BP_Date_Query class. This class extends WP_Date_Query, which will enable us to easily add support to query various BuddyPress items by date.
• Adds a new 'date_query' parameter to BP_Activity_Activity::get(). This parameter utilizes the new BP_Date_Query class and is an example of how to use the class in BuddyPress. (Will add support for the Groups component in a later commit.)
• Adds unit tests.

Due to the dependency on the WP_Date_Query class, this functionality is
only available in WordPress 3.7+.

Fixes #5803.

File:

• trunk/src/bp-activity/bp-activity-classes.php (modified) (4 diffs)

trunk/src/bp-activity/bp-activity-classes.php

@@ -258 +258 @@
      *     @type array $meta_query An array of meta_query conditions.
      *                             See WP_Meta_Query::queries for description.
+     *     @type array $date_query An array of date_query conditions.
+     *                             See first parameter of WP_Date_Query::__construct()
+     *                             for description.
      *     @type array $filter See BP_Activity_Activity::get_filter_sql().
      *     @type string $search_terms Limit results by a search term.
@@ -309 +312 @@
             'in'                => false,      // Array of ids to limit query by (IN)
             'meta_query'        => false,      // Filter by activitymeta
+            'date_query'        => false,      // Filter by date
             'filter'            => false,      // See self::get_filter_sql()
             'search_terms'      => false,      // Terms to search by
@@ -377 +381 @@
         }
 
+        // Process date_query into SQL
+        $date_query_sql = self::get_date_query_sql( $date_query );
+
+        if ( ! empty( $date_query_sql ) ) {
+            $where_conditions['date'] = $date_query_sql;
+        }
+
         // Alter the query based on whether we want to show activity item
         // comments in the stream like normal comments or threaded below
@@ -683 +694 @@
 
         return $sql_array;
+    }
+
+    /**
+     * Get the SQL for the 'date_query' param in BP_Activity_Activity::get().
+     *
+     * We use BP_Date_Query, which extends WP_Date_Query, to do the heavy lifting
+     * of parsing the date_query array and creating the necessary SQL clauses.
+     * However, since BP_Activity_Activity::get() builds its SQL differently than
+     * WP_Query, we have to alter the return value (stripping the leading AND
+     * keyword from the query).
+     *
+     * @since BuddyPress (2.1.0)
+     *
+     * @param array $date_query An array of date_query parameters. See the
+     *        documentation for the first parameter of WP_Date_Query.
+     * @return string
+     */
+    public static function get_date_query_sql( $date_query = array() ) {
+        $sql = '';
+
+        // Date query
+        if ( ! empty( $date_query ) && is_array( $date_query ) && class_exists( 'BP_Date_Query' ) ) {
+            $date_query = new BP_Date_Query( $date_query, 'date_recorded' );
+            $sql = preg_replace( '/^\sAND/', '', $date_query->get_sql() );
+        }
+
+        return $sql;
     }