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

Timestamp:

10/01/2015 04:18:13 AM (9 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-checkbox.php (modified) (8 diffs)

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

@@ -18 +18 @@
 
     /**
-     * Constructor for the checkbox field type
+     * Constructor for the checkbox 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/input.checkbox.html permitted attributes} that you want to add.
      * @since 2.0.0
+     *
+     * @param array $raw_properties Optional key/value array of
+     *                              {@link http://dev.w3.org/html5/markup/input.checkbox.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'] ) ) {
@@ -97 +100 @@
      * 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() ) {
@@ -108 +112 @@
 
         // Check for updated posted values, but errors preventing them from
-        // being saved first time
+        // being saved first time.
         if ( isset( $_POST['field_' . $this->field_obj->id] ) && $option_values != maybe_serialize( $_POST['field_' . $this->field_obj->id] ) ) {
             if ( ! empty( $_POST['field_' . $this->field_obj->id] ) ) {
@@ -118 +122 @@
             $selected = '';
 
-            // First, check to see whether the user's saved values match the option
+            // First, check to see whether the user's saved values match the option.
             for ( $j = 0, $count_values = count( $option_values ); $j < $count_values; ++$j ) {
 
                 // Run the allowed option name through the before_save filter,
-                // so we'll be sure to get a match
+                // so we'll be sure to get a match.
                 $allowed_options = xprofile_sanitize_data_value_before_save( $options[$k]->name, false, false );
 
@@ -132 +136 @@
 
             // If the user has not yet supplied a value for this field, check to
-            // see whether there is a default value available
+            // see whether there is a default value available.
             if ( empty( $option_values ) && empty( $selected ) && ! empty( $options[$k]->is_default_option ) ) {
                 $selected = ' checked="checked"';
@@ -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() ) {
@@ -179 +184 @@
      * 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 = '' ) {