Context Navigation

← Previous Change
Next Change →

bp-groups-classes.php

Timestamp:

12/05/2013 07:38:20 PM (11 years ago)

Author:

boonebgorges

Message:

Improve inline documentation in bp-groups. See #5022

File:

: 1 edited

trunk/bp-groups/bp-groups-classes.php (modified) (101 diffs)

Legend:

: Unmodified
: Added
: Removed

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

-                      r7645
+                      r7648
+    }
+    /**
+     * Get a list of groups, sorted by those that have the most legacy forum topics.
+     *
+     * @param int $limit Optional. The max number of results to return.
+     *        Default: null (no limit).
+     * @param int $page Optional. The page offset of results to return.
+     *        Default: null (no limit).
+     * @param int $user_id Optional. If present, groups will be limited to
+     *        those of which the specified user is a member.
+     * @param string $search_terms Optional. Limit groups to those whose
+     *        name or description field contain the search string.
+     * @param bool $populate_extras Optional. Whether to fetch extra
+     *        information about the groups. Default: true.
+     * @param string|array Optional. Array or comma-separated list of group
+     *        IDs to exclude from results.
+     * @return array {
+     *     @type array $groups Array of group objects returned by the
+     *           paginated query.
+     *     @type int $total Total count of all groups matching non-
+     *           paginated query params.
+     * }
+     */
     public static function get_by_most_forum_topics( $limit = null, $page = null, $user_id = 0, $search_terms = false, $populate_extras = true, $exclude = false ) {
         global $wpdb, $bp, $bbdb;
 …
+    }
+    /**
+     * Get a list of groups, sorted by those that have the most legacy forum posts.
+     *
+     * @param int $limit Optional. The max number of results to return.
+     *        Default: null (no limit).
+     * @param int $page Optional. The page offset of results to return.
+     *        Default: null (no limit).
+     * @param int $user_id Optional. If present, groups will be limited to
+     *        those of which the specified user is a member.
+     * @param string $search_terms Optional. Limit groups to those whose
+     *        name or description field contain the search string.
+     * @param bool $populate_extras Optional. Whether to fetch extra
+     *        information about the groups. Default: true.
+     * @param string|array Optional. Array or comma-separated list of group
+     *        IDs to exclude from results.
+     * @return array {
+     *     @type array $groups Array of group objects returned by the
+     *           paginated query.
+     *     @type int $total Total count of all groups matching non-
+     *           paginated query params.
+     * }
+     */
     public static function get_by_most_forum_posts( $limit = null, $page = null, $search_terms = false, $populate_extras = true, $exclude = false ) {
         global $wpdb, $bp, $bbdb;
 …
+    }
+    /**
+     * Get a list of groups whose names start with a given letter.
+     *
+     * @param string $letter The letter.
+     * @param int $limit Optional. The max number of results to return.
+     *        Default: null (no limit).
+     * @param int $page Optional. The page offset of results to return.
+     *        Default: null (no limit).
+     * @param bool $populate_extras Optional. Whether to fetch extra
+     *        information about the groups. Default: true.
+     * @param string|array Optional. Array or comma-separated list of group
+     *        IDs to exclude from results.
+     * @return array {
+     *     @type array $groups Array of group objects returned by the
+     *           paginated query.
+     *     @type int $total Total count of all groups matching non-
+     *           paginated query params.
+     * }
+     */
     public static function get_by_letter( $letter, $limit = null, $page = null, $populate_extras = true, $exclude = false ) {
         global $wpdb, $bp;
 …
+    }
+    /**
+     * Get a list of random groups.
+     *
+     * Use BP_Groups_Group::get() with 'type' = 'random' instead.
+     *
+     * @param int $limit Optional. The max number of results to return.
+     *        Default: null (no limit).
+     * @param int $page Optional. The page offset of results to return.
+     *        Default: null (no limit).
+     * @param int $user_id Optional. If present, groups will be limited to
+     *        those of which the specified user is a member.
+     * @param string $search_terms Optional. Limit groups to those whose
+     *        name or description field contain the search string.
+     * @param bool $populate_extras Optional. Whether to fetch extra
+     *        information about the groups. Default: true.
+     * @param string|array Optional. Array or comma-separated list of group
+     *        IDs to exclude from results.
+     * @return array {
+     *     @type array $groups Array of group objects returned by the
+     *           paginated query.
+     *     @type int $total Total count of all groups matching non-
+     *           paginated query params.
+     * }
+     */
     public static function get_random( $limit = null, $page = null, $user_id = 0, $search_terms = false, $populate_extras = true, $exclude = false ) {
         global $wpdb, $bp;
 …
+    }
+    /**
+     * Fetch extra data for a list of groups.
+     *
+     * This method is used throughout the class, by methods that take a
+     * $populate_extras parameter.
+     *
+     * Data fetched:
+     *
+     *     - Logged-in user's status within each group (is_member,
+     *       is_confirmed, is_pending, is_banned)
+     *
+     * @param array $paged_groups Array of groups.
+     * @param string|array Array or comma-separated list of IDs matching
+     *        $paged_groups.
+     * @param string $type Not used.
+     * @return array $paged_groups
+     */
     public static function get_group_extras( &$paged_groups, &$group_ids, $type = false ) {
         global $bp, $wpdb;
 …
+    }
+    /**
+     * Delete all invitations to a given group.
+     *
+     * @param int $group_id ID of the group whose invitations are being
+     *        deleted.
+     * @return int|null Number of rows records deleted on success, null on
+     *         failure.
+     */
     public static function delete_all_invites( $group_id ) {
         global $wpdb, $bp;
 …
+    }
+    /**
+     * Get a total group count for the site.
+     *
+     * Will include hidden groups in the count only if
+     * current_user_can( 'bp_moderate' ).
+     *
+     * @return int Group count.
+     */
     public static function get_total_group_count() {
         global $wpdb, $bp;
 …
+    }
+    /**
+     * Get global count of forum topics in public groups (legacy forums).
+     *
+     * @param $type Optional. If 'unreplied', count will be limited to
+     *        those topics that have received no replies.
+     * @return int Forum topic count.
+     */
     public static function get_global_forum_topic_count( $type ) {
         global $bbdb, $wpdb, $bp;
 …
+    }
+    /**
+     * Get the member count for a group.
+     *
+     * @param int $group_id Group ID.
+     * @return int Count of confirmed members for the group.
+     */
     public static function get_total_member_count( $group_id ) {
         global $wpdb, $bp;
 …
      * Get a total count of all topics of a given status, across groups/forums
+     *
      * @package BuddyPress
      * @since BuddyPress (1.5)
+     *
      * @param string $status 'public', 'private', 'hidden', 'all' Which group types to count
+     * @since BuddyPress (1.5.0)
+     *
+     * @param string $status Which group type to count. 'public', 'private',
+     *        'hidden', or 'all'. Default: 'public'.
      * @return int The topic count
      */
 …
     /**
      * Get an array containing ids for each group type
+     * Get an array containing ids for each group type.
+     *
      * A bit of a kludge workaround for some issues
      * with bp_has_groups()
+     *
      * @since BuddyPress (1.7)
+     * with bp_has_groups().
+     *
+     * @since BuddyPress (1.7.0)
+     *
      * @return array
 …
 /**
  * Query for the members of a group
+ * Query for the members of a group.
+ *
  * @since BuddyPress (1.8)
+ * @since BuddyPress (1.8.0)
  */
 class BP_Group_Member_Query extends BP_User_Query {
+    /**
      * Array of group member ids, cached to prevent redundant lookups
+     *
      * @var null|array Null if not yet defined, otherwise an array of ints
+    /**
+     * Array of group member ids, cached to prevent redundant lookups.
+     *
      * @since BuddyPress (1.8.1)
+     * @var null|array Null if not yet defined, otherwise an array of ints.
      */
     protected $group_member_ids;
     /**
      * Set up action hooks
+     *
      * @since BuddyPress (1.8)
+     * Set up action hooks.
+     *
+     * @since BuddyPress (1.8.0)
      */
     public function setup_hooks() {
 …
     /**
      * Get a list of user_ids to include in the IN clause of the main query
+     * Get a list of user_ids to include in the IN clause of the main query.
+     *
      * Overrides BP_User_Query::get_include_ids(), adding our additional
      * group-member logic.
+     *
+     * @since BuddyPress (1.8)
+     * @param array
+     * @since BuddyPress (1.8.0)
+     *
+     * @param array $include Existing group IDs in the $include parameter,
+     *        as calculated in BP_User_Query.
      * @return array
      */
 …
     /**
+     * Get the members of the queried group
+     *
+     * @since BuddyPress (1.8)
+     * @return array $ids User IDs of relevant group member ids
+     * Get the members of the queried group.
+     *
+     * @since BuddyPress (1.8.0)
+     *
+     * @return array $ids User IDs of relevant group member ids.
      */
     protected function get_group_member_ids() {
 …
     /**
      * Tell BP_User_Query to order by the order of our query results
+     * Tell BP_User_Query to order by the order of our query results.
+     *
      * This implementation assumes the 'last_modified' sort order
      * hardcoded in BP_Group_Member_Query::get_group_member_ids().
+     *
      * @param object $query BP_User_Query object
+     * @param BP_User_Query $query BP_User_Query object.
      */
     public function set_orderby( $query ) {
 …
     /**
+     * Fetch additional data required in bp_group_has_members() loops
+     *
+     * @since BuddyPress (1.8)
+     * Fetch additional data required in bp_group_has_members() loops.
+     *
+     * Additional data fetched:
+     *
+     *      - is_banned
+     *      - date_modified
+     *
+     * @since BuddyPress (1.8.0)
+     *
      * @param object $query BP_User_Query object. Because we're filtering
      *   the current object, we use $this inside of the method instead
 …
+}
+/**
+ * BuddyPress Group Membership objects.
+ */
 class BP_Groups_Member {
+    /**
+     * ID of the membership.
+     *
+     * @access public
+     * @var int
+     */
     var $id;
+    /**
+     * ID of the group associated with the membership.
+     *
+     * @access public
+     * @var int
+     */
     var $group_id;
+    /**
+     * ID of the user associated with the membership.
+     *
+     * @access public
+     * @var int
+     */
     var $user_id;
+    /**
+     * ID of the user whose invitation initiated the membership.
+     *
+     * @access public
+     * @var int
+     */
     var $inviter_id;
+    /**
+     * Whether the member is an admin of the group.
+     *
+     * @access public
+     * @var int
+     */
     var $is_admin;
+    /**
+     * Whether the member is a mod of the group.
+     *
+     * @access public
+     * @var int
+     */
     var $is_mod;
+    /**
+     * Whether the member is banned from the group.
+     *
+     * @access public
+     * @var int
+     */
     var $is_banned;
+    /**
+     * Title used to describe the group member's role in the group.
+     *
+     * Eg, 'Group Admin'.
+     *
+     * @access public
+     * @var int
+     */
     var $user_title;
+    /**
+     * Last modified date of the membership.
+     *
+     * This value is updated when, eg, invitations are accepted.
+     *
+     * @access public
+     * @var string
+     */
     var $date_modified;
+    /**
+     * Whether the membership has been confirmed.
+     *
+     * @access public
+     * @var int
+     */
     var $is_confirmed;
+    /**
+     * Comments associated with the membership.
+     *
+     * In BP core, these are limited to the optional message users can
+     * include when requesting membership to a private group.
+     *
+     * @access public
+     * @var string
+     */
     var $comments;
+    /**
+     * Whether an invitation has been sent for this membership.
+     *
+     * The purpose of this flag is to mark when an invitation has been
+     * "drafted" (the user has been added via the interface at Send
+     * Invites), but the Send button has not been pressed, so the
+     * invitee has not yet been notified.
+     *
+     * @access public
+     * @var int
+     */
     var $invite_sent;
+    /**
+     * WP_User object representing the membership's user.
+     *
+     * @access public
+     * @var WP_User
+     */
     var $user;
+    /**
+     * Constructor method.
+     *
+     * @param int $user_id Optional. Along with $group_id, can be used to
+     *        look up a membership.
+     * @param int $group_id Optional. Along with $user_id, can be used to
+     *        look up a membership.
+     * @param int $id Optional. The unique ID of the membership object.
+     * @param bool $populate Whether to populate the properties of the
+     *        located membership. Default: true.
+     */
     public function __construct( $user_id = 0, $group_id = 0, $id = false, $populate = true ) {
 …
+    }
+    /**
+     * Populate the object's properties.
+     */
     public function populate() {
         global $wpdb, $bp;
 …
+    }
+    /**
+     * Save the membership data to the database.
+     *
+     * @return bool True on success, false on failure.
+     */
     public function save() {
         global $wpdb, $bp;
 …
+    }
+    /**
+     * Promote a member to a new status.
+     *
+     * @param string $status The new status. 'mod' or 'admin'.
+     * @return bool True on success, false on failure.
+     */
     public function promote( $status = 'mod' ) {
         if ( 'mod' == $status ) {
 …
+    }
+    /**
+     * Demote membership to Member status (non-admin, non-mod).
+     *
+     * @return bool True on success, false on failure.
+     */
     public function demote() {
         $this->is_mod     = 0;
 …
+    }
+    /**
+     * Ban the user from the group.
+     *
+     * @return bool True on success, false on failure.
+     */
     public function ban() {
         if ( !empty( $this->is_admin ) )
 …
+    }
+    /**
+     * Unban the user from the group.
+     *
+     * @return bool True on success, false on failure.
+     */
     public function unban() {
         if ( !empty( $this->is_admin ) )
 …
+    }
+    /**
+     * Mark a pending invitation as accepted.
+     */
     public function accept_invite() {
         $this->inviter_id    = 0;
 …
+    }
+    /**
+     * Confirm a membership request.
+     */
     public function accept_request() {
         $this->is_confirmed = 1;
 …
+    }
+    /**
+     * Remove the current membership.
+     *
+     * @return bool True on success, false on failure.
+     */
     public function remove() {
         global $wpdb, $bp;
 …
+    }
+    /** Static Methods ********************************************************/
+    /**
+     * Refresh the total_group_count for a user
+     *
+     * @since BuddyPress (1.8)
+     * @param int $user_id
+     * @return bool True on success
+    /** Static Methods ****************************************************/
+    /**
+     * Refresh the total_group_count for a user.
+     *
+     * @since BuddyPress (1.8.0)
+     *
+     * @param int $user_id ID of the user.
+     * @return bool True on success, false on failure.
      */
     public static function refresh_total_group_count_for_user( $user_id ) {
 …
     /**
+     * Refresh the total_member_count for a group
+     *
+     * @since BuddyPress (1.8)
+     * @param int $group_id
+     * @return bool True on success
+     * Refresh the total_member_count for a group.
+     *
+     * @since BuddyPress (1.8.0)
+     *
+     * @param int $group_id ID of the group.
+     * @return bool True on success, false on failure.
      */
     public static function refresh_total_member_count_for_group( $group_id ) {
 …
+    }
+    /**
+     * Delete a membership, based on user + group IDs.
+     *
+     * @param int $user_id ID of the user.
+     * @param int $group_id ID of the group.
+     * @return True on success, false on failure.
+     */
     public static function delete( $user_id, $group_id ) {
         global $wpdb, $bp;
 …
+    }
+    /**
+     * Get the IDs of the groups of which a specified user is a member.
+     *
+     * @param int $user_id ID of the user.
+     * @param int $limit Optional. Max number of results to return.
+     *        Default: false (no limit).
+     * @param int $page Optional. Page offset of results to return.
+     *        Default: false (no limit).
+     * @return array {
+     *     @type array $groups Array of groups returned by paginated query.
+     *     @type int $total Count of groups matching query.
+     * }
+     */
     public static function get_group_ids( $user_id, $limit = false, $page = false ) {
         global $wpdb, $bp;
 …
+    }
+    /**
+     * Get the IDs of the groups of which a specified user is a member, sorted by the date joined.
+     *
+     * @param int $user_id ID of the user.
+     * @param int $limit Optional. Max number of results to return.
+     *        Default: false (no limit).
+     * @param int $page Optional. Page offset of results to return.
+     *        Default: false (no limit).
+     * @param string $filter Optional. Limit results to groups whose name or
+     *        description field matches search terms.
+     * @return array {
+     *     @type array $groups Array of groups returned by paginated query.
+     *     @type int $total Count of groups matching query.
+     * }
+     */
     public static function get_recently_joined( $user_id, $limit = false, $page = false, $filter = false ) {
         global $wpdb, $bp;
 …
+    }
+    /**
+     * Get the IDs of the groups of which a specified user is an admin.
+     *
+     * @param int $user_id ID of the user.
+     * @param int $limit Optional. Max number of results to return.
+     *        Default: false (no limit).
+     * @param int $page Optional. Page offset of results to return.
+     *        Default: false (no limit).
+     * @param string $filter Optional. Limit results to groups whose name or
+     *        description field matches search terms.
+     * @return array {
+     *     @type array $groups Array of groups returned by paginated query.
+     *     @type int $total Count of groups matching query.
+     * }
+     */
     public static function get_is_admin_of( $user_id, $limit = false, $page = false, $filter = false ) {
         global $wpdb, $bp;
 …
+    }
+    /**
+     * Get the IDs of the groups of which a specified user is a moderator.
+     *
+     * @param int $user_id ID of the user.
+     * @param int $limit Optional. Max number of results to return.
+     *        Default: false (no limit).
+     * @param int $page Optional. Page offset of results to return.
+     *        Default: false (no limit).
+     * @param string $filter Optional. Limit results to groups whose name or
+     *        description field matches search terms.
+     * @return array {
+     *     @type array $groups Array of groups returned by paginated query.
+     *     @type int $total Count of groups matching query.
+     * }
+     */
     public static function get_is_mod_of( $user_id, $limit = false, $page = false, $filter = false ) {
         global $wpdb, $bp;
 …
+    }
+    /**
+     * Get the count of groups of which the specified user is a member.
+     *
+     * @param int $user_id Optional. Default: ID of the displayed user.
+     * @return int Group count.
+     */
     public static function total_group_count( $user_id = 0 ) {
         global $bp, $wpdb;
 …
+    }
+    /**
+     * Get a user's outstanding group invitations.
+     *
+     * @param int $user_id ID of the invitee.
+     * @param int $limit Optional. Max number of results to return.
+     *        Default: false (no limit).
+     * @param int $page Optional. Page offset of results to return.
+     *        Default: false (no limit).
+     * @param string|array $exclude Optional. Array or comma-separated list
+     *        of group IDs to exclude from results.
+     * @return array {
+     *     @type array $groups Array of groups returned by paginated query.
+     *     @type int $total Count of groups matching query.
+     * }
+     */
     public static function get_invites( $user_id, $limit = false, $page = false, $exclude = false ) {
         global $wpdb, $bp;
 …
+    }
+    /**
+     * Check whether a user has an outstanding invitation to a given group.
+     *
+     * @param int $user_id ID of the potential invitee.
+     * @param int $group_id ID of the group.
+     * @param string $type If 'sent', results are limited to those
+     *        invitations that have actually been sent (non-draft).
+     *        Default: 'sent'.
+     * @return int|null The ID of the invitation if found, otherwise null.
+     */
     public static function check_has_invite( $user_id, $group_id, $type = 'sent' ) {
         global $wpdb, $bp;
 …
+    }
+    /**
+     * Delete an invitation, by specifying user ID and group ID.
+     *
+     * @param int $user_id ID of the user.
+     * @param int $group_id ID of the group.
+     * @return int Number of records deleted.
+     */
     public static function delete_invite( $user_id, $group_id ) {
         global $wpdb, $bp;
 …
+    }
+    /**
+     * Delete an unconfirmed membership request, by user ID and group ID.
+     *
+     * @param int $user_id ID of the user.
+     * @param int $group_id ID of the group.
+     * @return int Number of records deleted.
+     */
     public static function delete_request( $user_id, $group_id ) {
         global $wpdb, $bp;
 …
+    }
+    /**
+     * Check whether a user is an admin of a given group.
+     *
+     * @param int $user_id ID of the user.
+     * @param int $group_id ID of the group.
+     * @param int|null ID of the membership if the user is an admin,
+     *        otherwise null.
+     */
     public static function check_is_admin( $user_id, $group_id ) {
         global $wpdb, $bp;
 …
+    }
+    /**
+     * Check whether a user is a mod of a given group.
+     *
+     * @param int $user_id ID of the user.
+     * @param int $group_id ID of the group.
+     * @param int|null ID of the membership if the user is a mod,
+     *        otherwise null.
+     */
     public static function check_is_mod( $user_id, $group_id ) {
         global $wpdb, $bp;
 …
+    }
+    /**
+     * Check whether a user is a member of a given group.
+     *
+     * @param int $user_id ID of the user.
+     * @param int $group_id ID of the group.
+     * @param int|null ID of the membership if the user is a member,
+     *        otherwise null.
+     */
     public static function check_is_member( $user_id, $group_id ) {
         global $wpdb, $bp;
 …
+    }
+    /**
+     * Check whether a user is banned from a given group.
+     *
+     * @param int $user_id ID of the user.
+     * @param int $group_id ID of the group.
+     * @param int|null ID of the membership if the user is banned,
+     *        otherwise null.
+     */
     public static function check_is_banned( $user_id, $group_id ) {
         global $wpdb, $bp;
 …
      * Is the specified user the creator of the group?
+     *
-     * @global object $bp BuddyPress global settings
-     * @global wpdb $wpdb WordPress database object
-     * @param int $user_id
-     * @param int $group_id
      * @since BuddyPress (1.2.6)
+     *
+     * @param int $user_id ID of the user.
+     * @param int $group_id ID of the group.
+     * @return int|null ID of the group if the user is the creator,
+     *         otherwise false.
      */
     public static function check_is_creator( $user_id, $group_id ) {
 …
+    }
+    /**
+     * Check whether a user has an outstanding membership request for a given group.
+     *
+     * @param int $user_id ID of the user.
+     * @param int $group_id ID of the group.
+     * @return int|null ID of the membership if found, otherwise false.
+     */
     public static function check_for_membership_request( $user_id, $group_id ) {
         global $wpdb, $bp;
 …
+    }
+    /**
+     * Get a list of randomly selected IDs of groups that the member belongs to.
+     *
+     * @param int $user_id ID of the user.
+     * @param int $total_groups Max number of group IDs to return. Default: 5.
+     * @return array Group IDs.
+     */
     public static function get_random_groups( $user_id = 0, $total_groups = 5 ) {
         global $wpdb, $bp;
 …
+    }
+    /**
+     * Get the IDs of all a given group's members.
+     *
+     * @param int $group_id ID of the group.
+     * @return array IDs of all group members.
+     */
     public static function get_group_member_ids( $group_id ) {
         global $bp, $wpdb;
 …
+    }
+    /**
+     * Get a list of all a given group's admins.
+     *
+     * @param int $group_id ID of the group.
+     * @return array Info about group admins (user_id + date_modified).
+     */
     public static function get_group_administrator_ids( $group_id ) {
         global $bp, $wpdb;
 …
+    }
+    /**
+     * Get a list of all a given group's moderators.
+     *
+     * @param int $group_id ID of the group.
+     * @return array Info about group mods (user_id + date_modified).
+     */
     public static function get_group_moderator_ids( $group_id ) {
         global $bp, $wpdb;
 …
+    }
+    /**
+     * Get the IDs users with outstanding membership requests to the group.
+     *
+     * @param int $group_id ID of the group.
+     * @return array IDs of users with outstanding membership requests.
+     */
     public static function get_all_membership_request_user_ids( $group_id ) {
         global $bp, $wpdb;
 …
+    }
+    /**
+     * Get members of a group.
+     *
+     * @deprecated BuddyPress (1.8.0)
+     */
     public static function get_all_for_group( $group_id, $limit = false, $page = false, $exclude_admins_mods = true, $exclude_banned = true, $exclude = false ) {
         global $bp, $wpdb;
 …
+    }
+    /**
+     * Delete all memberships for a given group.
+     *
+     * @param int $group_id ID of the group.
+     * @return int Number of records deleted.
+     */
     public static function delete_all( $group_id ) {
         global $wpdb, $bp;
 …
     /**
+     * Delete all group membership information for the specified user
+     *
+     * @global object $bp BuddyPress global settings
+     * @global wpdb $wpdb WordPress database object
+     * @param int $user_id
+     * @since BuddyPress (1.0)
+     * @uses BP_Groups_Member
+     * Delete all group membership information for the specified user.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param int $user_id ID of the user.
      */
     public static function delete_all_for_user( $user_id ) {
 …
  * @package BuddyPress
  * @subpackage Groups
  * @since BuddyPress (1.1)
+ * @since BuddyPress (1.1.0)
  */
 class BP_Group_Extension {
+    /** Public ****************************************************************/
+    /**
+     * @var array Information about this extension's screens
+     * @since BuddyPress (1.8)
+    /** Public ************************************************************/
+    /**
+     * Information about this extension's screens.
+     *
+     * @since BuddyPress (1.8.0)
+     * @var array
      */
     public $screens = array();
     /**
+     * @var string The name of the extending class
+     * @since BuddyPress (1.8)
+     * The name of the extending class.
+     *
+     * @since BuddyPress (1.8.0)
+     * @var string
      */
     public $class_name = '';
     /**
+     * @var object A ReflectionClass object of the current extension
+     * @since BuddyPress (1.8)
+     * A ReflectionClass object of the current extension.
+     *
+     * @since BuddyPress (1.8.0)
+     * @var ReflectionClass
      */
     public $class_reflection = null;
     /**
+     * @var array Parsed configuration paramaters for the extension
+     * @since BuddyPress (1.8)
+     * Parsed configuration paramaters for the extension.
+     *
+     * @since BuddyPress (1.8.0)
+     * @var array
      */
     public $params = array();
     /**
+     * @var int The id of the current group
+     * @since BuddyPress (1.8)
+     * The ID of the current group.
+     *
+     * @since BuddyPress (1.8.0)
+     * @var int
      */
     public $group_id = 0;
     /**
+     * @var string The slug of the current extension
+     * The slug of the current extension.
+     *
+     * @var string
      */
     public $slug = '';
     /**
+     * @var string The translatable name of the current extension
+     * The translatable name of the current extension.
+     *
+     * @var string
      */
     public $name = '';
     /**
+     * @var string Whether the extension tab is visible. 'public'
+     *   or 'private'
+     * The visibility of the extension tab. 'public' or 'private'.
+     *
+     * @var string
      */
     public $visibility = 'public';
     /**
+     * @var int The numeric position of the main nav item
+     * The numeric position of the main nav item.
+     *
+     * @var int
      */
     public $nav_item_position = 81;
     /**
+     * @var bool Whether to show the nav item
+     * Whether to show the nav item.
+     *
+     * @var bool
      */
     public $enable_nav_item = true;
     /**
+     * @var string The text of the nav item. Defaults to self::name
+     * The text of the nav item. Defaults to self::name.
+     *
+     * @var string
      */
     public $nav_item_name = '';
     /**
+     * @var string The WP action that self::widget_display() is attached to.
+     *   Defaults to 'groups_custom_group_boxes'
+     * The WP action that self::widget_display() is attached to.
+     *
+     * Default: 'groups_custom_group_boxes'.
+     *
+     * @var string
      */
     public $display_hook = 'groups_custom_group_boxes';
     /**
+     * @var string The template file used to load the plugin content.
+     *   Defaults to 'groups/single/plugins'
+     * The template file used to load the plugin content.
+     *
+     * Default: 'groups/single/plugins'.
+     *
+     * @var string
      */
     public $template_file = 'groups/single/plugins';
+    /** Protected *************************************************************/
+    /**
+     * @var bool Has the extension been initialized?
+     * @since BuddyPress (1.8)
+    /** Protected *********************************************************/
+    /**
+     * Has the extension been initialized?
+     *
+     * @since BuddyPress (1.8.0)
+     * @var bool
      */
     protected $initialized = false;
     /**
+     * @var array Extension properties as set by legacy extensions
+     * @since BuddyPress (1.8)
+     * Extension properties as set by legacy extensions.
+     *
+     * @since BuddyPress (1.8.0)
+     * @var array
      */
     protected $legacy_properties = array();
     /**
+     * @var array Extension properties as set by legacy extensions, but
+     *   converted to match the new format for params
+     * @since BuddyPress (1.8)
+     * Converted legacy parameters.
+     *
+     * These are the extension properties as set by legacy extensions, but
+     * then converted to match the new format for params.
+     *
+     * @since BuddyPress (1.8.0)
+     * @var array
      */
     protected $legacy_properties_converted = array();
     /**
+     * @var array Miscellaneous data as set by the __set() magic method
+     * @since BuddyPress (1.8)
+     * Miscellaneous data as set by the __set() magic method.
+     *
+     * @since BuddyPress (1.8.0)
+     * @var array
      */
     protected $data = array();
     /** Screen Overrides ******************************************************/
     /**
+    /** Screen Overrides **************************************************/
+    /*
      * Screen override methods are how your extension will display content
      * and handle form submits. Your extension should only override those
 …
+     *
      * @since BuddyPress (1.8)
+     * @param array $args See inline definition below for arguments
+     * @param array $args {
+     *     Array of initialization arguments.
+     *     @type string $slug Unique, URL-safe identifier for your
+     *           extension.
+     *     @type string $name Translatable name for your extension. Used to
+     *           populate navigation items.
+     *     @type string $visibility Optional. Set to 'public' for your
+     *           extension (the main tab as well as the widget) to be
+     *           available to anyone who can access the group; set to
+     *           'private' otherwise. Default: 'public'.
+     *     @type int $nav_item_position Optional. Location of the nav item
+     *           in the tab list. Default: 81.
+     *     @type bool $enable_nav_item Optional. Whether the extension's
+     *           tab should be accessible to anyone who can view the group.
+     *           Default: true.
+     *     @type string $nav_item_name Optional. The translatable text you
+     *           want to appear in the nav tab. Default: the value of $name.
+     *     @type string $display_hook Optional. The WordPress action that
+     *           the widget_display() method is hooked to.
+     *           Default: 'groups_custom_group_boxes'.
+     *     @type string $template_file Optional. Theme-relative path to the
+     *           template file BP should use to load the content of your
+     *           main extension tab. Default: 'groups/single/plugins.php'.
+     *     @type array $screens A multi-dimensional array of configuration
+     *           information for the extension screens. See docblock of
+     *           {@link BP_Group_Extension} for more details.
+     * }
      */
     public function init( $args = array() ) {
 …
     /**
      * The main setup routine for the extension
+     * The main setup routine for the extension.
+     *
      * This method contains the primary logic for setting up an extension's
 …
      * bp_register_group_extension().
+     *
      * @since BuddyPress (1.1)
+     * @since BuddyPress (1.1.0)
      */
     public function _register() {
 …
     /**
      * Set up some basic info about the Extension
+     * Set up some basic info about the Extension.
+     *
      * Here we collect the name of the extending class, as well as a
 …
      * whether your extension overrides certain callback methods.
+     *
      * @since BuddyPress (1.8)
+     * @since BuddyPress (1.8.0)
      */
     protected function setup_class_info() {
 …
     /**
      * Get the current group id
+     * Get the current group ID.
+     *
      * Check for:
 …
      *   - group admin
+     *
      * @since BuddyPress (1.8)
+     * @since BuddyPress (1.8.0)
      */
     public static function get_group_id() {
 …
     /**
      * Gather configuration data about your screens
+     *
      * @since BuddyPress (1.8)
+     * Gather configuration data about your screens.
+     *
+     * @since BuddyPress (1.8.0)
      */
     protected function get_default_screens() {
 …
     /**
      * Set up screens array based on params
+     *
      * @since BuddyPress (1.8)
+     * Set up screens array based on params.
+     *
+     * @since BuddyPress (1.8.0)
      */
     protected function setup_screens() {
 …
+    }
     /** Display ***************************************************************/
     /**
      * Hook this extension's group tab into BuddyPress, if necessary
+     *
      * @since BuddyPress (1.8)
+    /** Display ***********************************************************/
+    /**
+     * Hook this extension's group tab into BuddyPress, if necessary.
+     *
+     * @since BuddyPress (1.8.0)
      */
     protected function setup_display_hooks() {
 …
     /**
      * Hooks the main display method, and loads the template file
+     * Hook the main display method, and loads the template file
      */
     public function _display_hook() {
 …
+    }
     /** Create ****************************************************************/
     /**
      * Hook this extension's Create step into BuddyPress, if necessary
+     *
      * @since BuddyPress (1.8)
+    /** Create ************************************************************/
+    /**
+     * Hook this extension's Create step into BuddyPress, if necessary.
+     *
+     * @since BuddyPress (1.8.0)
      */
     protected function setup_create_hooks() {
 …
     /**
      * Call the create_screen() method, if we're on the right page
+     *
      * @since BuddyPress (1.8)
+     * Call the create_screen() method, if we're on the right page.
+     *
+     * @since BuddyPress (1.8.0)
      */
     public function maybe_create_screen() {
 …
     /**
      * Call the create_screen_save() method, if we're on the right page
+     *
      * @since BuddyPress (1.8)
+     * Call the create_screen_save() method, if we're on the right page.
+     *
+     * @since BuddyPress (1.8.0)
      */
     public function maybe_create_screen_save() {
 …
+    }
     /** Edit ******************************************************************/
     /**
      * Hook this extension's Edit panel into BuddyPress, if necessary
+     *
      * @since BuddyPress (1.8)
+    /** Edit **************************************************************/
+    /**
+     * Hook this extension's Edit panel into BuddyPress, if necessary.
+     *
+     * @since BuddyPress (1.8.0)
      */
     protected function setup_edit_hooks() {
 …
     /**
      * Call the edit_screen() method
+     * Call the edit_screen() method.
+     *
      * Previous versions of BP_Group_Extension required plugins to provide
 …
      * do not auto-add our own button.
+     *
      * @since BuddyPress (1.8)
+     * @since BuddyPress (1.8.0)
      */
     public function call_edit_screen() {
 …
     /**
      * Check the nonce, and call the edit_screen_save() method
+     *
      * @since BuddyPress (1.8)
+     * Check the nonce, and call the edit_screen_save() method.
+     *
+     * @since BuddyPress (1.8.0)
      */
     public function call_edit_screen_save() {
 …
     /**
      * Load the template that houses the Edit screen
+     * Load the template that houses the Edit screen.
+     *
      * Separated out into a callback so that it can run after all other
 …
      * Hooked to 'bp_screens'.
+     *
+     * @since BuddyPress (1.8.0)
+     * @access public So that do_action() has access. Do not call directly.
+     *
      * @see BP_Group_Extension::setup_edit_hooks()
-     * @access public So that do_action() has access. Do not call directly.
-     * @since BuddyPress (1.8)
      */
     public function call_edit_screen_template_loader() {
 …
     /**
      * Add a submit button to the edit form, if it needs one
+     * Add a submit button to the edit form, if it needs one.
+     *
      * There's an inconsistency in the way that the group Edit and Create
 …
      * if one is not found.
+     *
+     * @since BuddyPress (1.8)
+     * @param string $screen The screen markup, captured in the output buffer
+     * @param string $screen The same markup, with a submit button added
+     * @since BuddyPress (1.8.0)
+     *
+     * @param string $screen The screen markup, captured in the output
+     *        buffer.
+     * @param string $screen The same markup, with a submit button added.
      */
     protected function maybe_add_submit_button( $screen = '' ) {
 …
      * Does the given markup have a submit button?
+     *
+     * @since BuddyPress (1.8)
+     * @param string $screen The markup to check
+     * @return bool
+     * @since BuddyPress (1.8.0)
+     *
+     * @param string $screen The markup to check.
+     * @return bool True if a Submit button is found, otherwise false.
      */
     public static function has_submit_button( $screen = '' ) {
 …
+    }
     /** Admin *****************************************************************/
     /**
      * Hook this extension's Admin metabox into BuddyPress, if necessary
+     *
      * @since BuddyPress (1.8)
+    /** Admin *************************************************************/
+    /**
+     * Hook this extension's Admin metabox into BuddyPress, if necessary.
+     *
+     * @since BuddyPress (1.8.0)
      */
     protected function setup_admin_hooks() {
 …
     /**
      * Call the admin_screen() method, and add a nonce field
+     *
      * @since BuddyPress (1.8)
+     * Call the admin_screen() method, and add a nonce field.
+     *
+     * @since BuddyPress (1.8.0)
      */
     public function call_admin_screen() {
 …
      * Check the nonce, and call the admin_screen_save() method
+     *
      * @since BuddyPress (1.8)
+     * @since BuddyPress (1.8.0)
      */
     public function call_admin_screen_save() {
 …
     /**
      * Create the Dashboard meta box for this extension
+     *
      * @since BuddyPress (1.7)
+     * Create the Dashboard meta box for this extension.
+     *
+     * @since BuddyPress (1.7.0)
      */
     public function _meta_box_display_callback() {
 …
     /** Utilities *************************************************************/
     /**
      * Generate the nonce fields for a settings form
+    /** Utilities *********************************************************/
+    /**
+     * Generate the nonce fields for a settings form.
+     *
      * The nonce field name (the second param passed to wp_nonce_field)
 …
      * must avoid name clashes.
+     *
+     * @since BuddyPress (1.8)
+     * @since BuddyPress (1.8.0)
+     *
      * @uses wp_nonce_field()
+     * @param string $context 'create', 'edit', 'admin'
+     *
+     * @param string $context Screen context. 'create', 'edit', or 'admin'.
      */
     public function nonce_field( $context = '' ) {
 …
     /**
+     * Check the nonce on a submitted settings form
+     *
+     * @since BuddyPress (1.8)
+     * Check the nonce on a submitted settings form.
+     *
+     * @since BuddyPress (1.8.0)
+     *
      * @uses check_admin_referer()
+     * @param string $context 'create', 'edit', 'admin'
+     *
+     * @param string $context Screen context. 'create', 'edit', or 'admin'.
      */
     public function check_nonce( $context = '' ) {
 …
      * must also exist and be callable.
+     *
+     * @since BuddyPress (1.8)
+     * @param string $context 'create', 'edit', 'admin'
+     * @return bool
+     * @since BuddyPress (1.8.0)
+     *
+     * @param string $context Screen context. 'create', 'edit', or 'admin'.
+     *
+     * @return bool True if the screen is enabled, otherwise false.
      */
     public function is_screen_enabled( $context = '' ) {
 …
     /**
      * Get the appropriate screen callback for the specified context/type
+     * Get the appropriate screen callback for the specified context/type.
+     *
      * BP Group Extensions have three special "screen contexts": create,
 …
      * determine whether your extension has provided a given callback.
+     *
+     * @since BuddyPress (1.8)
+     * @param string $context 'create', 'edit', 'admin'
+     * @param string $type 'screen', 'screen_save'
+     * @return mixed A callable function handle
+     * @since BuddyPress (1.8.0)
+     *
+     * @param string $context Screen context. 'create', 'edit', or 'admin'.
+     * @param string $type Screen type. 'screen' or 'screen_save'. Default:
+     *        'screen'.
+     * @return callable A callable function handle.
      */
     public function get_screen_callback( $context = '', $type = 'screen' ) {
 …
     /**
      * Recursive argument parsing
+     * Recursive argument parsing.
+     *
      * This acts like a multi-dimensional version of wp_parse_args() (minus
 …
      * http://core.trac.wordpress.org/ticket/19888
+     *
+     * @since BuddyPress (1.8)
+     * @arg array $a
+     * @arg array $b
+     * @return array
+     * @since BuddyPress (1.8.0)
+     *
+     * @param array $a First set of arguments.
+     * @param array $b Second set of arguments.
+     * @return array Parsed arguments.
      */
     public static function parse_args_r( &$a, $b ) {
 …
     /** Legacy Support ********************************************************/
     /**
+    /*
      * In BuddyPress 1.8, the recommended technique for configuring
      * extensions changed from directly setting various object properties
 …
     /**
      * Provide access to otherwise unavailable object properties
+     * Provide access to otherwise unavailable object properties.
+     *
      * This magic method is here for backward compatibility with plugins
 …
      * self::setup_legacy_properties().
+     *
+     * @since BuddyPress (1.8)
+     * @param string $key
+     * @return mixed
+     * @since BuddyPress (1.8.0)
+     *
+     * @param string $key Property name.
+     * @return mixed The value if found, otherwise null.
      */
     public function __get( $key ) {
 …
     /**
      * Provide a fallback for isset( $this->foo ) when foo is unavailable
+     *
      * This magit method is here for backward compatibility with plugins
+     * Provide a fallback for isset( $this->foo ) when foo is unavailable.
+     *
+     * This magic method is here for backward compatibility with plugins
      * that have set their class config options directly in the class
      * constructor. The parse_legacy_properties() method of the current
 …
      * $this->data array.
+     *
+     * @since BuddyPress (1.8)
+     * @param string $key
+     * @return bool
+     * @since BuddyPress (1.8.0)
+     *
+     * @param string $key Property name.
+     * @return bool True if the value is set, otherwise false.
      */
     public function __isset( $key ) {
 …
     /**
      * Allow plugins to set otherwise unavailable object properties
+     * Allow plugins to set otherwise unavailable object properties.
+     *
      * This magic method is here for backward compatibility with plugins
 …
      * $this->enable_create_step.
+     *
+     * @since BuddyPress (1.8)
+     * @param string $key
+     * @param mixed $value
+     * @since BuddyPress (1.8.0)
+     *
+     * @param string $key Property name.
+     * @param mixed $value Property value.
      */
     public function __set( $key, $value ) {
 …
     /**
      * Returns a list of legacy properties
+     * Return a list of legacy properties.
+     *
      * The legacy implementation of BP_Group_Extension used all of these
      * object properties for configuration. Some have been moved.
+     *
+     * @since BuddyPress (1.8)
+     * @return array
+     * @since BuddyPress (1.8.0)
+     *
+     * @return array List of legacy property keys.
      */
     protected function get_legacy_property_list() {
 …
     /**
      * Parse legacy properties
+     * Parse legacy properties.
+     *
      * The old standard for BP_Group_Extension was for plugins to register
 …
      * parse them into the new init() array.
+     *
      * @since BuddyPress (1.8)
+     * @since BuddyPress (1.8.0)
      */
     protected function parse_legacy_properties() {
 …
     /**
      * Set up legacy properties
+     * Set up legacy properties.
+     *
      * This method is responsible for ensuring that all legacy config
 …
      * their old locations.
+     *
      * @see self::__get()
+     *
      * @since BuddyPress (1.8)
+     * @since BuddyPress (1.8.0)
+     *
+     * @see BP_Group_Extension::__get()
      */
     protected function setup_legacy_properties() {
 …
+}
+/**
+ * Register a new Group Extension.
+ *
+ * @param string Name of the Extension class.
+ * @return bool|null Returns false on failure, otherwise null.
+ */
 function bp_register_group_extension( $group_extension_class = '' ) {

Note: See TracChangeset for help on using the changeset viewer.

Trac UI Preferences

BuddyPress.org

Context Navigation

Changeset 7648 for trunk/bp-groups/bp-groups-classes.php

Legend:

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

Download in other formats: