Changeset 10434 for trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php

Timestamp:

01/03/2016 06:14:41 AM (11 years ago)

Author:

tw2113

Message:

More cleanup and new phpdocs for functions or methods in the XProfile component.

See #6406.

File:

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

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

@@ -11 +11 @@
 defined( 'ABSPATH' ) || exit;
 
+/**
+ * Class to help set up XProfile fields.
+ */
 class BP_XProfile_Field {
 
@@ -17 +20 @@
          *
          * @since 1.0.0
-         *
          * @var int ID of field.
          */
@@ -26 +28 @@
          *
          * @since 1.0.0
-         *
          * @var int Field group ID for field.
          */
@@ -35 +36 @@
          *
          * @since 1.0.0
-         *
          * @var int Parent ID of field.
          */
@@ -44 +44 @@
          *
          * @since 1.0.0
-         *
          * @var string Field type.
          */
@@ -53 +52 @@
          *
          * @since 1.0.0
-         *
          * @var string Field name.
          */
@@ -62 +60 @@
          *
          * @since 1.0.0
-         *
          * @var string Field description.
          */
@@ -71 +68 @@
          *
          * @since 1.0.0
-         *
          * @var bool Is field required to be filled out?
          */
@@ -80 +76 @@
          *
          * @since 1.0.0
-         *
          * @var int Can field be deleted?
          */
@@ -89 +84 @@
          *
          * @since 1.0.0
-         *
          * @var int Field position.
          */
@@ -98 +92 @@
          *
          * @since 1.0.0
-         *
          * @var int Option order.
          */
@@ -107 +100 @@
          *
          * @since 1.0.0
-         *
          * @var string Order child fields by.
          */
@@ -116 +108 @@
          *
          * @since 1.0.0
-         *
          * @var bool Is this the default option for this field?
          */
@@ -126 +117 @@
          * @since 1.9.0
          * @since 2.4.0 Property marked protected. Now accessible by magic method or by `get_default_visibility()`.
-         *
          * @var string Default field data visibility.
          */
@@ -136 +126 @@
          * @since 2.3.0
          * @since 2.4.0 Property marked protected. Now accessible by magic method or by `get_allow_custom_visibility()`.
-         *
          * @var string Members are allowed/disallowed to modify data visibility.
          */
@@ -145 +134 @@
          *
          * @since 2.0.0
-         *
          * @var BP_XProfile_Field_Type Field type object used for validation.
          */
@@ -154 +142 @@
          *
          * @since 2.0.0
-         *
          * @var BP_XProfile_ProfileData Field data for user ID.
          */
@@ -323 +310 @@
          *
          * @param boolean $delete_data Whether or not to delete data.
-         *
          * @return boolean
          */
@@ -486 +472 @@
                         do_action_ref_array( 'xprofile_field_after_save', array( $this ) );
 
-                        // Recreate type_obj in case someone changed $this->type via a filter
+                        // Recreate type_obj in case someone changed $this->type via a filter.
                         $this->type_obj            = bp_xprofile_create_field_type( $this->type );
                         $this->type_obj->field_obj = $this;
@@ -502 +488 @@
          *
          * @param int $user_id ID of the user to get field data for.
-         *
          * @return object
          */
@@ -517 +502 @@
          *
          * @param bool $for_editing Whether or not the field is for editing.
-         *
          * @return array
          */
@@ -639 +623 @@
          * @param bool  $append       Whether to append to existing member types. If false, all existing member type
          *                            associations will be deleted before adding your `$member_types`. Default false.
-         *
          * @return array Member types for the current field, after being saved.
          */
@@ -810 +793 @@
         }
 
-        /** Static Methods ********************************************************/
-
+        /* Static Methods ********************************************************/
+
+        /**
+         * Get the type for provided field ID.
+         *
+         * @param int $field_id Field ID to get type of.
+         * @return bool|null|string
+         */
         public static function get_type( $field_id = 0 ) {
                 global $wpdb;
@@ -840 +829 @@
          *
          * @param int $group_id ID of the field group to delete fields from.
-         *
          * @return boolean
          */
@@ -871 +859 @@
          *
          * @param string $field_name Name of the field to query the ID for.
-         *
          * @return boolean
          */
@@ -898 +885 @@
          * @param int|null $position       Field position to update.
          * @param int|null $field_group_id ID of the field group.
-         *
          * @return boolean
          */
@@ -934 +920 @@
          * @param string|array $member_types Member type or array of member types. Use 'any' to return unrestricted
          *                                   fields (those available for anyone, regardless of member type).
-         *
          * @return array Multi-dimensional array, with field IDs as top-level keys, and arrays of member types
          *               associated with each field as values.
@@ -1075 +1060 @@
 
         /**
-         * This function populates the items for radio buttons checkboxes and drop
-         * down boxes.
+         * Populates the items for radio buttons, checkboxes, and dropdown boxes.
          */
         public function render_admin_form_children() {
@@ -1489 +1473 @@
          *
          * @param int $field_id ID of field to check.
-         *
          * @return bool
          */