Changeset 6321

Timestamp:

09/08/2012 03:12:39 AM (12 years ago)

Author:

boonebgorges

Message:

Converts bp_has_groups() stack to accept parameters as an array.

Arguments passed in the old style are converted to an array automatically, for
backward compatibility.

See #3797

Location:

trunk/bp-groups

Files:

• bp-groups-classes.php (modified) (1 diff)
• bp-groups-functions.php (modified) (2 diffs)
• bp-groups-template.php (modified) (2 diffs)

trunk/bp-groups/bp-groups-classes.php

@@ -306 +306 @@
     }
 
-    function get( $type = 'newest', $per_page = null, $page = null, $user_id = 0, $search_terms = false, $include = false, $populate_extras = true, $exclude = false, $show_hidden = false ) {
-        global $wpdb, $bp;
+    function get( $args = array() ) {
+        global $wpdb, $bp;
+
+        // Backward compatibility with old method of passing arguments
+        if ( ! is_array( $args ) || func_num_args() > 1 ) {
+            _deprecated_argument( __METHOD__, '1.7', sprintf( __( 'Arguments passed to %1$s should be in an associative array. See the inline documentation at %2$s for more details.', 'buddypress' ), __METHOD__, __FILE__ ) );
+
+            $old_args_keys = array(
+                0 => 'type',
+                1 => 'per_page',
+                2 => 'page',
+                3 => 'user_id',
+                4 => 'search_terms',
+                5 => 'include',
+                6 => 'populate_extras',
+                7 => 'exclude',
+                8 => 'show_hidden',
+            );
+
+            $func_args = func_get_args();
+            $args      = bp_core_parse_args_array( $old_args_keys, $func_args );
+        }
+
+        $defaults = array(
+            'type'            => 'newest',
+            'per_page'        => null,
+            'page'            => null,
+            'user_id'         => 0,
+            'search_terms'    => false,
+            'include'         => false,
+            'populate_extras' => true,
+            'exclude'         => false,
+            'show_hidden'     => false
+        );
+
+        $r = wp_parse_args( $args, $defaults );
+        extract( $r );
 
         $sql       = array();

trunk/bp-groups/bp-groups-functions.php

@@ -390 +390 @@
 /*** Group Fetching, Filtering & Searching  *************************************/
 
+/**
+ * Get a collection of groups, based on the parameters passed
+ *
+ * @uses apply_filters_ref_array() Filter 'groups_get_groups' to modify return value
+ * @uses BP_Groups_Group::get()
+ * @param array $args See inline documentation for details
+ * @return array
+ */
 function groups_get_groups( $args = '' ) {
 
@@ -404 +412 @@
     );
 
-    $params = wp_parse_args( $args, $defaults );
-    extract( $params, EXTR_SKIP );
-
-    $groups = BP_Groups_Group::get( $type, $per_page, $page, $user_id, $search_terms, $include, $populate_extras, $exclude, $show_hidden );
-
-    return apply_filters_ref_array( 'groups_get_groups', array( &$groups, &$params ) );
+    $r = wp_parse_args( $args, $defaults );
+
+    $groups = BP_Groups_Group::get( array(
+        'type'            => $r['type'],
+        'user_id'         => $r['user_id'],
+        'include'         => $r['include'],
+        'exclude'         => $r['exclude'],
+        'search_terms'    => $r['search_terms'],
+        'show_hidden'     => $r['show_hidden'],
+        'per_page'        => $r['per_page'],
+        'page'            => $r['page'],
+        'populate_extras' => $r['populate_extras']
+    ) );
+
+    return apply_filters_ref_array( 'groups_get_groups', array( &$groups, &$r ) );
 }
 

trunk/bp-groups/bp-groups-template.php

@@ -108 +108 @@
     var $order;
 
-    function __construct( $user_id, $type, $page, $per_page, $max, $slug, $search_terms, $populate_extras, $include = false, $exclude = false, $show_hidden = false, $page_arg = 'grpage' ){
+    function __construct( $args = array() ){
+
+        // Backward compatibility with old method of passing arguments
+        if ( ! is_array( $args ) || func_num_args() > 1 ) {
+            _deprecated_argument( __METHOD__, '1.7', sprintf( __( 'Arguments passed to %1$s should be in an associative array. See the inline documentation at %2$s for more details.', 'buddypress' ), __METHOD__, __FILE__ ) );
+
+            $old_args_keys = array(
+                0  => 'user_id',
+                1  => 'type',
+                2  => 'page',
+                3  => 'per_page',
+                4  => 'max',
+                5  => 'slug',
+                6  => 'search_terms',
+                7  => 'populate_extras',
+                8  => 'include',
+                9  => 'exclude',
+                10 => 'show_hidden',
+                11 => 'page_arg',
+            );
+
+            $func_args = func_get_args();
+            $args      = bp_core_parse_args_array( $old_args_keys, $func_args );
+        }
+
+        $defaults = array(
+            'type'            => 'active',
+            'page'            => 1,
+            'per_page'        => 20,
+            'max'             => false,
+            'show_hidden'     => false,
+            'page_arg'        => 'grpage',
+            'user_id'         => 0,
+            'slug'            => false,
+            'include'         => false,
+            'exclude'         => false,
+            'search_terms'    => '',
+            'populate_extras' => true
+        );
+
+        $r = wp_parse_args( $args, $defaults );
+        extract( $r );
 
         $this->pag_page = isset( $_REQUEST[$page_arg] ) ? intval( $_REQUEST[$page_arg] ) : $page;
@@ -274 +315 @@
 
     $r = wp_parse_args( $args, $defaults );
-    extract( $r );
-
-    if ( empty( $search_terms ) ) {
+
+    if ( empty( $r['search_terms'] ) ) {
         if ( isset( $_REQUEST['group-filter-box'] ) && !empty( $_REQUEST['group-filter-box'] ) )
-            $search_terms = $_REQUEST['group-filter-box'];
+            $r['search_terms'] = $_REQUEST['group-filter-box'];
         elseif ( isset( $_REQUEST['s'] ) && !empty( $_REQUEST['s'] ) )
-            $search_terms = $_REQUEST['s'];
+            $r['search_terms'] = $_REQUEST['s'];
         else
-            $search_terms = false;
-    }
-
-    $groups_template = new BP_Groups_Template( (int) $user_id, $type, (int) $page, (int) $per_page, (int) $max, $slug, $search_terms, (bool)$populate_extras, $include, $exclude, $show_hidden, $page_arg );
-    return apply_filters( 'bp_has_groups', $groups_template->has_groups(), $groups_template );
+            $r['search_terms'] = false;
+    }
+
+    $groups_template = new BP_Groups_Template( array(
+        'type'            => $r['type'],
+        'page'            => (int) $r['page'],
+        'per_page'        => (int) $r['per_page'],
+        'max'             => (int) $r['max'],
+        'show_hidden'     => $r['show_hidden'],
+        'page_arg'        => $r['page_arg'],
+        'user_id'         => (int) $r['user_id'],
+        'slug'            => $r['slug'],
+        'search_terms'    => $r['search_terms'],
+        'include'         => $r['include'],
+        'exclude'         => $r['exclude'],
+        'populate_extras' => (bool) $r['populate_extras']
+    ) );
+
+    return apply_filters( 'bp_has_groups', $groups_template->has_groups(), $groups_template, $r );
 }