Skip to:
Content

BuddyPress.org

Changeset 13399


Ignore:
Timestamp:
01/07/2023 01:31:37 AM (19 months ago)
Author:
espellcaste
Message:

Properly declare missing properties to several classes.

Closes https://github.com/buddypress/buddypress/pull/54
See #7018

Location:
trunk/src
Files:
16 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-blogs/classes/class-bp-blogs-template.php

    r13184 r13399  
    7373     */
    7474    public $pag_links = '';
     75
     76    /**
     77     * URL argument used for the pagination param.
     78     *
     79     * @var string
     80     */
     81    public $pag_arg;
    7582
    7683    /**
  • trunk/src/bp-core/classes/class-bp-component.php

    r13395 r13399  
    3131     *
    3232     * @internal
    33      * @var string $name
     33     *
     34     * @var string
    3435     */
    3536    public $name = '';
     
    3940     *
    4041     * @since 1.5.0
    41      * @var string $id
     42     * @var string
    4243     */
    4344    public $id = '';
     
    4748     *
    4849     * @since 1.5.0
    49      * @var string $slug
     50     * @var string
    5051     */
    5152    public $slug = '';
     
    5556     *
    5657     * @since 1.5.0
    57      * @var bool $has_directory
     58     * @var bool
    5859     */
    5960    public $has_directory = false;
     
    6364     *
    6465     * @since 1.5.0
    65      * @var string $path
     66     * @var string
    6667     */
    6768    public $path = '';
     
    7172     *
    7273     * @since 1.5.0
    73      * @var WP_Query $query
     74     * @var WP_Query
    7475     */
    7576    public $query = false;
     
    7980     *
    8081     * @since 1.5.0
    81      * @var string $current_id
     82     * @var string
    8283     */
    8384    public $current_id = '';
     
    8788     *
    8889     * @since 1.5.0
    89      * @var callable $notification_callback
     90     * @var callable
    9091     */
    9192    public $notification_callback = '';
     
    9596     *
    9697     * @since 1.5.0
    97      * @var array $admin_menu
     98     * @var array
    9899     */
    99100    public $admin_menu = '';
     
    103104     *
    104105     * @since 1.6.0
    105      * @var string $search_string
     106     * @var string
    106107     */
    107108    public $search_string = '';
     
    111112     *
    112113     * @since 1.6.0
    113      * @var string $root_slug
     114     * @var string
    114115     */
    115116    public $root_slug = '';
     
    119120     *
    120121     * @since 2.0.0
    121      *
    122122     * @var array
    123123     */
     
    128128     *
    129129     * @since 2.0.0
    130      *
    131130     * @var array
    132131     */
     
    145144     *
    146145     * @since 9.0.0
    147      *
    148146     * @var array
    149147     */
    150148    public $block_globals = array();
     149
     150    /**
     151     * Menu position of the WP Toolbar's "My Account menu".
     152     *
     153     * @since 1.5.0
     154     * @var int
     155     */
     156    public $adminbar_myaccount_order = 90;
     157
     158    /**
     159     * An array of feature names.
     160     *
     161     * @since 1.5.0
     162     * @var string[]
     163     */
     164    public $features = array();
     165
     166    /**
     167     * Component's directory title.
     168     *
     169     * @since 2.0.0
     170     * @var string
     171     */
     172    public $directory_title = '';
    151173
    152174    /** Methods ***************************************************************/
     
    200222                $this->search_query_arg = sanitize_title( $params['search_query_arg'] );
    201223            }
    202 
    203         // Set defaults if not passed.
    204         } else {
    205             // New component menus are added before the settings menu if not set.
    206             $this->adminbar_myaccount_order = 90;
    207224        }
    208225
  • trunk/src/bp-groups/classes/class-bp-group-extension.php

    r13101 r13399  
    224224    public $template_file = 'groups/single/plugins';
    225225
     226    /**
     227     * The template file.
     228     *
     229     * @since 1.1.0
     230     * @var string
     231     */
     232    public $edit_screen_template;
     233
    226234    /** Protected *********************************************************/
    227235
  • trunk/src/bp-groups/classes/class-bp-groups-component.php

    r13336 r13399  
    8484     */
    8585    public $types = array();
     86
     87    /**
     88     * Nav for the Group component.
     89     *
     90     * @since 2.6.0
     91     * @var BP_Core_Nav
     92     */
     93    public $nav;
    8694
    8795    /**
  • trunk/src/bp-groups/classes/class-bp-groups-group-members-template.php

    r13372 r13399  
    6464     */
    6565    public $pag_links;
     66
     67    /**
     68     * URL argument used for the pagination param.
     69     *
     70     * @since 1.0.0
     71     * @var string
     72     */
     73    public $pag_arg;
     74
     75    /**
     76     * The total number of members.
     77     *
     78     * @var int
     79     */
     80    public $total_member_count;
    6681
    6782    /**
  • trunk/src/bp-groups/classes/class-bp-groups-invite-template.php

    r13372 r13399  
    4242
    4343    /**
     44     * List of invites found and their respective data.
     45     *
     46     * @since 1.1.0
     47     * @var array
     48     */
     49    public $invite_data = array();
     50
     51    /**
    4452     * @since 1.1.0
    4553     * @var bool
     
    6472     */
    6573    public $pag_links;
     74
     75    /**
     76     * URL argument used for the pagination param.
     77     *
     78     * @since 1.1.0
     79     * @var string
     80     */
     81    public $pag_arg;
    6682
    6783    /**
  • trunk/src/bp-groups/classes/class-bp-groups-member-suggestions.php

    r13372 r13399  
    3838        'type'         => '',
    3939    );
    40 
    4140
    4241    /**
  • trunk/src/bp-groups/classes/class-bp-groups-membership-requests-template.php

    r13108 r13399  
    6464     */
    6565    public $pag_links;
     66
     67    /**
     68     * URL argument used for the pagination param.
     69     *
     70     * @since 1.0.0
     71     * @var string
     72     */
     73    public $pag_arg;
    6674
    6775    /**
  • trunk/src/bp-groups/classes/class-bp-groups-template.php

    r13184 r13399  
    2222     * The loop iterator.
    2323     *
     24     * @since 1.2.0
    2425     * @var int
    25      * @since 1.2.0
    2626     */
    2727    public $current_group = -1;
     
    3030     * The number of groups returned by the paged query.
    3131     *
     32     * @since 1.2.0
    3233     * @var int
    33      * @since 1.2.0
    3434     */
    3535    public $group_count;
     
    3838     * Array of groups located by the query.
    3939     *
     40     * @since 1.2.0
    4041     * @var array
    41      * @since 1.2.0
    4242     */
    4343    public $groups;
     
    4646     * The group object currently being iterated on.
    4747     *
     48     * @since 1.2.0
    4849     * @var object
    49      * @since 1.2.0
    5050     */
    5151    public $group;
     
    5454     * A flag for whether the loop is currently being iterated.
    5555     *
     56     * @since 1.2.0
    5657     * @var bool
    57      * @since 1.2.0
    5858     */
    5959    public $in_the_loop;
     
    6262     * The page number being requested.
    6363     *
    64      * @var string
    65      * @since 1.2.0
     64     * @since 1.2.0
     65     * @var string
    6666     */
    6767    public $pag_page;
     
    7070     * The number of items being requested per page.
    7171     *
    72      * @var string
    73      * @since 1.2.0
     72     * @since 1.2.0
     73     * @var string
    7474     */
    7575    public $pag_num;
    7676
    7777    /**
     78     * URL argument used for the pagination param.
     79     *
     80     * @since 1.2.0
     81     * @var string
     82     */
     83    public $pag_arg;
     84
     85    /**
    7886     * An HTML string containing pagination links.
    7987     *
    80      * @var string
    81      * @since 1.2.0
     88     * @since 1.2.0
     89     * @var string
    8290     */
    8391    public $pag_links;
     
    8694     * The total number of groups matching the query parameters.
    8795     *
     96     * @since 1.2.0
    8897     * @var int
    89      * @since 1.2.0
    9098     */
    9199    public $total_group_count;
     
    94102     * Whether the template loop is for a single group page.
    95103     *
     104     * @since 1.2.0
    96105     * @var bool
    97      * @since 1.2.0
    98106     */
    99107    public $single_group = false;
     
    102110     * Field to sort by.
    103111     *
    104      * @var string
    105      * @since 1.2.0
     112     * @since 1.2.0
     113     * @var string
    106114     */
    107115    public $sort_by;
     
    110118     * Sort order.
    111119     *
    112      * @var string
    113      * @since 1.2.0
     120     * @since 1.2.0
     121     * @var string
    114122     */
    115123    public $order;
  • trunk/src/bp-members/classes/class-bp-members-component.php

    r13336 r13399  
    2727     */
    2828    public $types = array();
     29
     30    /**
     31     * Main nav arguments.
     32     *
     33     * @since 2.2.0
     34     * @var array
     35     */
     36    public $main_nav = array();
     37
     38    /**
     39     * Main nav arguments.
     40     *
     41     * @since 2.2.0
     42     * @var array
     43     */
     44    public $sub_nav = array();
     45
     46    /**
     47     * Nav for the members component.
     48     *
     49     * @since 2.2.0
     50     * @var BP_Core_Nav
     51     */
     52    public $nav;
    2953
    3054    /**
  • trunk/src/bp-members/classes/class-bp-signup.php

    r13165 r13399  
    2222     */
    2323    public $id;
     24
     25    /**
     26     * ID of the signup which the object relates to.
     27     *
     28     * @since 2.0.0
     29     * @var integer
     30     */
     31    public $signup_id;
    2432
    2533    /**
  • trunk/src/bp-messages/classes/class-bp-messages-box-template.php

    r13148 r13399  
    3838
    3939    /**
     40     * Total number of threads available to iterate on.
     41     *
     42     * @var int
     43     */
     44    public $thread_count = 0;
     45
     46    /**
    4047     * Array of threads located by the query.
    4148     *
     
    94101
    95102    /**
     103     * URL argument used for the pagination param.
     104     *
     105     * @var string
     106     */
     107    public $pag_arg = '';
     108
     109    /**
    96110     * Search terms for limiting the thread query.
    97111     *
     
    99113     */
    100114    public $search_terms = '';
     115
     116    /**
     117     * Type of messages to return. Values: 'all', 'read', 'unread'.
     118     *
     119     * @var string
     120     */
     121    public $type = '';
    101122
    102123    /**
  • trunk/src/bp-messages/classes/class-bp-messages-thread-template.php

    r13147 r13399  
    108108     * Set up the next message and iterate index.
    109109     *
    110      * @return BP_Messages_Message The next message to iterate over.
     110     * @return object The next message to iterate over.
    111111     */
    112112    public function next_message() {
  • trunk/src/bp-notifications/classes/class-bp-notifications-template.php

    r13147 r13399  
    7575     */
    7676    public $user_id;
     77
     78    /**
     79     * The status of the notification.
     80     *
     81     * @since 1.9.0
     82     * @var bool
     83     */
     84    public $is_new;
     85
     86    /**
     87     * The total notification count.
     88     *
     89     * @since 1.9.0
     90     * @var int
     91     */
     92    public $notification_count;
    7793
    7894    /**
     
    262278     * @since 1.9.0
    263279     *
    264      * @return BP_Notifications_Notification The next notification to iterate over.
     280     * @return object The next notification to iterate over.
    265281     */
    266282    public function next_notification() {
  • trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type.php

    r13392 r13399  
    9898     */
    9999    public $field_obj = null;
     100
     101    /**
     102     * Field data visibility.
     103     *
     104     * @since 2.0.0
     105     * @var string
     106     */
     107    public $visibility;
    100108
    101109    /**
  • trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php

    r13395 r13399  
    2222     *
    2323     * @since 1.0.0
    24      * @var int ID of field.
     24     * @var int
    2525     */
    2626    public $id;
     
    3030     *
    3131     * @since 1.0.0
    32      * @var int Field group ID for field.
     32     * @var int
    3333     */
    3434    public $group_id;
     
    3838     *
    3939     * @since 1.0.0
    40      * @var int Parent ID of field.
     40     * @var int
    4141     */
    4242    public $parent_id;
     
    4646     *
    4747     * @since 1.0.0
    48      * @var string Field type.
     48     * @var string
    4949     */
    5050    public $type;
     
    5454     *
    5555     * @since 1.0.0
    56      * @var string Field name.
     56     * @var string
    5757     */
    5858    public $name;
     
    6262     *
    6363     * @since 1.0.0
    64      * @var string Field description.
     64     * @var string
    6565     */
    6666    public $description;
     
    7070     *
    7171     * @since 1.0.0
    72      * @var bool Is field required to be filled out?
     72     * @var bool
    7373     */
    7474    public $is_required;
     
    7878     *
    7979     * @since 1.0.0
    80      * @var int Can field be deleted?
     80     * @var int
    8181     */
    8282    public $can_delete = '1';
     
    8686     *
    8787     * @since 1.0.0
    88      * @var int Field position.
     88     * @var int
    8989     */
    9090    public $field_order;
     
    9494     *
    9595     * @since 1.0.0
    96      * @var int Option order.
     96     * @var int
    9797     */
    9898    public $option_order;
     
    102102     *
    103103     * @since 1.0.0
    104      * @var string Order child fields by.
     104     * @var string
    105105     */
    106106    public $order_by;
     
    110110     *
    111111     * @since 1.0.0
    112      * @var bool Is this the default option for this field?
     112     * @var bool
    113113     */
    114114    public $is_default_option;
     115
     116    /**
     117     * Field data visibility.
     118     *
     119     * @since 1.0.0
     120     * @var string
     121     */
     122    public $visibility;
    115123
    116124    /**
     
    119127     * @since 1.9.0
    120128     * @since 2.4.0 Property marked protected. Now accessible by magic method or by `get_default_visibility()`.
    121      * @var string Default field data visibility.
     129     * @var string
    122130     */
    123131    protected $default_visibility;
     
    128136     * @since 2.3.0
    129137     * @since 2.4.0 Property marked protected. Now accessible by magic method or by `get_allow_custom_visibility()`.
    130      * @var string Members are allowed/disallowed to modify data visibility.
     138     * @var string
    131139     */
    132140    protected $allow_custom_visibility;
Note: See TracChangeset for help on using the changeset viewer.