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 +15 added lines, -15 removed lines

@@ -119,7 +119,7 @@ 
 
 		if ( $this->cmb->has_columns ) {
 			add_filter( 'manage_edit-comments_columns', array( $this, 'register_column_headers' ) );
-			add_action( 'manage_comments_custom_column', array( $this, 'column_display'  ), 10, 3 );
+			add_action( 'manage_comments_custom_column', array( $this, 'column_display' ), 10, 3 );
 		}
 	}
 
@@ -136,7 +136,7 @@ 
 
 		if ( $this->cmb->has_columns ) {
 			add_filter( 'manage_users_columns', array( $this, 'register_column_headers' ) );
-			add_filter( 'manage_users_custom_column', array( $this, 'return_column_display'  ), 10, 3 );
+			add_filter( 'manage_users_custom_column', array( $this, 'return_column_display' ), 10, 3 );
 		}
 	}
 
@@ -170,7 +170,7 @@ 
 
 			if ( $this->cmb->has_columns ) {
 				add_filter( "manage_edit-{$taxonomy}_columns", array( $this, 'register_column_headers' ) );
-				add_filter( "manage_{$taxonomy}_custom_column", array( $this, 'return_column_display'  ), 10, 3 );
+				add_filter( "manage_{$taxonomy}_custom_column", array( $this, 'return_column_display' ), 10, 3 );
 			}
 		}
 
@@ -263,25 +263,25 @@ 
 		$fields = $this->cmb->prop( 'fields' );
 
 		foreach ( $fields as $key => $field ) {
-			if ( ! isset( $field['column'] ) ) {
+			if ( ! isset( $field[ 'column' ] ) ) {
 				continue;
 			}
 
-			$column = $field['column'];
+			$column = $field[ 'column' ];
 
-			if ( false === $column['position'] ) {
+			if ( false === $column[ 'position' ] ) {
 
-				$columns[ $field['id'] ] = $column['name'];
+				$columns[ $field[ 'id' ] ] = $column[ 'name' ];
 
 			} else {
 
-				$before = array_slice( $columns, 0, absint( $column['position'] ) );
-				$before[ $field['id'] ] = $column['name'];
+				$before = array_slice( $columns, 0, absint( $column[ 'position' ] ) );
+				$before[ $field[ 'id' ] ] = $column[ 'name' ];
 				$columns = $before + $columns;
 			}
 
-			$column['field'] = $field;
-			$this->columns[ $field['id'] ] = $column;
+			$column[ 'field' ] = $field;
+			$this->columns[ $field[ 'id' ] ] = $column;
 		}
 
 		return $columns;
@@ -294,7 +294,7 @@ 
 	public function column_display( $column_name, $object_id ) {
 		if ( isset( $this->columns[ $column_name ] ) ) {
  			$field = new CMB2_Field( array(
-				'field_args'  => $this->columns[ $column_name ]['field'],
+				'field_args'  => $this->columns[ $column_name ][ 'field' ],
 				'object_type' => $this->object_type,
 				'object_id'   => $this->cmb->object_id( $object_id ),
 				'cmb_id'      => $this->cmb->cmb_id,
@@ -355,7 +355,7 @@ 
 	 * @return array           Modified array of classes
 	 */
 	public function close_metabox_class( $classes ) {
-		$classes[] = 'closed';
+		$classes[ ] = 'closed';
 		return $classes;
 	}
 
@@ -375,7 +375,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();
 		}
 	}
@@ -555,7 +555,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;
 				}
 			}

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'

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 );

includes/CMB2_REST_Controller.php

Doc Comments +4 added lines, -2 removed lines

@@ -94,7 +94,6 @@ 
 	 *
 	 * @since 2.2.0
 	 *
-	 * @param  mixed $data
 	 * @return array $data
 	 */
 	public function prepare_item( $post ) {
@@ -107,7 +106,7 @@ 
 	 * @since  2.2.0
 	 *
 	 * @param  mixed $cb Callable function/method.
-	 * @return mixed     Results of output buffer after calling function/method.
+	 * @return string     Results of output buffer after calling function/method.
 	 */
 	public function get_cb_results( $cb ) {
 		$args = func_get_args();
@@ -142,6 +141,9 @@ 
 		return apply_filters( 'cmb2_rest_prepare', rest_ensure_response( $data ), $this->request, $this );
 	}
 
+	/**
+	 * @param string $request_type
+	 */
 	protected function initiate_rest_read_box( $request, $request_type ) {
 		$this->initiate_rest_box( $request, $request_type );
 

Spacing +7 added lines, -7 removed lines

@@ -128,7 +128,7 @@ 
 	 * @return array $data
 	 */
 	public function prepare_item_for_response( $data, $request = null ) {
-		$data = $this->filter_response_by_context( $data, $this->request['context'] );
+		$data = $this->filter_response_by_context( $data, $this->request[ 'context' ] );
 
 		/**
 		 * Filter the prepared CMB2 item response.
@@ -170,16 +170,16 @@ 
 
 	public function initiate_request( $request, $request_type ) {
 		$this->request = $request;
-		$this->request['context'] = isset( $this->request['context'] ) && ! empty( $this->request['context'] )
-			? $this->request['context']
+		$this->request[ 'context' ] = isset( $this->request[ 'context' ] ) && ! empty( $this->request[ 'context' ] )
+			? $this->request[ 'context' ]
 			: 'view';
 
-		if ( isset( $_REQUEST['object_id'] ) ) {
-			$this->object_id = absint( $_REQUEST['object_id'] );
+		if ( isset( $_REQUEST[ 'object_id' ] ) ) {
+			$this->object_id = absint( $_REQUEST[ 'object_id' ] );
 		}
 
-		if ( isset( $_REQUEST['object_type'] ) ) {
-			$this->object_type = absint( $_REQUEST['object_type'] );
+		if ( isset( $_REQUEST[ 'object_type' ] ) ) {
+			$this->object_type = absint( $_REQUEST[ 'object_type' ] );
 		}
 
 		self::$request_type = self::$request_type ? self::$request_type : $request_type;