Changeset 8787

Timestamp:

08/11/2014 03:13:23 PM (10 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.

Location:

trunk

Files:

• src/bp-activity/bp-activity-classes.php (modified) (4 diffs)
• src/bp-activity/bp-activity-functions.php (modified) (4 diffs)
• src/bp-activity/bp-activity-template.php (modified) (4 diffs)
• src/bp-core/bp-core-classes.php (modified) (1 diff)
• tests/phpunit/testcases/activity/class.BP_Activity_Activity.php (modified) (1 diff)
• tests/phpunit/testcases/activity/template.php (modified) (1 diff)

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;
     }
 

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

@@ -1020 +1020 @@
         'search_terms'      => false,        // Pass search terms as a string
         'meta_query'        => false,        // Filter by activity meta. See WP_Meta_Query for format
+        'date_query'        => false,        // Filter by date. See first parameter of WP_Date_Query for format
         'show_hidden'       => false,        // Show activity items that are hidden site-wide?
         'exclude'           => false,        // Comma-separated list of activity IDs to exclude
@@ -1041 +1042 @@
 
     // Attempt to return a cached copy of the first page of sitewide activity.
-    if ( ( 1 === (int) $r['page'] ) && empty( $r['max'] ) && empty( $r['search_terms'] ) && empty( $r['meta_query'] ) && empty( $r['filter'] ) && empty( $r['exclude'] ) && empty( $r['in'] ) && ( 'DESC' === $r['sort'] ) && empty( $r['exclude'] ) && ( 'ham_only' === $r['spam'] ) ) {
+    if ( ( 1 === (int) $r['page'] ) && empty( $r['max'] ) && empty( $r['search_terms'] ) && empty( $r['meta_query'] ) && empty( $r['date_query'] ) && empty( $r['filter'] ) && empty( $r['exclude'] ) && empty( $r['in'] ) && ( 'DESC' === $r['sort'] ) && empty( $r['exclude'] ) && ( 'ham_only' === $r['spam'] ) ) {
 
         $activity = wp_cache_get( 'bp_activity_sitewide_front', 'bp' );
@@ -1053 +1054 @@
                 'search_terms'      => $r['search_terms'],
                 'meta_query'        => $r['meta_query'],
+                'date_query'        => $r['date_query'],
                 'filter'            => $r['filter'],
                 'display_comments'  => $r['display_comments'],
@@ -1072 +1074 @@
             'search_terms'     => $r['search_terms'],
             'meta_query'       => $r['meta_query'],
+            'date_query'       => $r['date_query'],
             'filter'           => $r['filter'],
             'display_comments' => $r['display_comments'],

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

@@ -179 +179 @@
             'search_terms'      => false,
             'meta_query'        => false,
+            'date_query'        => false,
             'display_comments'  => 'threaded',
             'show_hidden'       => false,
@@ -221 +222 @@
                 'search_terms'      => $search_terms,
                 'meta_query'        => $meta_query,
+                'date_query'        => $date_query,
                 'filter'            => $filter,
                 'show_hidden'       => $show_hidden,
@@ -568 +570 @@
 
         'meta_query'        => false,        // filter on activity meta. See WP_Meta_Query for format
+        'date_query'        => false,        // filter by date. See first parameter of WP_Date_Query for format
 
         // Searching
@@ -681 +684 @@
         'search_terms'      => $search_terms,
         'meta_query'        => $meta_query,
+        'date_query'        => $date_query,
         'display_comments'  => $display_comments,
         'show_hidden'       => $show_hidden,

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

@@ -1508 +1508 @@
 }
 
+if ( class_exists( 'WP_Date_Query' ) ) :
+/**
+ * BuddyPress date query class.
+ *
+ * Extends the {@link WP_Date_Query} class for use with BuddyPress.
+ *
+ * @since BuddyPress (2.1.0)
+ *
+ * @param array $date_query {
+ *     Date query arguments.  See first parameter of {@link WP_Date_Query::__construct()}.
+ * }
+ * @param string $column The DB column to query against.
+ */
+class BP_Date_Query extends WP_Date_Query {
+    /**
+     * The column to query against. Can be changed via the query arguments.
+     *
+     * @var string
+     */
+    public $column;
+
+    /**
+     * Constructor.
+     *
+     * @see WP_Date_Query::__construct()
+     */
+    public function __construct( $date_query, $column = '' ) {
+        if ( ! empty( $column ) ) {
+            $this->column = $column;
+            add_filter( 'date_query_valid_columns', array( $this, 'register_date_column' ) );
+        }
+
+        parent::__construct( $date_query, $column );
+    }
+
+    /**
+     * Destructor.
+     */
+    public function __destruct() {
+        remove_filter( 'date_query_valid_columns', array( $this, 'register_date_column' ) );    
+    }
+
+    /**
+     * Registers our date column with WP Date Query to pass validation.
+     *
+     * @param array $retval Current DB columns
+     * @return array
+     */
+    public function register_date_column( $retval = array() ) {
+        $retval[] = $this->column;
+        return $retval;
+    }
+}
+endif;
 
 /**

trunk/tests/phpunit/testcases/activity/class.BP_Activity_Activity.php

@@ -146 +146 @@
     /**
      * @group get
+     * @group date_query
+     */
+    public function test_get_with_date_query() {
+        if ( ! class_exists( 'WP_Date_Query' ) ) {
+            return;
+        }
+
+        $a1 = $this->factory->activity->create();
+        $a2 = $this->factory->activity->create( array(
+            'recorded_time' => '2001-01-01 12:00'
+        ) );
+        $a3 = $this->factory->activity->create( array(
+            'recorded_time' => '2005-01-01 12:00'
+        ) );
+
+        // 'date_query' before test
+        $query = BP_Activity_Activity::get( array(
+            'date_query' => array( array(
+                'before' => array(
+                    'year'  => 2004,
+                    'month' => 1,
+                    'day'   => 1,
+                ),
+            ) )
+        ) );
+        $this->assertEquals( array( $a2 ), wp_list_pluck( $query['activities'], 'id' ) );
+
+        // 'date_query' range test
+        $query = BP_Activity_Activity::get( array(
+            'date_query' => array( array(
+                'after'  => 'January 2nd, 2001',
+                'before' => array(
+                    'year'  => 2013,
+                    'month' => 1,
+                    'day'   => 1,
+                ),
+                'inclusive' => true,
+            ) )
+        ) );
+        $this->assertEquals( array( $a3 ), wp_list_pluck( $query['activities'], 'id' ) );
+
+        // 'date_query' after and relative test
+        $query = BP_Activity_Activity::get( array(
+            'date_query' => array( array(
+                'after' => '1 day ago'
+            ) )
+        ) );
+        $this->assertEquals( array( $a1 ), wp_list_pluck( $query['activities'], 'id' ) );
+    }
+
+    /**
+     * @group get
      */
     public function test_get_with_search_terms() {

trunk/tests/phpunit/testcases/activity/template.php

@@ -513 +513 @@
         }
     }
+
+    /**
+     * Integration test for 'date_query' param
+     *
+     * @group date_query
+     */
+    function test_bp_has_activities_with_date_query() {
+        if ( ! class_exists( 'WP_Date_Query' ) ) {
+            return;
+        }
+
+        $a1 = $this->factory->activity->create();
+        $a2 = $this->factory->activity->create( array(
+            'recorded_time' => '2001-01-01 12:00'
+        ) );
+        $a3 = $this->factory->activity->create( array(
+            'recorded_time' => '2005-01-01 12:00'
+        ) );
+
+        global $activities_template;
+        bp_has_activities( array(
+            'date_query' => array( array(
+                'after' => '1 day ago'
+            ) )
+        ) );
+
+        $ids = wp_list_pluck( $activities_template->activities, 'id' );
+        $this->assertEquals( $ids, array( $a1 ) );
+    }
 }