Skip to:
Content

BuddyPress.org

Changeset 10142


Ignore:
Timestamp:
09/25/2015 02:19:11 AM (11 years ago)
Author:
tw2113
Message:

Finishing off the XProfile class files for @since changes.

See #6576.

Location:
trunk/src/bp-xprofile/classes
Files:
13 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-number.php

    r10140 r10142  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
  • trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-placeholder.php

    r9819 r10142  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
     
    1515 * Used if an existing field has an unknown type (e.g. one provided by a missing third-party plugin).
    1616 *
    17  * @since BuddyPress (2.0.1)
     17 * @since 2.0.1
    1818 */
    1919class BP_XProfile_Field_Type_Placeholder extends BP_XProfile_Field_Type {
     
    2222         * Constructor for the placeholder field type.
    2323         *
    24          * @since BuddyPress (2.0.1)
     24         * @since 2.0.1
    2525         */
    2626        public function __construct() {
     
    3232         *
    3333         * @param array $raw_properties Optional key/value array of {@link http://dev.w3.org/html5/markup/input.text.html permitted attributes} that you want to add.
    34          * @since BuddyPress (2.0.1)
     34         * @since 2.0.1
    3535         */
    3636        public function edit_field_html( array $raw_properties = array() ) {
     
    4141         *
    4242         * @param array $raw_properties Optional key/value array of permitted attributes that you want to add.
    43          * @since BuddyPress (2.0.1)
     43         * @since 2.0.1
    4444         */
    4545        public function admin_field_html( array $raw_properties = array() ) {
     
    5151         * @param BP_XProfile_Field $current_field The current profile field on the add/edit screen.
    5252         * @param string $control_type Optional. HTML input type used to render the current field's child options.
    53          * @since BuddyPress (2.0.1)
     53         * @since 2.0.1
    5454         */
    5555        public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {}
  • trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-radiobutton.php

    r9819 r10142  
    1313 * Radio button xprofile field type.
    1414 *
    15  * @since BuddyPress (2.0.0)
     15 * @since 2.0.0
    1616 */
    1717class BP_XProfile_Field_Type_Radiobutton extends BP_XProfile_Field_Type {
     
    2020         * Constructor for the radio button field type
    2121         *
    22          * @since BuddyPress (2.0.0)
     22         * @since 2.0.0
    2323         */
    2424        public function __construct() {
     
    3535                 * Fires inside __construct() method for BP_XProfile_Field_Type_Radiobutton class.
    3636                 *
    37                  * @since BuddyPress (2.0.0)
     37                 * @since 2.0.0
    3838                 *
    3939                 * @param BP_XProfile_Field_Type_Radiobutton $this Current instance of
     
    4949         *
    5050         * @param array $raw_properties Optional key/value array of {@link http://dev.w3.org/html5/markup/input.radio.html permitted attributes} that you want to add.
    51          * @since BuddyPress (2.0.0)
     51         * @since 2.0.0
    5252         */
    5353        public function edit_field_html( array $raw_properties = array() ) {
     
    103103         *
    104104         * @param array $args Optional. The arguments passed to {@link bp_the_profile_field_options()}.
    105          * @since BuddyPress (2.0.0)
     105         * @since 2.0.0
    106106         */
    107107        public function edit_field_options_html( array $args = array() ) {
     
    141141                         * Filters the HTML output for an individual field options radio button.
    142142                         *
    143                          * @since BuddyPress (1.1.0)
     143                         * @since 1.1.0
    144144                         *
    145145                         * @param string $new_html Label and radio input field.
     
    161161         *
    162162         * @param array $raw_properties Optional key/value array of permitted attributes that you want to add.
    163          * @since BuddyPress (2.0.0)
     163         * @since 2.0.0
    164164         */
    165165        public function admin_field_html( array $raw_properties = array() ) {
     
    184184         * @param BP_XProfile_Field $current_field The current profile field on the add/edit screen.
    185185         * @param string $control_type Optional. HTML input type used to render the current field's child options.
    186          * @since BuddyPress (2.0.0)
     186         * @since 2.0.0
    187187         */
    188188        public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {
  • trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-selectbox.php

    r9819 r10142  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
     
    1313 * Selectbox xprofile field type.
    1414 *
    15  * @since BuddyPress (2.0.0)
     15 * @since 2.0.0
    1616 */
    1717class BP_XProfile_Field_Type_Selectbox extends BP_XProfile_Field_Type {
     
    2020         * Constructor for the selectbox field type
    2121         *
    22          * @since BuddyPress (2.0.0)
     22         * @since 2.0.0
    2323         */
    2424        public function __construct() {
     
    3535                 * Fires inside __construct() method for BP_XProfile_Field_Type_Selectbox class.
    3636                 *
    37                  * @since BuddyPress (2.0.0)
     37                 * @since 2.0.0
    3838                 *
    3939                 * @param BP_XProfile_Field_Type_Selectbox $this Current instance of
     
    4949         *
    5050         * @param array $raw_properties Optional key/value array of {@link http://dev.w3.org/html5/markup/select.html permitted attributes} that you want to add.
    51          * @since BuddyPress (2.0.0)
     51         * @since 2.0.0
    5252         */
    5353        public function edit_field_html( array $raw_properties = array() ) {
     
    9393         *
    9494         * @param array $args Optional. The arguments passed to {@link bp_the_profile_field_options()}.
    95          * @since BuddyPress (2.0.0)
     95         * @since 2.0.0
    9696         */
    9797        public function edit_field_options_html( array $args = array() ) {
     
    136136                         * Filters the HTML output for options in a select input.
    137137                         *
    138                          * @since BuddyPress (1.1.0)
     138                         * @since 1.1.0
    139139                         *
    140140                         * @param string $value    Option tag for current value being rendered.
     
    156156         *
    157157         * @param array $raw_properties Optional key/value array of permitted attributes that you want to add.
    158          * @since BuddyPress (2.0.0)
     158         * @since 2.0.0
    159159         */
    160160        public function admin_field_html( array $raw_properties = array() ) {
     
    175175         * @param BP_XProfile_Field $current_field The current profile field on the add/edit screen.
    176176         * @param string $control_type Optional. HTML input type used to render the current field's child options.
    177          * @since BuddyPress (2.0.0)
     177         * @since 2.0.0
    178178         */
    179179        public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {
  • trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-textarea.php

    r9819 r10142  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
     
    1313 * Textarea xprofile field type.
    1414 *
    15  * @since BuddyPress (2.0.0)
     15 * @since 2.0.0
    1616 */
    1717class BP_XProfile_Field_Type_Textarea extends BP_XProfile_Field_Type {
     
    2020         * Constructor for the textarea field type
    2121         *
    22          * @since BuddyPress (2.0.0)
     22         * @since 2.0.0
    2323         */
    2424        public function __construct() {
     
    3333                 * Fires inside __construct() method for BP_XProfile_Field_Type_Textarea class.
    3434                 *
    35                  * @since BuddyPress (2.0.0)
     35                 * @since 2.0.0
    3636                 *
    3737                 * @param BP_XProfile_Field_Type_Textarea $this Current instance of
     
    4747         *
    4848         * @param array $raw_properties Optional key/value array of {@link http://dev.w3.org/html5/markup/textarea.html permitted attributes} that you want to add.
    49          * @since BuddyPress (2.0.0)
     49         * @since 2.0.0
    5050         */
    5151        public function edit_field_html( array $raw_properties = array() ) {
     
    8585         *
    8686         * @param array $raw_properties Optional key/value array of permitted attributes that you want to add.
    87          * @since BuddyPress (2.0.0)
     87         * @since 2.0.0
    8888         */
    8989        public function admin_field_html( array $raw_properties = array() ) {
     
    104104         * @param BP_XProfile_Field $current_field The current profile field on the add/edit screen.
    105105         * @param string $control_type Optional. HTML input type used to render the current field's child options.
    106          * @since BuddyPress (2.0.0)
     106         * @since 2.0.0
    107107         */
    108108        public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {}
  • trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-textbox.php

    r9819 r10142  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
     
    1313 * Textbox xprofile field type.
    1414 *
    15  * @since BuddyPress (2.0.0)
     15 * @since 2.0.0
    1616 */
    1717class BP_XProfile_Field_Type_Textbox extends BP_XProfile_Field_Type {
     
    2020         * Constructor for the textbox field type
    2121         *
    22          * @since BuddyPress (2.0.0)
     22         * @since 2.0.0
    2323         */
    2424        public function __construct() {
     
    3333                 * Fires inside __construct() method for BP_XProfile_Field_Type_Textbox class.
    3434                 *
    35                  * @since BuddyPress (2.0.0)
     35                 * @since 2.0.0
    3636                 *
    3737                 * @param BP_XProfile_Field_Type_Textbox $this Current instance of
     
    4747         *
    4848         * @param array $raw_properties Optional key/value array of {@link http://dev.w3.org/html5/markup/input.text.html permitted attributes} that you want to add.
    49          * @since BuddyPress (2.0.0)
     49         * @since 2.0.0
    5050         */
    5151        public function edit_field_html( array $raw_properties = array() ) {
     
    8585         *
    8686         * @param array $raw_properties Optional key/value array of permitted attributes that you want to add.
    87          * @since BuddyPress (2.0.0)
     87         * @since 2.0.0
    8888         */
    8989        public function admin_field_html( array $raw_properties = array() ) {
     
    104104         * @param BP_XProfile_Field $current_field The current profile field on the add/edit screen.
    105105         * @param string $control_type Optional. HTML input type used to render the current field's child options.
    106          * @since BuddyPress (2.0.0)
     106         * @since 2.0.0
    107107         */
    108108        public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {}
  • trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-url.php

    r9819 r10142  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
     
    1313 * URL xprofile field type.
    1414 *
    15  * @since BuddyPress (2.1.0)
     15 * @since 2.1.0
    1616 */
    1717class BP_XProfile_Field_Type_URL extends BP_XProfile_Field_Type {
     
    2020         * Constructor for the URL field type
    2121         *
    22          * @since BuddyPress (2.1.0)
     22         * @since 2.1.0
    2323         */
    2424        public function __construct() {
     
    3333                 * Fires inside __construct() method for BP_XProfile_Field_Type_URL class.
    3434                 *
    35                  * @since BuddyPress (2.0.0)
     35                 * @since 2.0.0
    3636                 *
    3737                 * @param BP_XProfile_Field_Type_URL $this Current instance of
     
    4949         *        {@link http://dev.w3.org/html5/markup/input.number.html permitted attributes}
    5050         *        that you want to add.
    51          * @since BuddyPress (2.1.0)
     51         * @since 2.1.0
    5252         */
    5353        public function edit_field_html( array $raw_properties = array() ) {
     
    8989         * @param array $raw_properties Optional key/value array of permitted
    9090         *        attributes that you want to add.
    91          * @since BuddyPress (2.1.0)
     91         * @since 2.1.0
    9292         */
    9393        public function admin_field_html( array $raw_properties = array() ) {
     
    109109         * @param BP_XProfile_Field $current_field The current profile field on the add/edit screen.
    110110         * @param string $control_type Optional. HTML input type used to render the current field's child options.
    111          * @since BuddyPress (2.1.0)
     111         * @since 2.1.0
    112112         */
    113113        public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {}
     
    123123         * is_valid().
    124124         *
    125          * @since BuddyPress (2.1.0)
     125         * @since 2.1.0
    126126         *
    127127         * @param string $submitted_value Raw value submitted by the user.
     
    150150         * Format URL values for display.
    151151         *
    152          * @since BuddyPress (2.1.0)
     152         * @since 2.1.0
    153153         *
    154154         * @param string $field_value The URL value, as saved in the database.
  • trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type.php

    r9819 r10142  
    1313 * Represents a type of XProfile field and holds meta information about the type of value that it accepts.
    1414 *
    15  * @since BuddyPress (2.0.0)
     15 * @since 2.0.0
    1616 */
    1717abstract class BP_XProfile_Field_Type {
    1818
    1919        /**
    20          * @since BuddyPress (2.0.0)
     20         * @since 2.0.0
    2121         * @var array Field type validation regexes
    2222         */
     
    2424
    2525        /**
    26          * @since BuddyPress (2.0.0)
     26         * @since 2.0.0
    2727         * @var array Field type whitelisted values
    2828         */
     
    3030
    3131        /**
    32          * @since BuddyPress (2.0.0)
     32         * @since 2.0.0
    3333         * @var string The name of this field type
    3434         */
     
    3838         * The name of the category that this field type should be grouped with. Used on the [Users > Profile Fields] screen in wp-admin.
    3939         *
    40          * @since BuddyPress (2.0.0)
     40         * @since 2.0.0
    4141         * @var string
    4242         */
     
    4444
    4545        /**
    46          * @since BuddyPress (2.0.0)
     46         * @since 2.0.0
    4747         * @var bool If this is set, allow BP to store null/empty values for this field type.
    4848         */
     
    5252         * If this is set, BP will set this field type's validation whitelist from the field's options (e.g checkbox, selectbox).
    5353         *
    54          * @since BuddyPress (2.0.0)
     54         * @since 2.0.0
    5555         * @var bool Does this field support options? e.g. selectbox, radio buttons, etc.
    5656         */
     
    5858
    5959        /**
    60          * @since BuddyPress (2.0.0)
     60         * @since 2.0.0
    6161         * @var bool Does this field type support multiple options being set as default values? e.g. multiselectbox, checkbox.
    6262         */
     
    6464
    6565        /**
    66          * @since BuddyPress (2.0.0)
     66         * @since 2.0.0
    6767         * @var BP_XProfile_Field If this object is created by instantiating a {@link BP_XProfile_Field}, this is a reference back to that object.
    6868         */
     
    7272         * Constructor
    7373         *
    74          * @since BuddyPress (2.0.0)
     74         * @since 2.0.0
    7575         */
    7676        public function __construct() {
     
    7979                 * Fires inside __construct() method for BP_XProfile_Field_Type class.
    8080                 *
    81                  * @since BuddyPress (2.0.0)
     81                 * @since 2.0.0
    8282                 *
    8383                 * @param BP_XProfile_Field_Type $this Current instance of
     
    9696         * @param string $replace_format Optional; if 'replace', replaces the format instead of adding to it. Defaults to 'add'.
    9797         * @return BP_XProfile_Field_Type
    98          * @since BuddyPress (2.0.0)
     98         * @since 2.0.0
    9999         */
    100100        public function set_format( $format, $replace_format = 'add' ) {
     
    103103                 * Filters the regex format for the field type.
    104104                 *
    105                  * @since BuddyPress (2.0.0)
     105                 * @since 2.0.0
    106106                 *
    107107                 * @param string                 $format         Regex string.
     
    129129         * @param string|array $values
    130130         * @return BP_XProfile_Field_Type
    131          * @since BuddyPress (2.0.0)
     131         * @since 2.0.0
    132132         */
    133133        public function set_whitelist_values( $values ) {
     
    137137                         * Filters values for field type's whitelist that profile data will be asserted against.
    138138                         *
    139                          * @since BuddyPress (2.0.0)
     139                         * @since 2.0.0
    140140                         *
    141141                         * @param string                 $value  Field value.
     
    156156         * @param string|array $values Value to check against the registered formats
    157157         * @return bool True if the value validates
    158          * @since BuddyPress (2.0.0)
     158         * @since 2.0.0
    159159         */
    160160        public function is_valid( $values ) {
     
    191191                 * Filters whether or not field type is a valid format.
    192192                 *
    193                  * @since BuddyPress (2.0.0)
     193                 * @since 2.0.0
    194194                 *
    195195                 * @param bool                   $validated Whether or not the field type is valid.
     
    206206         *
    207207         * @param array $raw_properties Optional key/value array of permitted attributes that you want to add.
    208          * @since BuddyPress (2.0.0)
     208         * @since 2.0.0
    209209         */
    210210        abstract public function edit_field_html( array $raw_properties = array() );
     
    223223         *
    224224         * @param array $args Optional. The arguments passed to {@link bp_the_profile_field_options()}.
    225          * @since BuddyPress (2.0.0)
     225         * @since 2.0.0
    226226         */
    227227        public function edit_field_options_html( array $args = array() ) {}
     
    233233         *
    234234         * @param array $raw_properties Optional key/value array of permitted attributes that you want to add.
    235          * @since BuddyPress (2.0.0)
     235         * @since 2.0.0
    236236         */
    237237        abstract public function admin_field_html( array $raw_properties = array() );
     
    248248         * @param BP_XProfile_Field $current_field The current profile field on the add/edit screen.
    249249         * @param string $control_type Optional. HTML input type used to render the current field's child options.
    250          * @since BuddyPress (2.0.0)
     250         * @since 2.0.0
    251251         */
    252252        public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {
     
    357357                                 * Fires at the end of the new field additional settings area.
    358358                                 *
    359                                  * @since BuddyPress (2.3.0)
     359                                 * @since 2.3.0
    360360                                 *
    361361                                 * @param BP_XProfile_Field $current_field Current field being rendered.
     
    383383         * validation filtering.
    384384         *
    385          * @since BuddyPress (2.1.0)
     385         * @since 2.1.0
    386386         *
    387387         * @param mixed $submitted_value Submitted value.
     
    399399         * filtering for output values.
    400400         *
    401          * @since BuddyPress (2.1.0)
     401         * @since 2.1.0
    402402         *
    403403         * @param mixed $field_value Field value.
     
    418418         * @param array $properties Optional key/value array of attributes for this edit field.
    419419         * @return string
    420          * @since BuddyPress (2.0.0)
     420         * @since 2.0.0
    421421         */
    422422        protected function get_edit_field_html_elements( array $properties = array() ) {
     
    436436                 * Filters the edit html elements and attributes.
    437437                 *
    438                  * @since BuddyPress (2.0.0)
     438                 * @since 2.0.0
    439439                 *
    440440                 * @param array  $r     Array of parsed arguments.
  • trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php

    r10022 r10142  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
     
    1313
    1414        /**
    15          * @since BuddyPress (1.0.0)
     15         * @since 1.0.0
    1616         *
    1717         * @var int ID of field
     
    2020
    2121        /**
    22          * @since BuddyPress (1.0.0)
     22         * @since 1.0.0
    2323         *
    2424         * @var int Field group ID for field
     
    2727
    2828        /**
    29          * @since BuddyPress (1.0.0)
     29         * @since 1.0.0
    3030         *
    3131         * @var int Parent ID of field
     
    3434
    3535        /**
    36          * @since BuddyPress (1.0.0)
     36         * @since 1.0.0
    3737         *
    3838         * @var string Field type
     
    4141
    4242        /**
    43          * @since BuddyPress (1.0.0)
     43         * @since 1.0.0
    4444         *
    4545         * @var string Field name
     
    4848
    4949        /**
    50          * @since BuddyPress (1.0.0)
     50         * @since 1.0.0
    5151         *
    5252         * @var string Field description
     
    5555
    5656        /**
    57          * @since BuddyPress (1.0.0)
     57         * @since 1.0.0
    5858         *
    5959         * @var bool Is field required to be filled out?
     
    6262
    6363        /**
    64          * @since BuddyPress (1.0.0)
     64         * @since 1.0.0
    6565         *
    6666         * @var int Can field be deleted?
     
    6969
    7070        /**
    71          * @since BuddyPress (1.0.0)
     71         * @since 1.0.0
    7272         *
    7373         * @var int Field position
     
    7676
    7777        /**
    78          * @since BuddyPress (1.0.0)
     78         * @since 1.0.0
    7979         *
    8080         * @var int Option order
     
    8383
    8484        /**
    85          * @since BuddyPress (1.0.0)
     85         * @since 1.0.0
    8686         *
    8787         * @var string Order child fields by
     
    9090
    9191        /**
    92          * @since BuddyPress (1.0.0)
     92         * @since 1.0.0
    9393         *
    9494         * @var bool Is this the default option for this field?
     
    9797
    9898        /**
    99          * @since BuddyPress (1.9.0)
     99         * @since 1.9.0
    100100         *
    101101         * @var string Default field data visibility
     
    104104
    105105        /**
    106          * @since BuddyPress (2.3.0)
     106         * @since 2.3.0
    107107         *
    108108         * @var string Members are allowed/disallowed to modify data visibility
     
    111111
    112112        /**
    113          * @since BuddyPress (2.0.0)
     113         * @since 2.0.0
    114114         *
    115115         * @var BP_XProfile_Field_Type Field type object used for validation
     
    118118
    119119        /**
    120          * @since BuddyPress (2.0.0)
     120         * @since 2.0.0
    121121         *
    122122         * @var BP_XProfile_ProfileData Field data for user ID
     
    127127         * Member types to which the profile field should be applied.
    128128         *
    129          * @since BuddyPress (2.4.0)
     129         * @since 2.4.0
    130130         * @access protected
    131131         * @var array Array of member types.
     
    136136         * Initialize and/or populate profile field
    137137         *
    138          * @since BuddyPress (1.1.0)
     138         * @since 1.1.0
    139139         *
    140140         * @param int  $id
     
    157157         * Populate a profile field object
    158158         *
    159          * @since BuddyPress (1.1.0)
     159         * @since 1.1.0
    160160         *
    161161         * @global object $wpdb
     
    217217         * Delete a profile field
    218218         *
    219          * @since BuddyPress (1.1.0)
     219         * @since 1.1.0
    220220         *
    221221         * @global object  $wpdb
     
    251251         * Save a profile field
    252252         *
    253          * @since BuddyPress (1.1.0)
     253         * @since 1.1.0
    254254         *
    255255         * @global object $wpdb
     
    279279                 * Please use this hook to filter the properties above. Each part will be passed in.
    280280                 *
    281                  * @since BuddyPress (1.0.0)
     281                 * @since 1.0.0
    282282                 *
    283283                 * @param BP_XProfile_Field Current instance of the field being saved.
     
    330330                                 * Filters the submitted field option value before saved.
    331331                                 *
    332                                  * @since BuddyPress (1.5.0)
     332                                 * @since 1.5.0
    333333                                 *
    334334                                 * @param string            $post_option Submitted option value.
     
    340340                                 * Filters the default field option value before saved.
    341341                                 *
    342                                  * @since BuddyPress (1.5.0)
     342                                 * @since 1.5.0
    343343                                 *
    344344                                 * @param string            $post_default Default option value.
     
    377377                         * Fires after the current field instance gets saved.
    378378                         *
    379                          * @since BuddyPress (1.0.0)
     379                         * @since 1.0.0
    380380                         *
    381381                         * @param BP_XProfile_Field Current instance of the field being saved.
     
    396396         * Get field data for a user ID
    397397         *
    398          * @since BuddyPress (1.2.0)
     398         * @since 1.2.0
    399399         *
    400400         * @param  int $user_id
     
    408408         * Get all child fields for this field ID
    409409         *
    410          * @since BuddyPress (1.2.0)
     410         * @since 1.2.0
    411411         *
    412412         * @global object $wpdb
     
    443443                 * Filters the found children for a field.
    444444                 *
    445                  * @since BuddyPress (1.2.5)
     445                 * @since 1.2.5
    446446                 *
    447447                 * @param object $children    Found children for a field.
     
    454454         * Delete all field children for this field
    455455         *
    456          * @since BuddyPress (1.2.0)
     456         * @since 1.2.0
    457457         *
    458458         * @global object $wpdb
     
    474474         * 'null' is a special pseudo-type, which represents users that do not have a member type.
    475475         *
    476          * @since BuddyPress (2.4.0)
     476         * @since 2.4.0
    477477         *
    478478         * @return array Array of member type names.
     
    515515                 * Filters the member types to which an XProfile object should be applied.
    516516                 *
    517                  * @since BuddyPress (2.4.0)
     517                 * @since 2.4.0
    518518                 *
    519519                 * @param array             $types Member types.
     
    528528         * Sets the member types for this field.
    529529         *
    530          * @since BuddyPress (2.4.0)
     530         * @since 2.4.0
    531531         *
    532532         * @param array $member_types Array of member types. Can include 'null' (users with no type) in addition to any
     
    586586                 * Fires after a field's member types have been updated.
    587587                 *
    588                  * @since BuddyPress (2.4.0)
     588                 * @since 2.4.0
    589589                 *
    590590                 * @param BP_XProfile_Field $field Field object.
     
    601601         * This label is displayed alongside the field's name on the Profile Fields Dashboard panel.
    602602         *
    603          * @since BuddyPress (2.4.0)
     603         * @since 2.4.0
    604604         *
    605605         * @return string
     
    681681         * Delete all fields in a field group
    682682         *
    683          * @since BuddyPress (1.2.0)
     683         * @since 1.2.0
    684684         *
    685685         * @global object $wpdb
     
    712712         * Get field ID from field name
    713713         *
    714          * @since BuddyPress (1.5.0)
     714         * @since 1.5.0
    715715         *
    716716         * @global object $wpdb
     
    736736         * Update field position and/or field group when relocating
    737737         *
    738          * @since BuddyPress (1.5.0)
     738         * @since 1.5.0
    739739         *
    740740         * @global object $wpdb
     
    775775         * Gets the IDs of fields applicable for a given member type or array of member types.
    776776         *
    777          * @since BuddyPress (2.4.0)
     777         * @since 2.4.0
    778778         *
    779779         * @param string|array $member_types Member type or array of member types. Use 'any' to return unrestricted
     
    849849         * Validate form field data on sumbission
    850850         *
    851          * @since BuddyPress (2.2.0)
     851         * @since 2.2.0
    852852         *
    853853         * @global type $message
     
    931931         * Oupput the admin form for this field
    932932         *
    933          * @since BuddyPress (1.9.0)
     933         * @since 1.9.0
    934934         *
    935935         * @param type $message
     
    10001000                                                         * Fires after XProfile Field sidebar metabox.
    10011001                                                         *
    1002                                                          * @since BuddyPress (2.2.0)
     1002                                                         * @since 2.2.0
    10031003                                                         *
    10041004                                                         * @param BP_XProfile_Field $this Current XProfile field.
     
    10151015                                                         * Fires before XProfile Field content metabox.
    10161016                                                         *
    1017                                                          * @since BuddyPress (2.3.0)
     1017                                                         * @since 2.3.0
    10181018                                                         *
    10191019                                                         * @param BP_XProfile_Field $this Current XProfile field.
     
    10301030                                                         * Fires after XProfile Field content metabox.
    10311031                                                         *
    1032                                                          * @since BuddyPress (2.2.0)
     1032                                                         * @since 2.2.0
    10331033                                                         *
    10341034                                                         * @param BP_XProfile_Field $this Current XProfile field.
     
    10481048         * Private method used to display the submit metabox
    10491049         *
    1050          * @since BuddyPress (2.3.0)
     1050         * @since 2.3.0
    10511051         *
    10521052         * @param string $button_text
     
    10571057                 * Fires before XProfile Field submit metabox.
    10581058                 *
    1059                  * @since BuddyPress (2.1.0)
     1059                 * @since 2.1.0
    10601060                 *
    10611061                 * @param BP_XProfile_Field $this Current XProfile field.
     
    10741074                                                 * Fires at the beginning of the XProfile Field publishing actions section.
    10751075                                                 *
    1076                                                  * @since BuddyPress (2.1.0)
     1076                                                 * @since 2.1.0
    10771077                                                 *
    10781078                                                 * @param BP_XProfile_Field $this Current XProfile field.
     
    11071107                 * Fires after XProfile Field submit metabox.
    11081108                 *
    1109                  * @since BuddyPress (2.1.0)
     1109                 * @since 2.1.0
    11101110                 *
    11111111                 * @param BP_XProfile_Field $this Current XProfile field.
     
    11171117         * Private method used to output field name and description fields
    11181118         *
    1119          * @since BuddyPress (2.3.0)
     1119         * @since 2.3.0
    11201120         */
    11211121        private function name_and_description() {
     
    11421142         * Private method used to output field Member Type metabox.
    11431143         *
    1144          * @since BuddyPress (2.4.0)
     1144         * @since 2.4.0
    11451145         */
    11461146        private function member_type_metabox() {
     
    11951195         * Private method used to output field visibility metaboxes
    11961196         *
    1197          * @since BuddyPress (2.3.0)
     1197         * @since 2.3.0
    11981198         *
    11991199         * @return if default field id 1
     
    12441244         * Output the metabox for setting if field is required or not
    12451245         *
    1246          * @since BuddyPress (2.3.0)
     1246         * @since 2.3.0
    12471247         *
    12481248         * @return if default field
     
    12711271         * Output the metabox for setting what type of field this is
    12721272         *
    1273          * @since BuddyPress (2.3.0)
     1273         * @since 2.3.0
    12741274         *
    12751275         * @return if default field
     
    13071307         * Output hidden fields used by default field
    13081308         *
    1309          * @since BuddyPress (2.3.0)
     1309         * @since 2.3.0
    13101310         *
    13111311         * @return if not default field
     
    13271327         * Return if a field ID is the default field
    13281328         *
    1329          * @since BuddyPress (2.3.0)
     1329         * @since 2.3.0
    13301330         *
    13311331         * @param  int $field_id ID of field to check
  • trunk/src/bp-xprofile/classes/class-bp-xprofile-group.php

    r10023 r10142  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
     
    1313
    1414        /**
    15          * @since BuddyPress (1.1.0)
     15         * @since 1.1.0
    1616         *
    1717         * @var int ID of field group
     
    2020
    2121        /**
    22          * @since BuddyPress (1.1.0)
     22         * @since 1.1.0
    2323         *
    2424         * @var string Name of field group
     
    2727
    2828        /**
    29          * @since BuddyPress (1.1.0)
     29         * @since 1.1.0
    3030         *
    3131         * @var string Description of field group
     
    3434
    3535        /**
    36          * @since BuddyPress (1.1.0)
     36         * @since 1.1.0
    3737         *
    3838         * @var bool Can this group be deleted?
     
    4141
    4242        /**
    43          * @since BuddyPress (1.1.0)
     43         * @since 1.1.0
    4444         *
    4545         * @var int Group order relative to other groups
     
    4848
    4949        /**
    50          * @since BuddyPress (1.1.0)
     50         * @since 1.1.0
    5151         *
    5252         * @var array Fields of group
     
    5757         * Initialize and/or populate profile field group
    5858         *
    59          * @since BuddyPress (1.1.0)
     59         * @since 1.1.0
    6060         *
    6161         * @param int  $id
     
    7272         * Populate a profile field group
    7373         *
    74          * @since BuddyPress (1.0.0)
     74         * @since 1.0.0
    7575         *
    7676         * @global $wpdb $wpdb
     
    105105         * Save a profile field group
    106106         *
    107          * @since BuddyPress (1.1.0)
     107         * @since 1.1.0
    108108         *
    109109         * @global object $wpdb
     
    123123                 * Please use this hook to filter the properties above. Each part will be passed in.
    124124                 *
    125                  * @since BuddyPress (1.0.0)
     125                 * @since 1.0.0
    126126                 *
    127127                 * @param BP_XProfile_Group Current instance of the group being saved. Passed by reference.
     
    154154                 * Fires after the current group instance gets saved.
    155155                 *
    156                  * @since BuddyPress (1.0.0)
     156                 * @since 1.0.0
    157157                 *
    158158                 * @param BP_XProfile_Group Current instance of the group being saved. Passed by reference.
     
    166166         * Delete a profile field group
    167167         *
    168          * @since BuddyPress (1.1.0)
     168         * @since 1.1.0
    169169         *
    170170         * @global object  $wpdb
     
    182182                 * Fires before the current group instance gets deleted.
    183183                 *
    184                  * @since BuddyPress (2.0.0)
     184                 * @since 2.0.0
    185185                 *
    186186                 * @param BP_XProfile_Group Current instance of the group being deleted. Passed by reference.
     
    209209                 * Fires after the current group instance gets deleted.
    210210                 *
    211                  * @since BuddyPress (2.0.0)
     211                 * @since 2.0.0
    212212                 *
    213213                 * @param BP_XProfile_Group Current instance of the group being deleted. Passed by reference.
     
    469469         * Get data about a set of groups, based on IDs.
    470470         *
    471          * @since BuddyPress (2.0.0)
     471         * @since 2.0.0
    472472         *
    473473         * @param array $group_ids Array of IDs.
     
    538538         * Validate field group when form submitted
    539539         *
    540          * @since BuddyPress (1.0.0)
     540         * @since 1.0.0
    541541         *
    542542         * @global string $message
     
    559559         * Update field group position
    560560         *
    561          * @since BuddyPress (1.5.0)
     561         * @since 1.5.0
    562562         *
    563563         * @global $wpdb $wpdb
     
    585585         * Fetch the field visibility level for the fields returned by the query
    586586         *
    587          * @since BuddyPress (1.6.0)
     587         * @since 1.6.0
    588588         *
    589589         * @param int $user_id The profile owner's user_id
     
    613613                                 * Filters the XProfile default visibility level for a field.
    614614                                 *
    615                                  * @since BuddyPress (1.6.0)
     615                                 * @since 1.6.0
    616616                                 *
    617617                                 * @param string $value Default visibility value.
     
    631631         * Fetch the admin-set preferences for all fields.
    632632         *
    633          * @since BuddyPress (1.6.0)
     633         * @since 1.6.0
    634634         *
    635635         * @return array $default_visibility_levels An array, keyed by
     
    671671         * Output the admin area field group form
    672672         *
    673          * @since BuddyPress (1.0.0)
     673         * @since 1.0.0
    674674         *
    675675         * @global string $message
     
    730730                                                         * Fires before XProfile Group submit metabox.
    731731                                                         *
    732                                                          * @since BuddyPress (2.1.0)
     732                                                         * @since 2.1.0
    733733                                                         *
    734734                                                         * @param BP_XProfile_Group $this Current XProfile group.
     
    747747                                                                                         * Fires at the beginning of the XProfile Group publishing actions section.
    748748                                                                                         *
    749                                                                                          * @since BuddyPress (2.1.0)
     749                                                                                         * @since 2.1.0
    750750                                                                                         *
    751751                                                                                         * @param BP_XProfile_Group $this Current XProfile group.
     
    771771                                                         * Fires after XProfile Group submit metabox.
    772772                                                         *
    773                                                          * @since BuddyPress (2.1.0)
     773                                                         * @since 2.1.0
    774774                                                         *
    775775                                                         * @param BP_XProfile_Group $this Current XProfile group.
  • trunk/src/bp-xprofile/classes/class-bp-xprofile-meta-query.php

    r9819 r10142  
    11<?php
    2 
    32/**
    43 * BuddyPress XProfile Classes
     
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
     
    2019 * to the primary SQL query string.
    2120 *
    22  * @since BuddyPress (2.3.0)
     21 * @since 2.3.0
    2322 */
    2423class BP_XProfile_Meta_Query extends WP_Meta_Query {
     
    3029         * or 'object' array key.
    3130         *
    32          * @since BuddyPress (2.3.0)
     31         * @since 2.3.0
    3332         * @access protected
    3433         *
     
    4342         * Constructs a meta query based on 'meta_*' query vars
    4443         *
    45          * @since BuddyPress (2.3.0)
     44         * @since 2.3.0
    4645         * @access public
    4746         *
     
    9695         * Generates SQL clauses to be appended to a main query.
    9796         *
    98          * @since BuddyPress (2.3.0)
     97         * @since 2.3.0
    9998         * @access public
    10099         *
     
    134133                 * Filter the meta query's generated SQL.
    135134                 *
    136                  * @since BuddyPress (2.3.0)
     135                 * @since 2.3.0
    137136                 *
    138137                 * @param array $args {
     
    155154         * "First-order" means that it's an array with a 'key' or 'value'.
    156155         *
    157          * @since BuddyPress (2.3.0)
     156         * @since 2.3.0
    158157         * @access public
    159158         *
  • trunk/src/bp-xprofile/classes/class-bp-xprofile-profiledata.php

    r9819 r10142  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
     
    7878                 * Filters whether or not data already exists for the user.
    7979                 *
    80                  * @since BuddyPress (1.2.7)
     80                 * @since 1.2.7
    8181                 *
    8282                 * @param bool                    $retval Whether or not data already exists.
     
    102102                 * Filters whether or not data is for a valid field
    103103                 *
    104                  * @since BuddyPress (1.2.7)
     104                 * @since 1.2.7
    105105                 *
    106106                 * @param bool                    $retval Whether or not data is valid.
     
    125125                 * Please use this hook to filter the properties above. Each part will be passed in.
    126126                 *
    127                  * @since BuddyPress (1.0.0)
     127                 * @since 1.0.0
    128128                 *
    129129                 * @param BP_XProfile_ProfileData $this Current instance of the profile data being saved.
     
    151151                         * Fires after the current profile data instance gets saved.
    152152                         *
    153                          * @since BuddyPress (1.0.0)
     153                         * @since 1.0.0
    154154                         *
    155155                         * @param BP_XProfile_ProfileData $this Current instance of the profile data being saved.
     
    177177                 * Fires before the current profile data instance gets deleted.
    178178                 *
    179                  * @since BuddyPress (1.9.0)
     179                 * @since 1.9.0
    180180                 *
    181181                 * @param BP_XProfile_ProfileData $this Current instance of the profile data being deleted.
     
    191191                 * Fires after the current profile data instance gets deleted.
    192192                 *
    193                  * @since BuddyPress (1.9.0)
     193                 * @since 1.9.0
    194194                 *
    195195                 * @param BP_XProfile_ProfileData $this Current instance of the profile data being deleted.
  • trunk/src/bp-xprofile/classes/class-bp-xprofile-query.php

    r9819 r10142  
    1313 * Class for generating SQL clauses to filter a user query by xprofile data.
    1414 *
    15  * @since BuddyPress (2.2.0)
     15 * @since 2.2.0
    1616 */
    1717class BP_XProfile_Query {
     
    2121         * See {@see WP_XProfile_Query::__construct()} for information on parameters.
    2222         *
    23          * @since  BuddyPress (2.2.0)
     23         * @since 2.2.0
    2424         * @access public
    2525         * @var    array
     
    3030         * Database table that where the metadata's objects are stored (eg $wpdb->users).
    3131         *
    32          * @since  BuddyPress (2.2.0)
     32         * @since 2.2.0
    3333         * @access public
    3434         * @var    string
     
    3939         * Column in primary_table that represents the ID of the object.
    4040         *
    41          * @since  BuddyPress (2.2.0)
     41         * @since 2.2.0
    4242         * @access public
    4343         * @var    string
     
    4848         * A flat list of table aliases used in JOIN clauses.
    4949         *
    50          * @since  BuddyPress (2.2.0)
     50         * @since 2.2.0
    5151         * @access protected
    5252         * @var    array
     
    5757         * Constructor.
    5858         *
    59          * @since  BuddyPress (2.2.0)
     59         * @since 2.2.0
    6060         * @access public
    6161         *
     
    9393         * Eliminates empty items and ensures that a 'relation' is set.
    9494         *
    95          * @since  BuddyPress (2.2.0)
     95         * @since 2.2.0
    9696         * @access public
    9797         *
     
    160160         * A first-order query clause is one that has either a 'key' or a 'value' array key.
    161161         *
    162          * @since  BuddyPress (2.2.0)
     162         * @since 2.2.0
    163163         * @access protected
    164164         *
     
    173173         * Return the appropriate alias for the given field type if applicable.
    174174         *
    175          * @since  BuddyPress (2.2.0)
     175         * @since 2.2.0
    176176         * @access public
    177177         *
     
    203203         * with WP's Query classes.
    204204         *
    205          * @since  BuddyPress (2.2.0)
     205         * @since 2.2.0
    206206         * @access protected
    207207         *
     
    233233         * If nested subqueries are found, this method recurses the tree to produce the properly nested SQL.
    234234         *
    235          * @since  BuddyPress (2.2.0)
     235         * @since 2.2.0
    236236         * @access protected
    237237         *
     
    314314         * Generates SQL clauses to be appended to a main query.
    315315         *
    316          * @since  BuddyPress (2.2.0)
     316         * @since 2.2.0
    317317         * @access public
    318318         *
     
    349349         * "First-order" means that it's an array with a 'field' or 'value'.
    350350         *
    351          * @since  BuddyPress (2.2.0)
     351         * @since 2.2.0
    352352         * @access public
    353353         *
     
    499499         * this * only applies to IN clauses that are connected by the relation OR.
    500500         *
    501          * @since  BuddyPress (2.2.0)
     501         * @since 2.2.0
    502502         * @access protected
    503503         *
Note: See TracChangeset for help on using the changeset viewer.