WebDevStudios / CMB2

includes/CMB2_hookup.php

Doc Comments +1 added lines, -1 removed lines

@@ -267,7 +267,7 @@
 	 * Add 'closed' class to metabox
 	 * @since  2.0.0
 	 * @param  array  $classes Array of classes
-	 * @return array           Modified array of classes
+	 * @return string[]           Modified array of classes
 	 */
 	public function close_metabox_class( $classes ) {
 		$classes[] = 'closed';

Spacing +3 added lines, -3 removed lines

@@ -257,7 +257,7 @@ 
 	 * @return array           Modified array of classes
 	 */
 	public function close_metabox_class( $classes ) {
-		$classes[] = 'closed';
+		$classes[ ] = 'closed';
 		return $classes;
 	}
 
@@ -277,7 +277,7 @@ 
 	public function user_new_metabox( $section ) {
 		if ( $section == $this->cmb->prop( 'new_user_section' ) ) {
 			$object_id = $this->cmb->object_id();
-			$this->cmb->object_id( isset( $_REQUEST['user_id'] ) ? $_REQUEST['user_id'] : $object_id );
+			$this->cmb->object_id( isset( $_REQUEST[ 'user_id' ] ) ? $_REQUEST[ 'user_id' ] : $object_id );
 			$this->user_metabox();
 		}
 	}
@@ -428,7 +428,7 @@ 
 		if ( $this->taxonomy_can_save( $taxonomy ) ) {
 
 			foreach ( $this->cmb->prop( 'fields' ) as $field ) {
-				$data_to_delete[ $field['id'] ] = '';
+				$data_to_delete[ $field[ 'id' ] ] = '';
 			}
 
 			$this->cmb->save_fields( $term_id, 'term', $data_to_delete );

includes/CMB2_Sanitize.php

Doc Comments +3 added lines

@@ -357,6 +357,7 @@ 
 	/**
 	 * Gets the values for the `file` field type from the data being saved.
 	 * @since  2.2.0
+	 * @param string $id_key
 	 */
 	public function _get_group_file_value_array( $id_key ) {
 		$alldata = $this->field->group->data_to_save;
@@ -378,6 +379,7 @@ 
 	/**
 	 * Peforms saving of `file` attachement's ID
 	 * @since  1.1.0
+	 * @param string $file_id_key
 	 */
 	public function _save_file_id_value( $file_id_key ) {
 		$id_field = $this->_new_supporting_field( $file_id_key );
@@ -398,6 +400,7 @@ 
 	/**
 	 * Peforms saving of `text_datetime_timestamp_timezone` utc timestamp
 	 * @since  2.2.0
+	 * @param string $utc_key
 	 */
 	public function _save_utc_value( $utc_key, $utc_stamp ) {
 		return $this->_new_supporting_field( $utc_key )->save_field( $utc_stamp );

Spacing +8 added lines, -8 removed lines

@@ -172,7 +172,7 @@ 
 
 		global $wp_locale;
 
-		$search = array( $wp_locale->number_format['thousands_sep'], $wp_locale->number_format['decimal_point'] );
+		$search = array( $wp_locale->number_format[ 'thousands_sep' ], $wp_locale->number_format[ 'decimal_point' ] );
 		$replace = array( '', '.' );
 
 		// for repeatable
@@ -215,8 +215,8 @@ 
 			return $repeat_value;
 		}
 
-		if ( isset( $this->value['date'], $this->value['time'] ) ) {
-			$this->value = $this->field->get_timestamp_from_value( $this->value['date'] . ' ' . $this->value['time'] );
+		if ( isset( $this->value[ 'date' ], $this->value[ 'time' ] ) ) {
+			$this->value = $this->field->get_timestamp_from_value( $this->value[ 'date' ] . ' ' . $this->value[ 'time' ] );
 		}
 
 		if ( $tz_offset = $this->field->field_timezone_offset() ) {
@@ -254,7 +254,7 @@ 
 		$tzstring = null;
 
 		if ( is_array( $this->value ) && array_key_exists( 'timezone', $this->value ) ) {
-			$tzstring = $this->value['timezone'];
+			$tzstring = $this->value[ 'timezone' ];
 		}
 
 		if ( empty( $tzstring ) ) {
@@ -274,8 +274,8 @@ 
 			$tzstring = false !== $tzstring ? $tzstring : timezone_name_from_abbr( '', 0, 0 );
 		}
 
-		$full_format = $this->field->args['date_format'] . ' ' . $this->field->args['time_format'];
-		$full_date   = $this->value['date'] . ' ' . $this->value['time'];
+		$full_format = $this->field->args[ 'date_format' ] . ' ' . $this->field->args[ 'time_format' ];
+		$full_date   = $this->value[ 'date' ] . ' ' . $this->value[ 'time' ];
 
 		try {
 
@@ -298,7 +298,7 @@ 
 			} else {
 				// Save the utc timestamp supporting field
 				if ( $repeat ) {
-					$utc_values[ $utc_key ][] = $utc_stamp;
+					$utc_values[ $utc_key ][ ] = $utc_stamp;
 				} else {
 					$this->_save_utc_value( $utc_key, $utc_stamp );
 				}
@@ -433,7 +433,7 @@ 
 			if ( $this->value ) {
 				$val = $this->$method( true );
 				if ( ! empty( $val ) ) {
-					$new_value[] = $val;
+					$new_value[ ] = $val;
 				}
 			}
 		}

includes/CMB2_JS.php

Spacing +3 added lines, -3 removed lines

@@ -51,17 +51,17 @@
 		$dependencies = apply_filters( 'cmb2_script_dependencies', self::$dependencies );
 
 		// if colorpicker
-		if ( ! is_admin() && isset( $dependencies['wp-color-picker'] ) ) {
+		if ( ! is_admin() && isset( $dependencies[ 'wp-color-picker' ] ) ) {
 			self::colorpicker_frontend();
 		}
 
 		// if file/file_list
-		if ( isset( $dependencies['media-editor'] ) ) {
+		if ( isset( $dependencies[ 'media-editor' ] ) ) {
 			wp_enqueue_media();
 		}
 
 		// if timepicker
-		if ( isset( $dependencies['jquery-ui-datetimepicker'] ) ) {
+		if ( isset( $dependencies[ 'jquery-ui-datetimepicker' ] ) ) {
 			wp_register_script( 'jquery-ui-datetimepicker', cmb2_utils()->url( 'js/jquery-ui-timepicker-addon.min.js' ), array( 'jquery-ui-slider' ), CMB2_VERSION );
 		}
 

includes/CMB2_Options.php

Spacing +1 added lines, -1 removed lines

@@ -131,7 +131,7 @@
 
 			if ( ! $single ) {
 				// If multiple, add to array
-				$this->options[ $field_id ][] = $value;
+				$this->options[ $field_id ][ ] = $value;
 			} else {
 				$this->options[ $field_id ] = $value;
 			}

includes/CMB2_Show_Filters.php

Spacing +9 added lines, -9 removed lines

@@ -27,15 +27,15 @@ 
 	 * @return mixed                show_on key or false
 	 */
 	private static function get_show_on_key( $meta_box_args ) {
-		$show_on = isset( $meta_box_args['show_on'] ) ? (array) $meta_box_args['show_on'] : false;
+		$show_on = isset( $meta_box_args[ 'show_on' ] ) ? (array) $meta_box_args[ 'show_on' ] : false;
 		if ( $show_on && is_array( $show_on ) ) {
 
 			if ( array_key_exists( 'key', $show_on ) ) {
-				return $show_on['key'];
+				return $show_on[ 'key' ];
 			}
 
 			$keys = array_keys( $show_on );
-			return $keys[0];
+			return $keys[ 0 ];
 		}
 
 		return false;
@@ -51,17 +51,17 @@ 
 	 * @return mixed                show_on value or false
 	 */
 	private static function get_show_on_value( $meta_box_args ) {
-		$show_on = isset( $meta_box_args['show_on'] ) ? (array) $meta_box_args['show_on'] : false;
+		$show_on = isset( $meta_box_args[ 'show_on' ] ) ? (array) $meta_box_args[ 'show_on' ] : false;
 
 		if ( $show_on && is_array( $show_on ) ) {
 
 			if ( array_key_exists( 'value', $show_on ) ) {
-				return $show_on['value'];
+				return $show_on[ 'value' ];
 			}
 
 			$keys = array_keys( $show_on );
 
-			return $show_on[ $keys[0] ];
+			return $show_on[ $keys[ 0 ] ];
 		}
 
 		return array();
@@ -141,7 +141,7 @@ 
 		if ( is_admin() ) {
 
 			// If there is no 'page' query var, our filter isn't applicable
-			if ( ! isset( $_GET['page'] ) ) {
+			if ( ! isset( $_GET[ 'page' ] ) ) {
 				return $display;
 			}
 
@@ -153,12 +153,12 @@ 
 
 			if ( is_array( $show_on ) ) {
 				foreach ( $show_on as $page ) {
-					if ( $_GET['page'] == $page ) {
+					if ( $_GET[ 'page' ] == $page ) {
 						return true;
 					}
 				}
 			} else {
-				if ( $_GET['page'] == $show_on ) {
+				if ( $_GET[ 'page' ] == $show_on ) {
 					return true;
 				}
 			}

includes/helper-functions.php

Spacing +19 added lines, -19 removed lines

@@ -178,7 +178,7 @@ 
 		$cmb = CMB2_Boxes::get( $meta_box );
 	} else {
 		// See if we already have an instance of this metabox
-		$cmb = CMB2_Boxes::get( $meta_box['id'] );
+		$cmb = CMB2_Boxes::get( $meta_box[ 'id' ] );
 		// If not, we'll initate a new metabox
 		$cmb = $cmb ? $cmb : new CMB2( $meta_box, $object_id );
 	}
@@ -254,7 +254,7 @@ 
 	) );
 
 	// Set object type explicitly (rather than trying to guess from context)
-	$cmb->object_type( $args['object_type'] );
+	$cmb->object_type( $args[ 'object_type' ] );
 
 	// Save the metabox if it's been submitted
 	// check permissions
@@ -262,32 +262,32 @@ 
 	if (
 		$cmb->prop( 'save_fields' )
 		// check nonce
-		&& isset( $_POST['submit-cmb'], $_POST['object_id'], $_POST[ $cmb->nonce() ] )
+		&& isset( $_POST[ 'submit-cmb' ], $_POST[ 'object_id' ], $_POST[ $cmb->nonce() ] )
 		&& wp_verify_nonce( $_POST[ $cmb->nonce() ], $cmb->nonce() )
-		&& $object_id && $_POST['object_id'] == $object_id
+		&& $object_id && $_POST[ 'object_id' ] == $object_id
 	) {
 		$cmb->save_fields( $object_id, $cmb->object_type(), $_POST );
 	}
 
 	// Enqueue JS/CSS
-	if ( $args['cmb_styles'] ) {
+	if ( $args[ 'cmb_styles' ] ) {
 		CMB2_hookup::enqueue_cmb_css();
 	}
 
-	if ( $args['enqueue_js'] ) {
+	if ( $args[ 'enqueue_js' ] ) {
 		CMB2_hookup::enqueue_cmb_js();
 	}
 
-	$form_format = apply_filters( 'cmb2_get_metabox_form_format', $args['form_format'], $object_id, $cmb );
+	$form_format = apply_filters( 'cmb2_get_metabox_form_format', $args[ 'form_format' ], $object_id, $cmb );
 
 	$format_parts = explode( '%3$s', $form_format );
 
 	// Show cmb form
-	printf( $format_parts[0], $cmb->cmb_id, $object_id );
+	printf( $format_parts[ 0 ], $cmb->cmb_id, $object_id );
 	$cmb->show_form();
 
-	if ( isset( $format_parts[1] ) && $format_parts[1] ) {
-		printf( str_ireplace( '%4$s', '%1$s', $format_parts[1] ), $args['save_button'] );
+	if ( isset( $format_parts[ 1 ] ) && $format_parts[ 1 ] ) {
+		printf( str_ireplace( '%4$s', '%1$s', $format_parts[ 1 ] ), $args[ 'save_button' ] );
 	}
 
 }
@@ -300,7 +300,7 @@ 
  * @param  array   $args      Optional arguments array
  */
 function cmb2_metabox_form( $meta_box, $object_id = 0, $args = array() ) {
-	if ( ! isset( $args['echo'] ) || $args['echo'] ) {
+	if ( ! isset( $args[ 'echo' ] ) || $args[ 'echo' ] ) {
 		cmb2_print_metabox_form( $meta_box, $object_id, $args );
 	} else {
 		return cmb2_get_metabox_form( $meta_box, $object_id, $args );
@@ -322,7 +322,7 @@ 
 
 		$schedule_format = str_replace(
 			array( 'M', 'Y', 'm', 'd', 'H', 'i', 'a' ),
-			array('%b', '%Y', '%m', '%d', '%H', '%M', '%p' ),
+			array( '%b', '%Y', '%m', '%d', '%H', '%M', '%p' ),
 			$date_format
 		);
 
@@ -339,14 +339,14 @@ 
 			 * 4 or 2 characters, as needed
 			 */
 			'%04d-%02d-%02d %02d:%02d:%02d',
-			$parsed_time['tm_year'] + 1900,  // This will be "111", so we need to add 1900.
-			$parsed_time['tm_mon'] + 1,      // This will be the month minus one, so we add one.
-			$parsed_time['tm_mday'],
-			$parsed_time['tm_hour'],
-			$parsed_time['tm_min'],
-			$parsed_time['tm_sec']
+			$parsed_time[ 'tm_year' ] + 1900, // This will be "111", so we need to add 1900.
+			$parsed_time[ 'tm_mon' ] + 1, // This will be the month minus one, so we add one.
+			$parsed_time[ 'tm_mday' ],
+			$parsed_time[ 'tm_hour' ],
+			$parsed_time[ 'tm_min' ],
+			$parsed_time[ 'tm_sec' ]
 		);
 
-		return new DateTime($ymd);
+		return new DateTime( $ymd );
 	}
 }

Doc Comments +2 added lines, -2 removed lines

@@ -317,8 +317,8 @@
 	 * Reimplementation of DateTime::createFromFormat for PHP < 5.3. :(
 	 * Borrowed from http://stackoverflow.com/questions/5399075/php-datetimecreatefromformat-in-5-2
 	 *
-	 * @param $date_format
-	 * @param $date_value
+	 * @param string $date_format
+	 * @param string $date_value
 	 *
 	 * @return DateTime
 	 */

example-functions.php

Spacing +5 added lines, -5 removed lines

@@ -78,7 +78,7 @@ 
 	$cmb_demo = new_cmb2_box( array(

 		'id'              => $prefix . 'metabox',

 		'title'           => __( 'Test Metabox', 'cmb2' ),

-		'object_types'    => array( 'page', ), // Post type

+		'object_types'    => array( 'page',), // Post type

 		// 'show_on_cb'   => 'yourprefix_show_if_front_page', // function should return a bool value

 		// 'context'      => 'normal',

 		// 'priority'     => 'high',

@@ -322,7 +322,7 @@ 
 		'desc'    => __( 'field description (optional)', 'cmb2' ),

 		'id'      => $prefix . 'wysiwyg',

 		'type'    => 'wysiwyg',

-		'options' => array( 'textarea_rows' => 5, ),

+		'options' => array( 'textarea_rows' => 5,),

 	) );

 

 	$cmb_demo->add_field( array(

@@ -374,11 +374,11 @@ 
 	$cmb_about_page = new_cmb2_box( array(

 		'id'           => $prefix . 'metabox',

 		'title'        => __( 'About Page Metabox', 'cmb2' ),

-		'object_types' => array( 'page', ), // Post type

+		'object_types' => array( 'page',), // Post type

 		'context'      => 'normal',

 		'priority'     => 'high',

 		'show_names'   => true, // Show field names on the left

-		'show_on'      => array( 'id' => array( 2, ) ), // Specific post IDs to display this metabox

+		'show_on'      => array( 'id' => array( 2,) ), // Specific post IDs to display this metabox

 	) );

 

 	$cmb_about_page->add_field( array(

@@ -403,7 +403,7 @@ 
 	$cmb_group = new_cmb2_box( array(

 		'id'           => $prefix . 'metabox',

 		'title'        => __( 'Repeating Field Group', 'cmb2' ),

-		'object_types' => array( 'page', ),

+		'object_types' => array( 'page',),

 	) );

 

 	// $group_field_id is the field id string, so in this case: $prefix . 'demo'

Braces +16 added lines, -16 removed lines

@@ -15,9 +15,9 @@ 
  * Get the bootstrap! If using the plugin from wordpress.org, REMOVE THIS!

  */

 

-if ( file_exists( dirname( __FILE__ ) . '/cmb2/init.php' ) ) {

+if ( file_exists( dirname( __FILE__ ) . '/cmb2/init.php' ) ) {
 	require_once dirname( __FILE__ ) . '/cmb2/init.php';

-} elseif ( file_exists( dirname( __FILE__ ) . '/CMB2/init.php' ) ) {

+} elseif ( file_exists( dirname( __FILE__ ) . '/CMB2/init.php' ) ) {
 	require_once dirname( __FILE__ ) . '/CMB2/init.php';

 }

 

@@ -28,9 +28,9 @@ 
  *

  * @return bool             True if metabox should show

  */

-function yourprefix_show_if_front_page( $cmb ) {

+function yourprefix_show_if_front_page( $cmb ) {
 	// Don't show this metabox if it's not the front page template

-	if ( $cmb->object_id !== get_option( 'page_on_front' ) ) {

+	if ( $cmb->object_id !== get_option( 'page_on_front' ) ) {
 		return false;

 	}

 	return true;

@@ -43,9 +43,9 @@ 
  *

  * @return bool                     True if metabox should show

  */

-function yourprefix_hide_if_no_cats( $field ) {

+function yourprefix_hide_if_no_cats( $field ) {
 	// Don't show this field if not in the cats category

-	if ( ! has_tag( 'cats', $field->object_id ) ) {

+	if ( ! has_tag( 'cats', $field->object_id ) ) {
 		return false;

 	}

 	return true;

@@ -57,7 +57,7 @@ 
  * @param  array      $field_args Array of field arguments.

  * @param  CMB2_Field $field      The field object

  */

-function yourprefix_render_row_cb( $field_args, $field ) {

+function yourprefix_render_row_cb( $field_args, $field ) {
 	$classes     = $field->row_classes();

 	$id          = $field->args( 'id' );

 	$label       = $field->args( 'name' );

@@ -79,10 +79,10 @@ 
  * @param  array             $field_args Array of field parameters

  * @param  CMB2_Field object $field      Field object

  */

-function yourprefix_before_row_if_2( $field_args, $field ) {

-	if ( 2 == $field->object_id ) {

+function yourprefix_before_row_if_2( $field_args, $field ) {
+	if ( 2 == $field->object_id ) {
 		echo '<p>Testing <b>"before_row"</b> parameter (on $post_id 2)</p>';

-	} else {

+	} else {
 		echo '<p>Testing <b>"before_row"</b> parameter (<b>NOT</b> on $post_id 2)</p>';

 	}

 }

@@ -91,7 +91,7 @@ 
 /**

  * Hook in and add a demo metabox. Can only happen on the 'cmb2_admin_init' or 'cmb2_init' hook.

  */

-function yourprefix_register_demo_metabox() {

+function yourprefix_register_demo_metabox() {
 	$prefix = 'yourprefix_demo_';

 

 	/**

@@ -395,7 +395,7 @@ 
 /**

  * Hook in and add a metabox that only appears on the 'About' page

  */

-function yourprefix_register_about_page_metabox() {

+function yourprefix_register_about_page_metabox() {
 	$prefix = 'yourprefix_about_';

 

 	/**

@@ -424,7 +424,7 @@ 
 /**

  * Hook in and add a metabox to demonstrate repeatable grouped fields

  */

-function yourprefix_register_repeatable_group_field_metabox() {

+function yourprefix_register_repeatable_group_field_metabox() {
 	$prefix = 'yourprefix_group_';

 

 	/**

@@ -488,7 +488,7 @@ 
 /**

  * Hook in and add a metabox to add fields to the user profile pages

  */

-function yourprefix_register_user_profile_metabox() {

+function yourprefix_register_user_profile_metabox() {
 	$prefix = 'yourprefix_user_';

 

 	/**

@@ -558,7 +558,7 @@ 
 /**

  * Hook in and add a metabox to add fields to taxonomy terms

  */

-function yourprefix_register_taxonomy_metabox() {

+function yourprefix_register_taxonomy_metabox() {
 	$prefix = 'yourprefix_term_';

 

 	/**

@@ -600,7 +600,7 @@ 
 /**

  * Hook in and register a metabox to handle a theme options page

  */

-function yourprefix_register_theme_options_metabox() {

+function yourprefix_register_theme_options_metabox() {
 

 	$option_key = 'yourprefix_theme_options';

 

includes/CMB2_Hookup_Base.php

Spacing +1 added lines, -1 removed lines

@@ -54,7 +54,7 @@
 			return;
 		}
 
-		self::$hooks_completed[] = $key;
+		self::$hooks_completed[ ] = $key;
 		add_filter( $action, $hook, $priority, $accepted_args );
 	}
 

includes/CMB2_REST.php

Doc Comments +4 added lines, -1 removed lines

@@ -152,7 +152,7 @@ 
 	/**
 	 * Handler for updating custom field data.
 	 * @since  2.2.0
-	 * @param  mixed    $value    The value of the field
+	 * @param  mixed    $values    The value of the field
 	 * @param  object   $object   The object from the response
 	 * @param  string   $field_id Name of field
 	 * @return bool|int
@@ -233,6 +233,9 @@ 
 		return $protected;
 	}
 
+	/**
+	 * @param string $field_id
+	 */
 	public function field_can_update( $field_id ) {
 
 		$field        = $this->cmb->get_field( $field_id );

Spacing +9 added lines, -9 removed lines

@@ -120,18 +120,18 @@ 
 
 	protected function declare_read_write_fields() {
 		foreach ( $this->cmb->prop( 'fields' ) as $field ) {
-			$show_in_rest = isset( $field['show_in_rest'] ) ? $field['show_in_rest'] : null;
+			$show_in_rest = isset( $field[ 'show_in_rest' ] ) ? $field[ 'show_in_rest' ] : null;
 
 			if ( false === $show_in_rest ) {
 				continue;
 			}
 
 			if ( $this->can_read( $show_in_rest ) ) {
-				$this->read_fields[] = $field['id'];
+				$this->read_fields[ ] = $field[ 'id' ];
 			}
 
 			if ( $this->can_write( $show_in_rest ) ) {
-				$this->write_fields[] = $field['id'];
+				$this->write_fields[ ] = $field[ 'id' ];
 			}
 
 		}
@@ -159,14 +159,14 @@ 
 	 */
 	public static function get_restable_field_values( $object, $field_id, $request ) {
 		$values = array();
-		if ( ! isset( $object['id'] ) ) {
+		if ( ! isset( $object[ 'id' ] ) ) {
 			return;
 		}
 
 		foreach ( self::$boxes as $cmb_id => $rest_box ) {
 			foreach ( $rest_box->read_fields as $field_id ) {
 				$field = $rest_box->cmb->get_field( $field_id );
-				$field->object_id = $object['id'];
+				$field->object_id = $object[ 'id' ];
 
 				// TODO: test other object types (users, comments, etc)
 				if ( isset( $object->type ) ) {
@@ -205,8 +205,8 @@ 
 				continue;
 			}
 
-			$rest_box->cmb->object_id( $data['object_id'] );
-			$rest_box->cmb->object_type( $data['object_type'] );
+			$rest_box->cmb->object_id( $data[ 'object_id' ] );
+			$rest_box->cmb->object_type( $data[ 'object_type' ] );
 
 			// TODO: Test since refactor.
 			$updated[ $cmb_id ] = $rest_box->sanitize_box_values( $values );
@@ -304,8 +304,8 @@ 
 		} elseif ( isset( $object->comment_ID ) ) {
 			$object_id   = intval( $object->comment_ID );
 			$object_type = 'comment';
-		} elseif ( is_array( $object ) && isset( $object['term_id'] ) ) {
-			$object_id   = intval( $object['term_id'] );
+		} elseif ( is_array( $object ) && isset( $object[ 'term_id' ] ) ) {
+			$object_id   = intval( $object[ 'term_id' ] );
 			$object_type = 'term';
 		} elseif ( isset( $object->term_id ) ) {
 			$object_id   = intval( $object->term_id );