Merge pull request #869 from alleyinteractive/docs/issue-867/update-constructor-docblocks-for-label-parameter

Issue-867: Update class constructor docblocks to support specifying an `array` or a `string` for `$label`

Author: mogmarsh

php/class-fieldmanager-autocomplete.php

@@ -65,8 +65,8 @@ class Fieldmanager_Autocomplete extends Fieldmanager_Field {
 	 *
 	 * @throws FM_Developer_Exception Must use a datasource.
 	 *
-	 * @param string $label   The label.
-	 * @param array  $options The options for the field.
+	 * @param string|array $label   The field label. A provided string sets $options['label'], while an array sets $options, overriding any existing data in $options.
+	 * @param array        $options The field options.
 	 */
 	public function __construct( $label = '', $options = array() ) {
 		$this->attributes = array(

php/class-fieldmanager-colorpicker.php

@@ -32,8 +32,8 @@ class Fieldmanager_Colorpicker extends Fieldmanager_Field {
 	/**
 	 * Build the colorpicker object and enqueue assets.
 	 *
-	 * @param string $label   The label to use.
-	 * @param array  $options The options.
+	 * @param string|array $label   The field label. A provided string sets $options['label'], while an array sets $options, overriding any existing data in $options.
+	 * @param array        $options The field options.
 	 */
 	public function __construct( $label = '', $options = array() ) {
 		fm_add_script( 'fm_colorpicker', 'js/fieldmanager-colorpicker.js', array( 'fm_loader', 'jquery', 'wp-color-picker' ), FM_VERSION, true );

php/class-fieldmanager-datepicker.php

@@ -65,8 +65,8 @@ class Fieldmanager_Datepicker extends Fieldmanager_Field {
 	/**
 	 * Construct default attributes and enqueue JavaScript.
 	 *
-	 * @param string $label   Field label.
-	 * @param array  $options Associative array of class property values. @see Fieldmanager_Field::__construct().
+	 * @param string|array $label   The field label. A provided string sets $options['label'], while an array sets $options, overriding any existing data in $options.
+	 * @param array        $options The field options.
 	 */
 	public function __construct( $label = '', $options = array() ) {
 		fm_add_style( 'fm-jquery-ui', 'css/jquery-ui/jquery-ui-1.10.2.custom.min.css' );

php/class-fieldmanager-draggablepost.php

@@ -47,8 +47,8 @@ class Fieldmanager_DraggablePost extends Fieldmanager_Field {
 	/**
 	 * Add scripts and styles and other setup tasks.
 	 *
-	 * @param string $label   The label.
-	 * @param array  $options The field options.
+	 * @param string|array $label   The field label. A provided string sets $options['label'], while an array sets $options, overriding any existing data in $options.
+	 * @param array        $options The field options.
 	 */
 	public function __construct( $label = '', $options = array() ) {
 		_deprecated_function( __METHOD__, '1.2.0' );

php/class-fieldmanager-field.php

@@ -401,8 +401,8 @@ public function form_element( $value ) {
 	 * Superclass constructor, just populates options and sanity-checks common elements.
 	 * It might also die, but only helpfully, to catch errors in development.
 	 *
-	 * @param string $label   Title of form field.
-	 * @param array  $options With keys matching vars of the field in use.
+	 * @param string|array $label   The field label.
+	 * @param array        $options The field options.
 	 */
 	public function __construct( $label = '', $options = array() ) {
 		$this->set_options( $label, $options );
@@ -429,8 +429,8 @@ public function __construct( $label = '', $options = array() ) {
 	 * @throws FM_Developer_Exception If an option is set but not defined in this class or the child class.
 	 * @throws FM_Developer_Exception If an option is set but not public.
 	 *
-	 * @param string $label   Title of form field.
-	 * @param array  $options With keys matching vars of the field in use.
+	 * @param string|array $label   The field label. A provided string sets $options['label'], while an array sets $options, overriding any existing data in $options.
+	 * @param array        $options The field options.
 	 */
 	public function set_options( $label, $options ) {
 		if ( is_array( $label ) ) {

php/class-fieldmanager-grid.php

@@ -39,8 +39,8 @@ class Fieldmanager_Grid extends Fieldmanager_Field {
 	/**
 	 * Constructor which adds several scrips and CSS.
 	 *
-	 * @param string $label   The form label.
-	 * @param array  $options The form options.
+	 * @param string|array $label   The field label. A provided string sets $options['label'], while an array sets $options, overriding any existing data in $options.
+	 * @param array        $options The field options.
 	 */
 	public function __construct( $label = '', $options = array() ) {
 		_deprecated_function( __METHOD__, '1.4.0' );

php/class-fieldmanager-group.php

@@ -139,8 +139,8 @@ class Fieldmanager_Group extends Fieldmanager_Field {
 	 *
 	 * @throws FM_Developer_Exception Not serializing data with repeatable groups.
 	 *
-	 * @param string $label   The form label.
-	 * @param array  $options The form options.
+	 * @param string|array $label   The field label. A provided string sets $options['label'], while an array sets $options, overriding any existing data in $options.
+	 * @param array        $options The field options.
 	 */
 	public function __construct( $label = '', $options = array() ) {
 

php/class-fieldmanager-link.php

@@ -13,8 +13,8 @@ class Fieldmanager_Link extends Fieldmanager_Textfield {
 	/**
 	 * Construct default attributes, set link sanitizer.
 	 *
-	 * @param string $label   The form label.
-	 * @param array  $options The form options.
+	 * @param string|array $label   The field label. A provided string sets $options['label'], while an array sets $options, overriding any existing data in $options.
+	 * @param array        $options The field options.
 	 */
 	public function __construct( $label = '', $options = array() ) {
 		$this->sanitize = 'esc_url_raw';

php/class-fieldmanager-media.php

@@ -95,8 +95,8 @@ class Fieldmanager_Media extends Fieldmanager_Field {
 	/**
 	 * Construct default attributes.
 	 *
-	 * @param string $label   The form label.
-	 * @param array  $options The form options.
+	 * @param string|array $label   The field label. A provided string sets $options['label'], while an array sets $options, overriding any existing data in $options.
+	 * @param array        $options The field options.
 	 */
 	public function __construct( $label = '', $options = array() ) {
 		$this->button_label         = __( 'Attach a File', 'fieldmanager' );

php/class-fieldmanager-options.php

@@ -64,8 +64,8 @@ abstract class Fieldmanager_Options extends Fieldmanager_Field {
 	/**
 	 * Add CSS, construct parent.
 	 *
-	 * @param string $label   The form label.
-	 * @param mixed  $options The form options.
+	 * @param string|array $label   The field label. A provided string sets $options['label'], while an array sets $options, overriding any existing data in $options.
+	 * @param array        $options The field options.
 	 */
 	public function __construct( $label = '', $options = array() ) {
 		$this->sanitize = array( $this, 'sanitize' );