Changeset 13337

Timestamp:

10/06/2022 10:31:49 PM (2 years ago)

Author:

imath

Message:

Activity introduce 2 new parameters to BP_Activity_Activity::get()`

• The user_id__in parameter makes it possible to retrieve activities for

a list of user IDs.

• The user_id__not_in parameter makes it possible to exclude activity

posted by a list of user IDs from retrieved activities.

Props username_, slaFFik, boonebgorges

Fixes #4184

Location:

trunk

Files:

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

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

@@ -1848 +1848 @@
             'date_query'        => false,        // Filter by date. See first parameter of WP_Date_Query for format.
             'filter_query'      => false,
+            'user_id__in'       => array(),      // Array of user ids to include.
+            'user_id__not_in'   => array(),      // Array of user ids to excluce.
             'show_hidden'       => false,        // Show activity items that are hidden site-wide?
             'exclude'           => false,        // Comma-separated list of activity IDs to exclude.
@@ -1883 +1885 @@
             'filter_query'      => $r['filter_query'],
             'filter'            => $r['filter'],
+            'user_id__in'       => $r['user_id__in'],
+            'user_id__not_in'   => $r['user_id__not_in'],
             'scope'             => $r['scope'],
             'display_comments'  => $r['display_comments'],

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

@@ -343 +343 @@
      * @since 2.9.0 Introduced the `$order_by` parameter.
      * @since 10.0.0 Introduced the `$count_total_only` parameter.
+     * @since 11.0.0 Introduced the `$user_id__in` and `$user_id__not_in` parameters.
      *
      * @see BP_Activity_Activity::get_filter_sql() for a description of the
@@ -367 +368 @@
      *     @type string|array $scope             Pre-determined set of activity arguments.
      *     @type array        $filter            See BP_Activity_Activity::get_filter_sql().
+     *     @type array        $user_id__in       An array of user ids to include. Activity posted by users matching one of these
+     *                                           user ids will be included in results. Default empty array.
+     *     @type array        $user_id__not_in   An array of user ids to exclude. Activity posted by users matching one of these
+     *                                           user ids will not be included in results. Default empty array.
      *     @type string       $search_terms      Limit results by a search term. Default: false.
      *     @type bool         $display_comments  Whether to include activity comments. Default: false.
@@ -431 +436 @@
                 'date_query'        => false,           // Filter by date.
                 'filter_query'      => false,           // Advanced filtering - see BP_Activity_Query.
+                'user_id__in'       => array(),         // Array of user ids to include.
+                'user_id__not_in'   => array(),         // Array of user ids to excluce.
                 'filter'            => false,           // See self::get_filter_sql().
                 'scope'             => false,           // Preset activity arguments.
@@ -482 +489 @@
         if ( $r['filter'] && $filter_sql = BP_Activity_Activity::get_filter_sql( $r['filter'] ) ) {
             $where_conditions['filter_sql'] = $filter_sql;
+        }
+
+        // User IDs filtering.
+        $user_ids_clause  = array();
+        $user_ids_filters = array_filter(
+            array_intersect_key(
+                $r,
+                array(
+                    'user_id__in'     => true,
+                    'user_id__not_in' => true,
+                )
+            )
+        );
+
+        foreach ( $user_ids_filters as $user_ids_filter_key => $user_ids_filter ) {
+            $user_ids_operator = 'IN';
+            if ( 'user_id__not_in' === $user_ids_filter_key ) {
+                $user_ids_operator = 'NOT IN';
+            }
+
+            if ( $user_ids_clause ) {
+                $user_ids_clause[] = array(
+                    'column'  => 'user_id',
+                    'compare' => $user_ids_operator,
+                    'value'   => (array) $user_ids_filter,
+                );
+            } else {
+                $user_ids_clause = array(
+                    'relation' => 'AND',
+                    array(
+                        'column'  => 'user_id',
+                        'compare' => $user_ids_operator,
+                        'value'   => (array) $user_ids_filter,
+                    ),
+                );
+            }
+        }
+
+        if ( $user_ids_clause ) {
+            $user_ids_query = new BP_Activity_Query( $user_ids_clause );
+            $user_ids_sql   = $user_ids_query->get_sql();
+            if ( ! empty( $user_ids_sql ) ) {
+                $where_conditions['user_ids_query_sql'] = $user_ids_sql;
+            }
         }
 

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

@@ -413 +413 @@
     /**
      * @group get
+     */
+    public function test_get_with_user_id__in() {
+        $u1 = self::factory()->user->create();
+        $u2 = self::factory()->user->create();
+        $u3 = self::factory()->user->create();
+        $a1 = self::factory()->activity->create( array( 'user_id' => $u1 ) );
+        $a2 = self::factory()->activity->create( array( 'user_id' => $u2 ) );
+        $a3 = self::factory()->activity->create( array( 'user_id' => $u3 ) );
+
+        $activities = BP_Activity_Activity::get( array(
+            'user_id__in' => array( $u1, $u2 ),
+        ) );
+
+        $ids = wp_list_pluck( $activities['activities'], 'id' );
+        sort( $ids );
+        $this->assertEquals( array( $a1, $a2 ), $ids );
+    }
+
+    /**
+     * @group get
+     */
+    public function test_get_with_user_id__not_in() {
+        $u1 = self::factory()->user->create();
+        $u2 = self::factory()->user->create();
+        $u3 = self::factory()->user->create();
+        $a1 = self::factory()->activity->create( array( 'user_id' => $u1 ) );
+        $a2 = self::factory()->activity->create( array( 'user_id' => $u2 ) );
+        $a3 = self::factory()->activity->create( array( 'user_id' => $u3 ) );
+
+        $activities = BP_Activity_Activity::get( array(
+            'user_id__not_in' => array( $u2, $u3 ),
+        ) );
+
+        $ids = wp_list_pluck( $activities['activities'], 'id' );
+        $this->assertEquals( array( $a1 ), $ids );
+    }
+
+    /**
+     * @group get
+     */
+    public function test_get_with_user_id__in_andnot_in() {
+        $u1 = self::factory()->user->create();
+        $u2 = self::factory()->user->create();
+        $u3 = self::factory()->user->create();
+        $u4 = self::factory()->user->create();
+        $u5 = self::factory()->user->create();
+        $a1 = self::factory()->activity->create( array( 'user_id' => $u1 ) );
+        $a2 = self::factory()->activity->create( array( 'user_id' => $u2 ) );
+        $a3 = self::factory()->activity->create( array( 'user_id' => $u3 ) );
+        $a4 = self::factory()->activity->create( array( 'user_id' => $u4 ) );
+        $a5 = self::factory()->activity->create( array( 'user_id' => $u5 ) );
+
+        $activities = BP_Activity_Activity::get( array(
+            'user_id__in'     => array( $u1, $u2, $u4, $u5 ),
+            'user_id__not_in' => array( $u4, $u5 ),
+        ) );
+
+        $ids = wp_list_pluck( $activities['activities'], 'id' );
+        sort( $ids );
+        $this->assertEquals( array( $a1, $a2 ), $ids );
+    }
+
+    /**
+     * @group get
      * @group count_total
      */