Changeset 9325

Timestamp:

01/09/2015 08:30:52 AM (11 years ago)

Author:

imath

Message:

Move activity scopes adjustment in filters

Separate the hardcoded scopes away from BP_Activity_Activity::get_scope_query_sql() to manage scope adjustments within components and to allow developers to make adjustments to them if needed.

See #4988
See #6040

props r-a-y

Location:

trunk/src/bp-activity

Files:

• bp-activity-classes.php (modified) (1 diff)
• bp-activity-filters.php (modified) (1 diff)

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

@@ -868 +868 @@
             $scope_args = array();
 
-            switch ( $scope ) {
-                case 'just-me' :
-                    $scope_args = array(
-                        'column' => 'user_id',
-                        'value'  => $r['user_id']
-                    );
-
-                    $scope_args['override']['display_comments'] = 'stream';
-
-                    // wipe out the user ID
-                    $scope_args['override']['filter']['user_id'] = 0;
-
-                    break;
-
-                case 'favorites':
-                    $favs = bp_activity_get_user_favorites( $r['user_id'] );
-                    if ( empty( $favs ) ) {
-                        return $scope_args;
-                    }
-
-                    $scope_args = array(
-                        'column'  => 'id',
-                        'compare' => 'IN',
-                        'value'   => (array) $favs
-                    );
-                    $scope_args['override']['display_comments']  = true;
-
-                    // wipe out the user ID
-                    $scope_args['override']['filter']['user_id'] = 0;
-
-                    break;
-
-                case 'mentions':
-                    // Are mentions disabled?
-                    if ( ! bp_activity_do_mentions() ) {
-                        return $scope_args;
-                    }
-
-                    $scope_args = array(
-                        'column'  => 'content',
-                        'compare' => 'LIKE',
-
-                        // Start search at @ symbol and stop search at closing tag delimiter.
-                        'value'   => '@' . bp_activity_get_user_mentionname( $r['user_id'] ) . '<'
-                    );
-
-                    // wipe out current search terms if any
-                    // this is so the 'mentions' scope can be combined with other scopes
-                    $scope_args['override']['search_terms'] = false;
-
-                    $scope_args['override']['display_comments'] = 'stream';
-                    $scope_args['override']['filter']['user_id'] = 0;
-
-                    break;
-
-                default :
-                    /**
-                     * Plugins can hook here to set their activity arguments for custom scopes.
-                     *
-                     * This is a dynamic filter based on the activity scope. eg:
-                     *   - 'bp_activity_set_groups_scope_args'
-                     *   - 'bp_activity_set_friends_scope_args'
-                     *
-                     * To see how this filter is used, plugin devs should check out:
-                     *   - bp_groups_filter_activity_scope() - used for 'groups' scope
-                     *   - bp_friends_filter_activity_scope() - used for 'friends' scope
-                     *
-                     * @since BuddyPress (2.2.0)
-                     *
-                     *  @param array {
-                     *     Activity query clauses.
-                     *
-                     *     @type array {
-                     *         Activity arguments for your custom scope.
-                     *         See {@link BP_Activity_Query::_construct()} for more details.
-                     *     }
-                     *     @type array $override Optional. Override existing activity arguments passed by $r.
-                     * }
-                     * @param array $r Current activity arguments passed in BP_Activity_Activity::get()
-                     */
-                    $scope_args = apply_filters( "bp_activity_set_{$scope}_scope_args", array(), $r );
-                    break;
-            }
+            /**
+             * Plugins can hook here to set their activity arguments for custom scopes.
+             *
+             * This is a dynamic filter based on the activity scope. eg:
+             *   - 'bp_activity_set_groups_scope_args'
+             *   - 'bp_activity_set_friends_scope_args'
+             *
+             * To see how this filter is used, plugin devs should check out:
+             *   - bp_groups_filter_activity_scope() - used for 'groups' scope
+             *   - bp_friends_filter_activity_scope() - used for 'friends' scope
+             *
+             * @since BuddyPress (2.2.0)
+             *
+             *  @param array {
+             *     Activity query clauses.
+             *
+             *     @type array {
+             *         Activity arguments for your custom scope.
+             *         See {@link BP_Activity_Query::_construct()} for more details.
+             *     }
+             *     @type array $override Optional. Override existing activity arguments passed by $r.
+             * }
+             * @param array $r Current activity arguments passed in BP_Activity_Activity::get()
+             */
+            $scope_args = apply_filters( "bp_activity_set_{$scope}_scope_args", array(), $r );
 
             if ( ! empty( $scope_args ) ) {

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

@@ -639 +639 @@
 }
 add_filter( 'bp_core_get_js_strings', 'bp_activity_heartbeat_strings', 10, 1 );
+
+/** SCOPES **************************************************************/
+
+/**
+ * Set up activity arguments for use with the 'just-me' scope.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param array $retval Empty array by default
+ * @param array $filter Current activity arguments
+ * @return array
+ */
+function bp_activity_filter_just_me_scope( $retval, $filter ) {
+    $retval = array(
+        'column' => 'user_id',
+        'value'  => $filter['user_id']
+    );
+
+    $retval['override']['display_comments'] = 'stream';
+
+    // wipe out the user ID
+    $retval['override']['filter']['user_id'] = 0;
+
+    return $retval;
+}
+add_filter( 'bp_activity_set_just-me_scope_args', 'bp_activity_filter_just_me_scope', 10, 2 );
+
+/**
+ * Set up activity arguments for use with the 'favorites' scope.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param array $retval Empty array by default
+ * @param array $filter Current activity arguments
+ * @return array
+ */
+function bp_activity_filter_favorites_scope( $retval, $filter ) {
+    $favs = bp_activity_get_user_favorites( $filter['user_id'] );
+    if ( empty( $favs ) ) {
+        return $retval;
+    }
+
+    $retval = array(
+        'column'  => 'id',
+        'compare' => 'IN',
+        'value'   => (array) $favs
+    );
+    $retval['override']['display_comments']  = true;
+
+    // wipe out the user ID
+    $retval['override']['filter']['user_id'] = 0;
+
+    return $retval;
+}
+add_filter( 'bp_activity_set_favorites_scope_args', 'bp_activity_filter_favorites_scope', 10, 2 );
+
+
+/**
+ * Set up activity arguments for use with the 'favorites' scope.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param array $retval Empty array by default
+ * @param array $filter Current activity arguments
+ * @return array
+ */
+function bp_activity_filter_mentions_scope( $retval, $filter ) {
+    // Are mentions disabled?
+    if ( ! bp_activity_do_mentions() ) {
+        return $retval;
+    }
+
+    $retval = array(
+        'column'  => 'content',
+        'compare' => 'LIKE',
+
+        // Start search at @ symbol and stop search at closing tag delimiter.
+        'value'   => '@' . bp_activity_get_user_mentionname( $filter['user_id'] ) . '<'
+    );
+
+    // wipe out current search terms if any
+    // this is so the 'mentions' scope can be combined with other scopes
+    $retval['override']['search_terms'] = false;
+
+    $retval['override']['display_comments'] = 'stream';
+    $retval['override']['filter']['user_id'] = 0;
+
+    return $retval;
+}
+add_filter( 'bp_activity_set_mentions_scope_args', 'bp_activity_filter_mentions_scope', 10, 2 );