Changeset 10163 for trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-multiselectbox.php

Timestamp:

10/01/2015 04:18:13 AM (10 years ago)

Author:

tw2113

Message:

First pass of documentation cleanup for the XProfile Component.

See #6406.

File:

• trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-multiselectbox.php (modified) (7 diffs)

trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-multiselectbox.php

@@ -18 +18 @@
 
     /**
-     * Constructor for the multi-selectbox field type
-     *
-     * @since 2.0.0
-     */
+     * Constructor for the multi-selectbox field type.
+     *
+     * @since 2.0.0
+     */
     public function __construct() {
         parent::__construct();
@@ -50 +50 @@
      * Must be used inside the {@link bp_profile_fields()} template loop.
      *
-     * @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.
-     * @since 2.0.0
+     * @since 2.0.0
+     *
+     * @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.
      */
     public function edit_field_html( array $raw_properties = array() ) {
 
-        // user_id is a special optional parameter that we pass to
+        // User_id is a special optional parameter that we pass to
         // {@link bp_the_profile_field_options()}.
         if ( isset( $raw_properties['user_id'] ) ) {
@@ -104 +107 @@
      * Must be used inside the {@link bp_profile_fields()} template loop.
      *
+     * @since 2.0.0
+     *
      * @param array $args Optional. The arguments passed to {@link bp_the_profile_field_options()}.
-     * @since 2.0.0
      */
     public function edit_field_options_html( array $args = array() ) {
@@ -122 +126 @@
 
             // Check for updated posted values, but errors preventing them from
-            // being saved first time
+            // being saved first time.
             foreach( $option_values as $i => $option_value ) {
                 if ( isset( $_POST['field_' . $this->field_obj->id] ) && $_POST['field_' . $this->field_obj->id][$i] != $option_value ) {
@@ -132 +136 @@
 
             // Run the allowed option name through the before_save filter, so
-            // we'll be sure to get a match
+            // we'll be sure to get a match.
             $allowed_options = xprofile_sanitize_data_value_before_save( $options[$k]->name, false, false );
 
-            // First, check to see whether the user-entered value matches
+            // First, check to see whether the user-entered value matches.
             if ( in_array( $allowed_options, $option_values ) ) {
                 $selected = ' selected="selected"';
             }
 
-            // Then, if the user has not provided a value, check for defaults
+            // Then, if the user has not provided a value, check for defaults.
             if ( ! is_array( $original_option_values ) && empty( $option_values ) && ! empty( $options[$k]->is_default_option ) ) {
                 $selected = ' selected="selected"';
@@ -167 +171 @@
      * Must be used inside the {@link bp_profile_fields()} template loop.
      *
+     * @since 2.0.0
+     *
      * @param array $raw_properties Optional key/value array of permitted attributes that you want to add.
-     * @since 2.0.0
      */
     public function admin_field_html( array $raw_properties = array() ) {
@@ -183 +188 @@
 
     /**
-     * Output HTML for this field type's children options on the wp-admin Profile Fields "Add Field" and "Edit Field" screens.
-     *
-     * Must be used inside the {@link bp_profile_fields()} template loop.
+     * Output HTML for this field type's children options on the wp-admin Profile Fields,
+     * "Add Field" and "Edit Field" screens.
+     *
+     * Must be used inside the {@link bp_profile_fields()} template loop.
+     *
+     * @since 2.0.0
      *
      * @param BP_XProfile_Field $current_field The current profile field on the add/edit screen.
-     * @param string $control_type Optional. HTML input type used to render the current field's child options.
-     * @since 2.0.0
+     * @param string            $control_type  Optional. HTML input type used to render the current
+     *                                         field's child options.
      */
     public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {