diff --git src/bp-activity/bp-activity-classes.php src/bp-activity/bp-activity-classes.php index 773c293..99f58b1 100644 --- src/bp-activity/bp-activity-classes.php +++ src/bp-activity/bp-activity-classes.php @@ -26,98 +26,98 @@ class BP_Activity_Activity { * * @var int */ - var $id; + public $id; /** * ID of the associated item. * * @var int */ - var $item_id; + public $item_id; /** * ID of the associated secondary item. * * @var int */ - var $secondary_item_id; + public $secondary_item_id; /** * ID of user associated with the activity item. * * @var int */ - var $user_id; + public $user_id; /** * The primary URL for the activity in RSS feeds. * * @var string */ - var $primary_link; + public $primary_link; /** * BuddyPress component the activity item relates to. * * @var string */ - var $component; + public $component; /** * Activity type, eg 'new_blog_post'. * * @var string */ - var $type; + public $type; /** * Description of the activity, eg 'Alex updated his profile.' * * @var string */ - var $action; + public $action; /** * The content of the activity item. * * @var string */ - var $content; + public $content; /** * The date the activity item was recorded, in 'Y-m-d h:i:s' format. * * @var string */ - var $date_recorded; + public $date_recorded; /** * Whether the item should be hidden in sitewide streams. * * @var int */ - var $hide_sitewide = false; + public $hide_sitewide = false; /** * Node boundary start for activity or activity comment. * * @var int */ - var $mptt_left; + public $mptt_left; /** * Node boundary end for activity or activity comment. * * @var int */ - var $mptt_right; + public $mptt_right; /** * Whether this item is marked as spam. * * @var int */ - var $is_spam; + public $is_spam; /** * Constructor method. diff --git src/bp-activity/bp-activity-template.php src/bp-activity/bp-activity-template.php index e4a8cc7..30fc53b 100644 --- src/bp-activity/bp-activity-template.php +++ src/bp-activity/bp-activity-template.php @@ -114,13 +114,59 @@ function bp_activity_directory_permalink() { * @since BuddyPress (1.0.0) */ class BP_Activity_Template { - var $current_activity = -1; - var $activity_count; - var $total_activity_count; - var $activities; - var $activity; - - var $in_the_loop; + /** + * The loop iterator. + * + * @since BuddyPress (1.5.0) + * @access public + * @var int + */ + public $current_activity = -1; + + /** + * The activity count. + * + * @since BuddyPress (1.5.0) + * @access public + * @var int + */ + public $activity_count; + + /** + * The total activity count. + * + * @since BuddyPress (1.5.0) + * @access public + * @var int + */ + public $total_activity_count; + + /** + * Array of activities located by the query. + * + * @since BuddyPress (1.5.0) + * @access public + * @var array + */ + public $activities; + + /** + * The activity object currently being iterated on. + * + * @since BuddyPress (1.5.0) + * @access public + * @var object + */ + public $activity; + + /** + * A flag for whether the loop is currently being iterated. + * + * @since BuddyPress (1.5.0) + * @access public + * @var bool + */ + public $in_the_loop; /** * URL parameter key for activity pagination. Default: 'acpage'. @@ -128,13 +174,43 @@ class BP_Activity_Template { * @since BuddyPress (2.1.0) * @var string */ - var $pag_arg; - - var $pag_page; - var $pag_num; - var $pag_links; - - var $full_name; + public $pag_arg; + + /** + * The page number being requested. + * + * @since BuddyPress (1.5.0) + * @access public + * @var int + */ + public $pag_page; + + /** + * The number of items being requested per page. + * + * @since BuddyPress (1.5.0) + * @access public + * @var int + */ + public $pag_num; + + /** + * An HTML string containing pagination links. + * + * @since BuddyPress (1.5.0) + * @access public + * @var string + */ + public $pag_links; + + /** + * The displayed user's full name. + * + * @since BuddyPress (1.5.0) + * @access public + * @var string + */ + public $full_name; /** * Constructor method. diff --git src/bp-forums/bp-forums-template.php src/bp-forums/bp-forums-template.php index f279060..fa1ee7c 100644 --- src/bp-forums/bp-forums-template.php +++ src/bp-forums/bp-forums-template.php @@ -115,7 +115,7 @@ class BP_Forums_Template_Forum { * @access public * @var int */ - var $current_topic = -1; + public $current_topic = -1; /** * The number of topics returned by the paged query. @@ -123,7 +123,7 @@ class BP_Forums_Template_Forum { * @access public * @var int */ - var $topic_count; + public $topic_count; /** * Array of topics located by the query. @@ -131,7 +131,7 @@ class BP_Forums_Template_Forum { * @access public * @var array */ - var $topics; + public $topics; /** * The topic object currently being iterated on. @@ -139,7 +139,7 @@ class BP_Forums_Template_Forum { * @access public * @var object */ - var $topic; + public $topic; /** * The ID of the forum whose topics are being queried. @@ -147,7 +147,7 @@ class BP_Forums_Template_Forum { * @access public * @var int */ - var $forum_id; + public $forum_id; /** * A flag for whether the loop is currently being iterated. @@ -155,7 +155,7 @@ class BP_Forums_Template_Forum { * @access public * @var bool */ - var $in_the_loop; + public $in_the_loop; /** * The page number being requested. @@ -163,7 +163,7 @@ class BP_Forums_Template_Forum { * @access public * @var int */ - var $pag_page; + public $pag_page; /** * The number of items being requested per page. @@ -171,7 +171,7 @@ class BP_Forums_Template_Forum { * @access public * @var int */ - var $pag_num; + public $pag_num; /** * An HTML string containing pagination links. @@ -179,7 +179,7 @@ class BP_Forums_Template_Forum { * @access public * @var string */ - var $pag_links; + public $pag_links; /** * The total number of topics matching the query parameters. @@ -187,7 +187,7 @@ class BP_Forums_Template_Forum { * @access public * @var int */ - var $total_topic_count; + public $total_topic_count; /** * Whether requesting a single topic. Not currently used. @@ -195,7 +195,7 @@ class BP_Forums_Template_Forum { * @access public * @var bool */ - var $single_topic = false; + public $single_topic = false; /** * Term to sort by. Not currently used. @@ -203,7 +203,7 @@ class BP_Forums_Template_Forum { * @access public * @var string */ - var $sort_by; + public $sort_by; /** * Sort order. Not currently used. @@ -211,7 +211,7 @@ class BP_Forums_Template_Forum { * @access public * @var string */ - var $order; + public $order; /** * Constructor method. @@ -1926,7 +1926,7 @@ class BP_Forums_Template_Topic { * @access public * @var int */ - var $current_post = -1; + public $current_post = -1; /** * The number of posts returned by the paged query. @@ -1934,7 +1934,7 @@ class BP_Forums_Template_Topic { * @access public * @var int */ - var $post_count; + public $post_count; /** * Array of posts located by the query. @@ -1942,7 +1942,7 @@ class BP_Forums_Template_Topic { * @access public * @var array */ - var $posts; + public $posts; /** * The post object currently being iterated on. @@ -1950,7 +1950,7 @@ class BP_Forums_Template_Topic { * @access public * @var object */ - var $post; + public $post; /** * The ID of the forum whose topic is being queried. @@ -1958,7 +1958,7 @@ class BP_Forums_Template_Topic { * @access public * @var int */ - var $forum_id; + public $forum_id; /** * The ID of the topic whose posts are being queried. @@ -1966,7 +1966,7 @@ class BP_Forums_Template_Topic { * @access public * @var int */ - var $topic_id; + public $topic_id; /** * The topic object to which the posts belong. @@ -1974,7 +1974,7 @@ class BP_Forums_Template_Topic { * @access public * @var object */ - var $topic; + public $topic; /** * A flag for whether the loop is currently being iterated. @@ -1982,7 +1982,7 @@ class BP_Forums_Template_Topic { * @access public * @var bool */ - var $in_the_loop; + public $in_the_loop; /** * Contains a 'total_pages' property holding total number of pages in @@ -1999,7 +1999,7 @@ class BP_Forums_Template_Topic { * @access public * @var public */ - var $pag_page; + public $pag_page; /** * The number of items being requested per page. @@ -2007,7 +2007,7 @@ class BP_Forums_Template_Topic { * @access public * @var public */ - var $pag_num; + public $pag_num; /** * An HTML string containing pagination links. @@ -2015,7 +2015,7 @@ class BP_Forums_Template_Topic { * @access public * @var string */ - var $pag_links; + public $pag_links; /** * The total number of posts matching the query parameters. @@ -2023,7 +2023,7 @@ class BP_Forums_Template_Topic { * @access public * @var int */ - var $total_post_count; + public $total_post_count; /** * Whether requesting a single topic. Not currently used. @@ -2031,7 +2031,7 @@ class BP_Forums_Template_Topic { * @access public * @var bool */ - var $single_post = false; + public $single_post = false; /** * Term to sort by. @@ -2039,7 +2039,7 @@ class BP_Forums_Template_Topic { * @access public * @var string */ - var $sort_by; + public $sort_by; /** * Sort order. @@ -2047,7 +2047,7 @@ class BP_Forums_Template_Topic { * @access public * @var string */ - var $order; + public $order; /** * Constructor method. diff --git src/bp-groups/bp-groups-template.php src/bp-groups/bp-groups-template.php index 25e81ac..b2e75fc 100644 --- src/bp-groups/bp-groups-template.php +++ src/bp-groups/bp-groups-template.php @@ -77,7 +77,7 @@ class BP_Groups_Template { * @access public * @var int */ - var $current_group = -1; + public $current_group = -1; /** * The number of groups returned by the paged query. @@ -85,7 +85,7 @@ class BP_Groups_Template { * @access public * @var int */ - var $group_count; + public $group_count; /** * Array of groups located by the query. @@ -93,7 +93,7 @@ class BP_Groups_Template { * @access public * @var array */ - var $groups; + public $groups; /** * The group object currently being iterated on. @@ -101,7 +101,7 @@ class BP_Groups_Template { * @access public * @var object */ - var $group; + public $group; /** * A flag for whether the loop is currently being iterated. @@ -109,7 +109,7 @@ class BP_Groups_Template { * @access public * @var bool */ - var $in_the_loop; + public $in_the_loop; /** * The page number being requested. @@ -117,7 +117,7 @@ class BP_Groups_Template { * @access public * @var public */ - var $pag_page; + public $pag_page; /** * The number of items being requested per page. @@ -125,7 +125,7 @@ class BP_Groups_Template { * @access public * @var public */ - var $pag_num; + public $pag_num; /** * An HTML string containing pagination links. @@ -133,7 +133,7 @@ class BP_Groups_Template { * @access public * @var string */ - var $pag_links; + public $pag_links; /** * The total number of groups matching the query parameters. @@ -141,7 +141,7 @@ class BP_Groups_Template { * @access public * @var int */ - var $total_group_count; + public $total_group_count; /** * Whether the template loop is for a single group page. @@ -149,7 +149,7 @@ class BP_Groups_Template { * @access public * @var bool */ - var $single_group = false; + public $single_group = false; /** * Field to sort by. @@ -157,7 +157,7 @@ class BP_Groups_Template { * @access public * @var string */ - var $sort_by; + public $sort_by; /** * Sort order. @@ -165,7 +165,7 @@ class BP_Groups_Template { * @access public * @var string */ - var $order; + public $order; /** * Constructor method. @@ -3002,17 +3002,86 @@ function bp_total_group_count_for_user( $user_id = 0 ) { **/ class BP_Groups_Group_Members_Template { - var $current_member = -1; - var $member_count; - var $members; - var $member; - - var $in_the_loop; - - var $pag_page; - var $pag_num; - var $pag_links; - var $total_group_count; + /** + * The loop iterator. + * + * @since BuddyPress (1.5.0) + * @access public + * @var int + */ + public $current_member = -1; + + /** + * The member count. + * + * @since BuddyPress (1.5.0) + * @access public + * @var int + */ + public $member_count; + + /** + * Array of members located by the query. + * + * @since BuddyPress (1.5.0) + * @access public + * @var array + */ + public $members; + + /** + * The member object currently being iterated on. + * + * @since BuddyPress (1.5.0) + * @access public + * @var object + */ + public $member; + + /** + * A flag for whether the loop is currently being iterated. + * + * @since BuddyPress (1.5.0) + * @access public + * @var bool + */ + public $in_the_loop; + + /** + * The page number being requested. + * + * @since BuddyPress (1.5.0) + * @access public + * @var int + */ + public $pag_page; + + /** + * The number of items being requested per page. + * + * @since BuddyPress (1.5.0) + * @access public + * @var int + */ + public $pag_num; + + /** + * An HTML string containing pagination links. + * + * @since BuddyPress (1.5.0) + * @access public + * @var string + */ + public $pag_links; + + /** + * The total group count. + * + * @since BuddyPress (1.5.0) + * @access public + * @var int + */ + public $total_group_count; /** * Constructor. diff --git src/bp-members/bp-members-template.php src/bp-members/bp-members-template.php index 85929e5..158d48d 100644 --- src/bp-members/bp-members-template.php +++ src/bp-members/bp-members-template.php @@ -188,7 +188,7 @@ class BP_Core_Members_Template { * @access public * @var int */ - var $current_member = -1; + public $current_member = -1; /** * The number of members returned by the paged query. @@ -196,7 +196,7 @@ class BP_Core_Members_Template { * @access public * @var int */ - var $member_count; + public $member_count; /** * Array of members located by the query. @@ -204,7 +204,7 @@ class BP_Core_Members_Template { * @access public * @var array */ - var $members; + public $members; /** * The member object currently being iterated on. @@ -212,7 +212,7 @@ class BP_Core_Members_Template { * @access public * @var object */ - var $member; + public $member; /** * A flag for whether the loop is currently being iterated. @@ -220,7 +220,7 @@ class BP_Core_Members_Template { * @access public * @var bool */ - var $in_the_loop; + public $in_the_loop; /** * The unique string used for pagination queries @@ -228,7 +228,7 @@ class BP_Core_Members_Template { * @access public * @var public */ - var $pag_arg; + public $pag_arg; /** * The page number being requested. @@ -236,7 +236,7 @@ class BP_Core_Members_Template { * @access public * @var public */ - var $pag_page; + public $pag_page; /** * The number of items being requested per page. @@ -244,7 +244,7 @@ class BP_Core_Members_Template { * @access public * @var public */ - var $pag_num; + public $pag_num; /** * An HTML string containing pagination links. @@ -252,7 +252,7 @@ class BP_Core_Members_Template { * @access public * @var string */ - var $pag_links; + public $pag_links; /** * The total number of members matching the query parameters. @@ -260,7 +260,7 @@ class BP_Core_Members_Template { * @access public * @var int */ - var $total_member_count; + public $total_member_count; /** * Constructor method. diff --git src/bp-xprofile/bp-xprofile-loader.php src/bp-xprofile/bp-xprofile-loader.php index 727cd32..21c2d26 100644 --- src/bp-xprofile/bp-xprofile-loader.php +++ src/bp-xprofile/bp-xprofile-loader.php @@ -28,8 +28,9 @@ class BP_XProfile_Component extends BP_Component { * * @see bp_xprofile_get_visibility_levels() * @since BuddyPress (1.6.0) + * @var array */ - var $visibility_levels = array(); + public $visibility_levels = array(); /** * Start the xprofile component creation process diff --git src/bp-xprofile/bp-xprofile-template.php src/bp-xprofile/bp-xprofile-template.php index 8fd7c3f..11b22c9 100644 --- src/bp-xprofile/bp-xprofile-template.php +++ src/bp-xprofile/bp-xprofile-template.php @@ -11,18 +11,95 @@ defined( 'ABSPATH' ) || exit; class BP_XProfile_Data_Template { - var $current_group = -1; - var $group_count; - var $groups; - var $group; - - var $current_field = -1; - var $field_count; - var $field_has_data; - var $field; - - var $in_the_loop; - var $user_id; + /** + * The loop iterator. + * + * @since BuddyPress (1.5.0) + * @access public + * @var int + */ + public $current_group = -1; + + /** + * The number of groups returned by the paged query. + * + * @since BuddyPress (1.5.0) + * @access public + * @var int + */ + public $group_count; + + /** + * Array of groups located by the query. + * + * @since BuddyPress (1.5.0) + * @access public + * @var array + */ + public $groups; + + /** + * The group object currently being iterated on. + * + * @since BuddyPress (1.5.0) + * @access public + * @var object + */ + public $group; + + /** + * The current field. + * + * @since BuddyPress (1.5.0) + * @access public + * @var int + */ + public $current_field = -1; + + /** + * The field count. + * + * @since BuddyPress (1.5.0) + * @access public + * @var int + */ + public $field_count; + + /** + * Field has data. + * + * @since BuddyPress (1.5.0) + * @access public + * @var bool + */ + public $field_has_data; + + /** + * The field. + * + * @since BuddyPress (1.5.0) + * @access public + * @var int + */ + public $field; + + /** + * A flag for whether the loop is currently being iterated. + * + * @since BuddyPress (1.5.0) + * @access public + * @var bool + */ + public $in_the_loop; + + /** + * The user ID. + * + * @since BuddyPress (1.5.0) + * @access public + * @var int + */ + public $user_id; function __construct( $user_id, $profile_group_id, $hide_empty_groups = false, $fetch_fields = false, $fetch_field_data = false, $exclude_groups = false, $exclude_fields = false, $hide_empty_fields = false, $fetch_visibility_level = false, $update_meta_cache = true ) { $this->groups = bp_xprofile_get_groups( array(