Skip to:
Content

BuddyPress.org

Changeset 9515


Ignore:
Timestamp:
02/18/2015 09:09:29 PM (12 years ago)
Author:
djpaul
Message:

Replace use of PHP4-era var class properties keywords with public.

Also adds some phpDoc.

Fixes #6185, props henry.wright

Location:
trunk/src
Files:
6 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-activity/bp-activity-template.php

    r9471 r9515  
    115115 */
    116116class BP_Activity_Template {
    117         var $current_activity = -1;
    118         var $activity_count;
    119         var $total_activity_count;
    120         var $activities;
    121         var $activity;
    122 
    123         var $in_the_loop;
     117    /**
     118     * The loop iterator.
     119     *
     120     * @since BuddyPress (1.5.0)
     121     * @access public
     122     * @var int
     123     */
     124        public $current_activity = -1;
     125       
     126    /**
     127     * The activity count.
     128     *
     129     * @since BuddyPress (1.5.0)
     130     * @access public
     131     * @var int
     132     */
     133        public $activity_count;
     134       
     135    /**
     136     * The total activity count.
     137     *
     138     * @since BuddyPress (1.5.0)
     139     * @access public
     140     * @var int
     141     */
     142        public $total_activity_count;
     143       
     144    /**
     145     * Array of activities located by the query.
     146     *
     147     * @since BuddyPress (1.5.0)
     148     * @access public
     149     * @var array
     150     */
     151        public $activities;
     152       
     153    /**
     154     * The activity object currently being iterated on.
     155     *
     156     * @since BuddyPress (1.5.0)
     157     * @access public
     158     * @var object
     159     */
     160        public $activity;
     161
     162    /**
     163     * A flag for whether the loop is currently being iterated.
     164     *
     165     * @since BuddyPress (1.5.0)
     166     * @access public
     167     * @var bool
     168     */
     169        public $in_the_loop;
    124170
    125171        /**
    … …  
    129175         * @var string
    130176         */
    131         var $pag_arg;
    132 
    133         var $pag_page;
    134         var $pag_num;
    135         var $pag_links;
    136 
    137         var $full_name;
     177        public $pag_arg;
     178
     179    /**
     180     * The page number being requested.
     181     *
     182     * @since BuddyPress (1.5.0)
     183     * @access public
     184     * @var int
     185     */
     186        public $pag_page;
     187       
     188    /**
     189     * The number of items being requested per page.
     190     *
     191     * @since BuddyPress (1.5.0)
     192     * @access public
     193     * @var int
     194     */
     195        public $pag_num;
     196       
     197    /**
     198     * An HTML string containing pagination links.
     199     *
     200     * @since BuddyPress (1.5.0)
     201     * @access public
     202     * @var string
     203     */
     204        public $pag_links;
     205
     206    /**
     207     * The displayed user's full name.
     208     *
     209     * @since BuddyPress (1.5.0)
     210     * @access public
     211     * @var string
     212     */
     213        public $full_name;
    138214
    139215        /**

  • trunk/src/bp-forums/bp-forums-template.php

    r9471 r9515  
    112112         * @var int
    113113         */
    114         var $current_topic = -1;
     114        public $current_topic = -1;
    115115
    116116        /**
    … …  
    120120         * @var int
    121121         */
    122         var $topic_count;
     122        public $topic_count;
    123123
    124124        /**
    … …  
    128128         * @var array
    129129         */
    130         var $topics;
     130        public $topics;
    131131
    132132        /**
    … …  
    136136         * @var object
    137137         */
    138         var $topic;
     138        public $topic;
    139139
    140140        /**
    … …  
    144144         * @var int
    145145         */
    146         var $forum_id;
     146        public $forum_id;
    147147
    148148        /**
    … …  
    152152         * @var bool
    153153         */
    154         var $in_the_loop;
     154        public $in_the_loop;
    155155
    156156        /**
    … …  
    160160         * @var int
    161161         */
    162         var $pag_page;
     162        public $pag_page;
    163163
    164164        /**
    … …  
    168168         * @var int
    169169         */
    170         var $pag_num;
     170        public $pag_num;
    171171
    172172        /**
    … …  
    176176         * @var string
    177177         */
    178         var $pag_links;
     178        public $pag_links;
    179179
    180180        /**
    … …  
    184184         * @var int
    185185         */
    186         var $total_topic_count;
     186        public $total_topic_count;
    187187
    188188        /**
    … …  
    192192         * @var bool
    193193         */
    194         var $single_topic = false;
     194        public $single_topic = false;
    195195
    196196        /**
    … …  
    200200         * @var string
    201201         */
    202         var $sort_by;
     202        public $sort_by;
    203203
    204204        /**
    … …  
    208208         * @var string
    209209         */
    210         var $order;
     210        public $order;
    211211
    212212        /**
    … …  
    19171917         * @var int
    19181918         */
    1919         var $current_post = -1;
     1919        public $current_post = -1;
    19201920
    19211921        /**
    … …  
    19251925         * @var int
    19261926         */
    1927         var $post_count;
     1927        public $post_count;
    19281928
    19291929        /**
    … …  
    19331933         * @var array
    19341934         */
    1935         var $posts;
     1935        public $posts;
    19361936
    19371937        /**
    … …  
    19411941         * @var object
    19421942         */
    1943         var $post;
     1943        public $post;
    19441944
    19451945        /**
    … …  
    19491949         * @var int
    19501950         */
    1951         var $forum_id;
     1951        public $forum_id;
    19521952
    19531953        /**
    … …  
    19571957         * @var int
    19581958         */
    1959         var $topic_id;
     1959        public $topic_id;
    19601960
    19611961        /**
    … …  
    19651965         * @var object
    19661966         */
    1967         var $topic;
     1967        public $topic;
    19681968
    19691969        /**
    … …  
    19731973         * @var bool
    19741974         */
    1975         var $in_the_loop;
     1975        public $in_the_loop;
    19761976
    19771977        /**
    … …  
    19901990         * @var public
    19911991         */
    1992         var $pag_page;
     1992        public $pag_page;
    19931993
    19941994        /**
    … …  
    19981998         * @var public
    19991999         */
    2000         var $pag_num;
     2000        public $pag_num;
    20012001
    20022002        /**
    … …  
    20062006         * @var string
    20072007         */
    2008         var $pag_links;
     2008        public $pag_links;
    20092009
    20102010        /**
    … …  
    20142014         * @var int
    20152015         */
    2016         var $total_post_count;
     2016        public $total_post_count;
    20172017
    20182018        /**
    … …  
    20222022         * @var bool
    20232023         */
    2024         var $single_post = false;
     2024        public $single_post = false;
    20252025
    20262026        /**
    … …  
    20302030         * @var string
    20312031         */
    2032         var $sort_by;
     2032        public $sort_by;
    20332033
    20342034        /**
    … …  
    20382038         * @var string
    20392039         */
    2040         var $order;
     2040        public $order;
    20412041
    20422042        /**

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

    r9512 r9515  
    102102         * @var int
    103103         */
    104         var $current_group = -1;
     104        public $current_group = -1;
    105105
    106106        /**
    … …  
    110110         * @var int
    111111         */
    112         var $group_count;
     112        public $group_count;
    113113
    114114        /**
    … …  
    118118         * @var array
    119119         */
    120         var $groups;
     120        public $groups;
    121121
    122122        /**
    … …  
    126126         * @var object
    127127         */
    128         var $group;
     128        public $group;
    129129
    130130        /**
    … …  
    134134         * @var bool
    135135         */
    136         var $in_the_loop;
     136        public $in_the_loop;
    137137
    138138        /**
    … …  
    142142         * @var public
    143143         */
    144         var $pag_page;
     144        public $pag_page;
    145145
    146146        /**
    … …  
    150150         * @var public
    151151         */
    152         var $pag_num;
     152        public $pag_num;
    153153
    154154        /**
    … …  
    158158         * @var string
    159159         */
    160         var $pag_links;
     160        public $pag_links;
    161161
    162162        /**
    … …  
    166166         * @var int
    167167         */
    168         var $total_group_count;
     168        public $total_group_count;
    169169
    170170        /**
    … …  
    174174         * @var bool
    175175         */
    176         var $single_group = false;
     176        public $single_group = false;
    177177
    178178        /**
    … …  
    182182         * @var string
    183183         */
    184         var $sort_by;
     184        public $sort_by;
    185185
    186186        /**
    … …  
    190190         * @var string
    191191         */
    192         var $order;
     192        public $order;
    193193
    194194        /**

  • trunk/src/bp-members/bp-members-template.php

    r9471 r9515  
    189189         * @var int
    190190         */
    191         var $current_member = -1;
     191        public $current_member = -1;
    192192
    193193        /**
    … …  
    197197         * @var int
    198198         */
    199         var $member_count;
     199        public $member_count;
    200200
    201201        /**
    … …  
    205205         * @var array
    206206         */
    207         var $members;
     207        public $members;
    208208
    209209        /**
    … …  
    213213         * @var object
    214214         */
    215         var $member;
     215        public $member;
    216216
    217217        /**
    … …  
    221221         * @var bool
    222222         */
    223         var $in_the_loop;
     223        public $in_the_loop;
    224224
    225225        /**
    … …  
    229229         * @var public
    230230         */
    231         var $pag_arg;
     231        public $pag_arg;
    232232
    233233        /**
    … …  
    237237         * @var public
    238238         */
    239         var $pag_page;
     239        public $pag_page;
    240240
    241241        /**
    … …  
    245245         * @var public
    246246         */
    247         var $pag_num;
     247        public $pag_num;
    248248
    249249        /**
    … …  
    253253         * @var string
    254254         */
    255         var $pag_links;
     255        public $pag_links;
    256256
    257257        /**
    … …  
    261261         * @var int
    262262         */
    263         var $total_member_count;
     263        public $total_member_count;
    264264
    265265        /**

  • trunk/src/bp-xprofile/bp-xprofile-loader.php

    r9351 r9515  
    2929         * @see bp_xprofile_get_visibility_levels()
    3030         * @since BuddyPress (1.6.0)
    31          */
    32         var $visibility_levels = array();
     31         * @var array
     32         */
     33        public $visibility_levels = array();
    3334
    3435        /**

  • trunk/src/bp-xprofile/bp-xprofile-template.php

    r9471 r9515  
    1212
    1313class BP_XProfile_Data_Template {
    14         var $current_group = -1;
    15         var $group_count;
    16         var $groups;
    17         var $group;
    18 
    19         var $current_field = -1;
    20         var $field_count;
    21         var $field_has_data;
    22         var $field;
    23 
    24         var $in_the_loop;
    25         var $user_id;
     14    /**
     15     * The loop iterator.
     16     *
     17     * @since BuddyPress (1.5.0)
     18     * @access public
     19     * @var int
     20     */
     21        public $current_group = -1;
     22       
     23    /**
     24     * The number of groups returned by the paged query.
     25     *
     26     * @since BuddyPress (1.5.0)
     27     * @access public
     28     * @var int
     29     */
     30        public $group_count;
     31       
     32    /**
     33     * Array of groups located by the query.
     34     *
     35     * @since BuddyPress (1.5.0)
     36     * @access public
     37     * @var array
     38     */
     39        public $groups;
     40       
     41    /**
     42     * The group object currently being iterated on.
     43     *
     44     * @since BuddyPress (1.5.0)
     45     * @access public
     46     * @var object
     47     */
     48        public $group;
     49
     50    /**
     51     * The current field.
     52     *
     53     * @since BuddyPress (1.5.0)
     54     * @access public
     55     * @var int
     56     */
     57        public $current_field = -1;
     58       
     59    /**
     60     * The field count.
     61     *
     62     * @since BuddyPress (1.5.0)
     63     * @access public
     64     * @var int
     65     */
     66        public $field_count;
     67       
     68    /**
     69     * Field has data.
     70     *
     71     * @since BuddyPress (1.5.0)
     72     * @access public
     73     * @var bool
     74     */
     75        public $field_has_data;
     76       
     77    /**
     78     * The field.
     79     *
     80     * @since BuddyPress (1.5.0)
     81     * @access public
     82     * @var int
     83     */
     84        public $field;
     85
     86    /**
     87     * A flag for whether the loop is currently being iterated.
     88     *
     89     * @since BuddyPress (1.5.0)
     90     * @access public
     91     * @var bool
     92     */
     93        public $in_the_loop;
     94       
     95    /**
     96     * The user ID.
     97     *
     98     * @since BuddyPress (1.5.0)
     99     * @access public
     100     * @var int
     101     */
     102        public $user_id;
    26103
    27104        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 ) {
Note: See TracChangeset for help on using the changeset viewer.