Changeset 10373 for trunk/src/bp-groups/classes/class-bp-group-member-query.php

Timestamp:

11/22/2015 04:58:34 AM (9 years ago)

Author:

tw2113

Message:

More docs cleanup for BP-Groups component.

See #6401.

File:

• trunk/src/bp-groups/classes/class-bp-group-member-query.php (modified) (14 diffs)

trunk/src/bp-groups/classes/class-bp-group-member-query.php

@@ -58 +58 @@
         // Take this early opportunity to set the default 'type' param
         // to 'last_joined', which will ensure that BP_User_Query
-        // trusts our order and does not try to apply its own
+        // trusts our order and does not try to apply its own.
         if ( empty( $this->query_vars_raw['type'] ) ) {
             $this->query_vars_raw['type'] = 'last_joined';
         }
 
-        // Set the sort order
+        // Set the sort order.
         add_action( 'bp_pre_user_query', array( $this, 'set_orderby' ) );
 
-        // Set up our populate_extras method
+        // Set up our populate_extras method.
         add_action( 'bp_user_query_populate_extras', array( $this, 'populate_group_member_extras' ), 10, 2 );
     }
@@ -100 +100 @@
 
         // If the group member query returned no users, bail with an
-        // array that will guarantee no matches for BP_User_Query
+        // array that will guarantee no matches for BP_User_Query.
         if ( empty( $group_member_ids ) ) {
             return array( 0 );
@@ -134 +134 @@
         );
 
-        /** WHERE clauses *****************************************************/
-
-        // Group id
+        /* WHERE clauses *****************************************************/
+
+        // Group id.
         $sql['where'][] = $wpdb->prepare( "group_id = %d", $this->query_vars['group_id'] );
 
-        // is_confirmed
+        // If is_confirmed.
         $is_confirmed = ! empty( $this->query_vars['is_confirmed'] ) ? 1 : 0;
         $sql['where'][] = $wpdb->prepare( "is_confirmed = %d", $is_confirmed );
 
-        // invite_sent
+        // If invite_sent.
         if ( ! is_null( $this->query_vars['invite_sent'] ) ) {
             $invite_sent = ! empty( $this->query_vars['invite_sent'] ) ? 1 : 0;
@@ -149 +149 @@
         }
 
-        // inviter_id
+        // If inviter_id.
         if ( ! is_null( $this->query_vars['inviter_id'] ) ) {
             $inviter_id = $this->query_vars['inviter_id'];
 
-            // Empty: inviter_id = 0. (pass false, 0, or empty array)
+            // Empty: inviter_id = 0. (pass false, 0, or empty array).
             if ( empty( $inviter_id ) ) {
                 $sql['where'][] = "inviter_id = 0";
 
-            // The string 'any' matches any non-zero value (inviter_id != 0)
+            // The string 'any' matches any non-zero value (inviter_id != 0).
             } elseif ( 'any' === $inviter_id ) {
                 $sql['where'][] = "inviter_id != 0";
 
-            // Assume that a list of inviter IDs has been passed
+            // Assume that a list of inviter IDs has been passed.
             } else {
-                // Parse and sanitize
+                // Parse and sanitize.
                 $inviter_ids = wp_parse_id_list( $inviter_id );
                 if ( ! empty( $inviter_ids ) ) {
@@ -180 +180 @@
         }
 
-        // Sanitize: Only 'admin', 'mod', 'member', and 'banned' are valid
+        // Sanitize: Only 'admin', 'mod', 'member', and 'banned' are valid.
         $allowed_roles = array( 'admin', 'mod', 'member', 'banned' );
         foreach ( $roles as $role_key => $role_value ) {
@@ -192 +192 @@
         // When querying for a set of roles containing 'member' (for
         // which there is no dedicated is_ column), figure out a list
-        // of columns *not* to match
+        // of columns *not* to match.
         $roles_sql = '';
         if ( in_array( 'member', $roles ) ) {
@@ -205 +205 @@
 
         // When querying for a set of roles *not* containing 'member',
-        // simply construct a list of is_* = 1 clauses
+        // simply construct a list of is_* = 1 clauses.
         } else {
             $role_columns = array();
@@ -226 +226 @@
         // of 'type'. If the 'type' value is not 'last_joined' or
         // 'first_joined', the order will be overridden in
-        // BP_Group_Member_Query::set_orderby()
+        // BP_Group_Member_Query::set_orderby().
         $sql['orderby'] = "ORDER BY date_modified";
         $sql['order']   = 'first_joined' === $this->query_vars['type'] ? 'ASC' : 'DESC';
@@ -272 +272 @@
         if ( in_array( $query->query_vars['type'], array( 'last_joined', 'first_joined', 'group_activity' ) ) ) {
 
-            // Group Activity DESC
+            // Group Activity DESC.
             if ( 'group_activity' == $query->query_vars['type'] ) {
                 $gm_ids = $this->get_gm_ids_ordered_by_activity( $query, $gm_ids );
             }
 
-            // The first param in the FIELD() clause is the sort column id
+            // The first param in the FIELD() clause is the sort column id.
             $gm_ids = array_merge( array( 'u.id' ), wp_parse_id_list( $gm_ids ) );
             $gm_ids_sql = implode( ',', $gm_ids );
@@ -285 +285 @@
 
         // Prevent this filter from running on future BP_User_Query
-        // instances on the same page
+        // instances on the same page.
         remove_action( 'bp_pre_user_query', array( $this, 'set_orderby' ) );
     }
@@ -293 +293 @@
      *
      * Additional data fetched:
-     *
      *      - is_banned
      *      - date_modified
@@ -313 +312 @@
         foreach ( (array) $extras as $extra ) {
             if ( isset( $this->results[ $extra->user_id ] ) ) {
-                // user_id is provided for backward compatibility
+                // The user_id is provided for backward compatibility.
                 $this->results[ $extra->user_id ]->user_id       = (int) $extra->user_id;
                 $this->results[ $extra->user_id ]->is_admin      = (int) $extra->is_admin;
@@ -328 +327 @@
         }
 
-        // Don't filter other BP_User_Query objects on the same page
+        // Don't filter other BP_User_Query objects on the same page.
         remove_action( 'bp_user_query_populate_extras', array( $this, 'populate_group_member_extras' ), 10, 2 );
     }
@@ -339 +338 @@
      * @param BP_User_Query $query  BP_User_Query object.
      * @param array         $gm_ids array of group member ids.
-     *
      * @return array
      */