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

Timestamp:

06/02/2015 05:21:07 AM (10 years ago)

Author:

tw2113

Message:

Initial documentation cleanup for the BP Groups component.

See #6401.

File:

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

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

@@ -1 +1 @@
 <?php
 /**
- * BuddyPress Groups Classes
+ * BuddyPress Groups Classes.
  *
  * @package BuddyPress
@@ -14 +14 @@
  *
  * Special notes about the group members data schema:
- * - *Members* are entries with is_confirmed = 1
- * - *Pending requests* are entries with is_confirmed = 0 and inviter_id = 0
+ * - *Members* are entries with is_confirmed = 1.
+ * - *Pending requests* are entries with is_confirmed = 0 and inviter_id = 0.
  * - *Pending and sent invitations* are entries with is_confirmed = 0 and
- *   inviter_id != 0 and invite_sent = 1
+ *   inviter_id != 0 and invite_sent = 1.
  * - *Pending and unsent invitations* are entries with is_confirmed = 0 and
- *   inviter_id != 0 and invite_sent = 0
+ *   inviter_id != 0 and invite_sent = 0.
  * - *Membership requests* are entries with is_confirmed = 0 and
- *   inviter_id = 0 (and invite_sent = 0)
+ *   inviter_id = 0 (and invite_sent = 0).
  *
  * @since BuddyPress (1.8.0)
  *
- * @param array $args {
+ * @param array $args  {
  *     Array of arguments. Accepts all arguments from
  *     {@link BP_User_Query}, with the following additions:
- *     @type int $group_id ID of the group to limit results to.
- *     @type array $group_role Array of group roles to match ('member',
- *           'mod', 'admin', 'banned'). Default: array( 'member' ).
- *     @type bool $is_confirmed Whether to limit to confirmed members.
- *           Default: true.
- *     @type string $type Sort order. Accepts any value supported by
- *           {@link BP_User_Query}, in addition to 'last_joined' and
- *           'first_joined'. Default: 'last_joined'.
+ *
+ *     @type int    $group_id     ID of the group to limit results to.
+ *     @type array  $group_role   Array of group roles to match ('member',
+ *                                'mod', 'admin', 'banned').
+ *                                Default: array( 'member' ).
+ *     @type bool   $is_confirmed Whether to limit to confirmed members.
+ *                                Default: true.
+ *     @type string $type         Sort order. Accepts any value supported by
+ *                                {@link BP_User_Query}, in addition to 'last_joined'
+ *                                and 'first_joined'. Default: 'last_joined'.
  * }
  */
@@ -78 +80 @@
      *
      * @param array $include Existing group IDs in the $include parameter,
-     *        as calculated in BP_User_Query.
+     *                       as calculated in BP_User_Query.
      * @return array
      */
@@ -298 +300 @@
      * @since BuddyPress (1.8.0)
      *
-     * @param BP_User_Query $query BP_User_Query object. Because we're
-     *        filtering the current object, we use $this inside of the
-     *        method instead.
-     * @param string $user_ids_sql Sanitized, comma-separated string of
-     *        the user ids returned by the main query.
+     * @param BP_User_Query $query        BP_User_Query object. Because we're
+     *                                    filtering the current object, we use
+     *                                    $this inside of the method instead.
+     * @param string        $user_ids_sql Sanitized, comma-separated string of
+     *                                    the user ids returned by the main query.
      */
     public function populate_group_member_extras( $query, $user_ids_sql ) {
@@ -336 +338 @@
      * @since BuddyPress (2.1.0)
      *
-     * @param BP_User_Query $query BP_User_Query object.
-     * @param array $gm_ids array of group member ids.
+     * @param BP_User_Query $query  BP_User_Query object.
+     * @param array         $gm_ids array of group member ids.
+     *
      * @return array
      */