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

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

@@ -18 +18 @@
 
     /**
-     * Constructor for the datebox field type
-     *
-     * @since 2.0.0
-     */
+     * Constructor for the datebox field type.
+     *
+     * @since 2.0.0
+     */
     public function __construct() {
         parent::__construct();
@@ -46 +46 @@
      * 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.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/input.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'] ) ) {
@@ -128 +131 @@
      * 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() ) {
@@ -140 +144 @@
         $eng_months = array( 'January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December' );
 
-        // Set day, month, year defaults
+        // Set day, month, year defaults.
         if ( ! empty( $date ) ) {
 
-            // If Unix timestamp
+            // If Unix timestamp.
             if ( is_numeric( $date ) ) {
                 $day   = date( 'j', $date );
@@ -149 +153 @@
                 $year  = date( 'Y', $date );
 
-            // If MySQL timestamp
+            // If MySQL timestamp.
             } else {
                 $day   = mysql2date( 'j', $date );
-                $month = mysql2date( 'F', $date, false ); // Not localized, so that selected() works below
+                $month = mysql2date( 'F', $date, false ); // Not localized, so that selected() works below.
                 $year  = mysql2date( 'Y', $date );
             }
@@ -179 +183 @@
         }
 
-        // $type will be passed by calling function when needed
+        // $type will be passed by calling function when needed.
         switch ( $args['type'] ) {
             case 'day':
@@ -242 +246 @@
      * 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() ) {
@@ -281 +286 @@
      * "Add Field" and "Edit Field" screens, but for this field type, we don't want it, so it's stubbed out.
      *
+     * @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 = '' ) {}
@@ -293 +300 @@
      *
      * @param string $field_value The date value, as saved in the database.
-     *        Typically, this is a MySQL-formatted date string (Y-m-d H:i:s).
+     *                            Typically, this is a MySQL-formatted date
+     *                            string (Y-m-d H:i:s).
+     *
      * @return string Date formatted by bp_format_time().
      */
     public static function display_filter( $field_value ) {
 
-        // If Unix timestamp
+        // If Unix timestamp.
         if ( ! is_numeric( $field_value ) ) {
             $field_value = strtotime( $field_value );