Changeset 10163 for trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-radiobutton.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-radiobutton.php (modified) (9 diffs)

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

@@ -1 +1 @@
 <?php
 /**
- * BuddyPress XProfile Classes
+ * BuddyPress XProfile Classes.
  *
  * @package BuddyPress
@@ -7 +7 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -21 +21 @@
      *
      * @since 2.0.0
-     */
+     */
     public function __construct() {
         parent::__construct();
@@ -48 +48 @@
      * 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.radio.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.radio.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'] ) ) {
@@ -102 +105 @@
      * 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() ) {
@@ -114 +118 @@
 
             // 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_value != $_POST['field_' . $this->field_obj->id] ) {
                 if ( ! empty( $_POST['field_' . $this->field_obj->id] ) ) {
@@ -122 +126 @@
 
             // 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 );
             $selected        = '';
@@ -160 +164 @@
      * 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() ) {
@@ -182 +187 @@
      * 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 = '' ) {