WebDevStudios / CMB2

includes/CMB2_Ajax.php

Doc Comments +1 added lines, -2 removed lines

@@ -30,7 +30,7 @@ 
 	/**
 	 * Get the singleton instance of this class
 	 * @since 2.2.2
-	 * @return object
+	 * @return CMB2_Ajax
 	 */
 	public static function get_instance() {
 		if ( ! ( self::$instance instanceof self ) ) {
@@ -221,7 +221,6 @@ 
 	 *
 	 * @since  1.3.0
 	 * @param  string  $meta_key   Postmeta's key
-	 * @param  mixed   $meta_value (Optional) value of the postmeta to be saved
 	 */
 	protected function cache_action( $meta_key ) {
 		$func_args = func_get_args();

Spacing +20 added lines, -20 removed lines

@@ -59,12 +59,12 @@ 
 	public function oembed_handler() {
 
 		// Verify our nonce
-		if ( ! ( isset( $_REQUEST['cmb2_ajax_nonce'], $_REQUEST['oembed_url'] ) && wp_verify_nonce( $_REQUEST['cmb2_ajax_nonce'], 'ajax_nonce' ) ) ) {
+		if ( ! ( isset( $_REQUEST[ 'cmb2_ajax_nonce' ], $_REQUEST[ 'oembed_url' ] ) && wp_verify_nonce( $_REQUEST[ 'cmb2_ajax_nonce' ], 'ajax_nonce' ) ) ) {
 			die();
 		}
 
 		// Sanitize our search string
-		$oembed_string = sanitize_text_field( $_REQUEST['oembed_url'] );
+		$oembed_string = sanitize_text_field( $_REQUEST[ 'oembed_url' ] );
 
 		// Send back error if empty
 		if ( empty( $oembed_string ) ) {
@@ -72,7 +72,7 @@ 
 		}
 
 		// Set width of embed
-		$embed_width = isset( $_REQUEST['oembed_width'] ) && intval( $_REQUEST['oembed_width'] ) < 640 ? intval( $_REQUEST['oembed_width'] ) : '640';
+		$embed_width = isset( $_REQUEST[ 'oembed_width' ] ) && intval( $_REQUEST[ 'oembed_width' ] ) < 640 ? intval( $_REQUEST[ 'oembed_width' ] ) : '640';
 
 		// Set url
 		$oembed_url = esc_url( $oembed_string );
@@ -85,10 +85,10 @@ 
 		// Get embed code (or fallback link)
 		$html = $this->get_oembed( array(
 			'url'         => $oembed_url,
-			'object_id'   => $_REQUEST['object_id'],
-			'object_type' => isset( $_REQUEST['object_type'] ) ? $_REQUEST['object_type'] : 'post',
+			'object_id'   => $_REQUEST[ 'object_id' ],
+			'object_type' => isset( $_REQUEST[ 'object_type' ] ) ? $_REQUEST[ 'object_type' ] : 'post',
 			'oembed_args' => $embed_args,
-			'field_id'    => $_REQUEST['field_id'],
+			'field_id'    => $_REQUEST[ 'field_id' ],
 		) );
 
 		wp_send_json_success( $html );
@@ -103,10 +103,10 @@ 
 	public function get_oembed_no_edit( $args ) {
 		global $wp_embed;
 
-		$oembed_url = esc_url( $args['url'] );
+		$oembed_url = esc_url( $args[ 'url' ] );
 
 		// Sanitize object_id
-		$this->object_id = is_numeric( $args['object_id'] ) ? absint( $args['object_id'] ) : sanitize_text_field( $args['object_id'] );
+		$this->object_id = is_numeric( $args[ 'object_id' ] ) ? absint( $args[ 'object_id' ] ) : sanitize_text_field( $args[ 'object_id' ] );
 
 		$args = wp_parse_args( $args, array(
 			'object_type' => 'post',
@@ -115,7 +115,7 @@ 
 			'wp_error'    => false,
 		) );
 
-		$this->embed_args =& $args;
+		$this->embed_args = & $args;
 
 		/**
 		 * Set the post_ID so oEmbed won't fail
@@ -124,9 +124,9 @@ 
 		$wp_embed->post_ID = $this->object_id;
 
 		// Special scenario if NOT a post object
-		if ( isset( $args['object_type'] ) && 'post' != $args['object_type'] ) {
+		if ( isset( $args[ 'object_type' ] ) && 'post' != $args[ 'object_type' ] ) {
 
-			if ( 'options-page' == $args['object_type'] ) {
+			if ( 'options-page' == $args[ 'object_type' ] ) {
 
 				// Bogus id to pass some numeric checks. Issue with a VERY large WP install?
 				$wp_embed->post_ID = 1987645321;
@@ -134,7 +134,7 @@ 
 
 			// Ok, we need to hijack the oembed cache system
 			$this->hijack = true;
-			$this->object_type = $args['object_type'];
+			$this->object_type = $args[ 'object_type' ];
 
 			// Gets ombed cache from our object's meta (vs postmeta)
 			add_filter( 'get_post_metadata', array( $this, 'hijack_oembed_cache_get' ), 10, 3 );
@@ -146,7 +146,7 @@ 
 
 		$embed_args = '';
 
-		foreach ( $args['oembed_args'] as $key => $val ) {
+		foreach ( $args[ 'oembed_args' ] as $key => $val ) {
 			$embed_args .= " $key=\"$val\"";
 		}
 
@@ -169,12 +169,12 @@ 
 		$oembed = $this->get_oembed_no_edit( $args );
 
 		// Send back our embed
-		if ( $oembed['embed'] && $oembed['embed'] != $oembed['fallback'] ) {
-			return '<div class="cmb2-oembed embed-status">' . $oembed['embed'] . '<p class="cmb2-remove-wrapper"><a href="#" class="cmb2-remove-file-button" rel="' . $oembed['args']['field_id'] . '">' . __( 'Remove Embed', 'cmb2' ) . '</a></p></div>';
+		if ( $oembed[ 'embed' ] && $oembed[ 'embed' ] != $oembed[ 'fallback' ] ) {
+			return '<div class="cmb2-oembed embed-status">' . $oembed[ 'embed' ] . '<p class="cmb2-remove-wrapper"><a href="#" class="cmb2-remove-file-button" rel="' . $oembed[ 'args' ][ 'field_id' ] . '">' . __( 'Remove Embed', 'cmb2' ) . '</a></p></div>';
 		}
 
 		// Otherwise, send back error info that no oEmbeds were found
-		return '<p class="ui-state-error-text">' . sprintf( __( 'No oEmbed Results Found for %s. View more info at', 'cmb2' ), $oembed['fallback'] ) . ' <a href="http://codex.wordpress.org/Embeds" target="_blank">codex.wordpress.org/Embeds</a>.</p>';
+		return '<p class="ui-state-error-text">' . sprintf( __( 'No oEmbed Results Found for %s. View more info at', 'cmb2' ), $oembed[ 'fallback' ] ) . ' <a href="http://codex.wordpress.org/Embeds" target="_blank">codex.wordpress.org/Embeds</a>.</p>';
 	}
 
 	/**
@@ -236,15 +236,15 @@ 
 	 */
 	protected function cache_action( $meta_key ) {
 		$func_args = func_get_args();
-		$action    = isset( $func_args[1] ) ? 'update' : 'get';
+		$action    = isset( $func_args[ 1 ] ) ? 'update' : 'get';
 
 		if ( 'options-page' === $this->object_type ) {
 
 			$args = array( $meta_key );
 
 			if ( 'update' === $action ) {
-				$args[] = $func_args[1];
-				$args[] = true;
+				$args[ ] = $func_args[ 1 ];
+				$args[ ] = true;
 			}
 
 			// Cache the result to our options
@@ -252,7 +252,7 @@ 
 		} else {
 
 			$args = array( $this->object_type, $this->object_id, $meta_key );
-			$args[] = 'update' === $action ? $func_args : true;
+			$args[ ] = 'update' === $action ? $func_args : true;
 
 			// Cache the result to our metadata
 			$status = call_user_func_array( $action . '_metadata', $args );

includes/types/CMB2_Type_Base.php

Doc Comments +1 added lines, -2 removed lines

@@ -84,7 +84,6 @@ 
 
 	/**
 	 * Fall back to CMB2_Types methods
-	 * @param string $field
 	 * @throws Exception Throws an exception if the field is invalid.
 	 * @return mixed
 	 */
@@ -105,7 +104,7 @@ 
 	 * Magic getter for our object.
 	 * @param string $field
 	 * @throws Exception Throws an exception if the field is invalid.
-	 * @return mixed
+	 * @return CMB2_Field
 	 */
 	public function __get( $field ) {
 		switch ( $field ) {

Spacing +2 added lines, -2 removed lines

@@ -38,7 +38,7 @@ 
 	 */
 	public function __construct( CMB2_Types $types, $args = array() ) {
 		$this->types = $types;
-		$args['rendered'] = isset( $args['rendered'] ) ? (bool) $args['rendered'] : true;
+		$args[ 'rendered' ] = isset( $args[ 'rendered' ] ) ? (bool) $args[ 'rendered' ] : true;
 		$this->args = $args;
 	}
 
@@ -56,7 +56,7 @@ 
 	 * @return string|CMB2_Type_Base           Rendered output or this object.
 	 */
 	public function rendered( $rendered ) {
-		if ( $this->args['rendered'] ) {
+		if ( $this->args[ 'rendered' ] ) {
 			return is_a( $rendered, __CLASS__ ) ? $rendered->rendered : $rendered;
 		}
 

includes/types/CMB2_Type_Text_Datetime_Timestamp.php

Doc Comments +6 added lines

@@ -38,6 +38,9 @@ 
 		return $date_input . "\n" . $time_input;
 	}
 
+	/**
+	 * @param boolean $has_good_value
+	 */
 	public function date_args( $args, $has_good_value ) {
 		$date_args = wp_parse_args( $args['datepicker'], array(
 			'class' => 'cmb2-text-small cmb2-datepicker',
@@ -51,6 +54,9 @@ 
 		return $this->parse_picker_options( 'date', $date_args );
 	}
 
+	/**
+	 * @param boolean $has_good_value
+	 */
 	public function time_args( $args, $has_good_value ) {
 		$time_args = wp_parse_args( $args['timepicker'], array(
 			'class' => 'cmb2-timepicker text-time',

Spacing +11 added lines, -11 removed lines

@@ -22,16 +22,16 @@ 
 			'timepicker' => array(),
 		) );
 
-		if ( empty( $args['value'] ) ) {
-			$args['value'] = $field->escaped_value();
+		if ( empty( $args[ 'value' ] ) ) {
+			$args[ 'value' ] = $field->escaped_value();
 			// This will be used if there is a select_timezone set for this field
 			$tz_offset = $field->field_timezone_offset();
 			if ( ! empty( $tz_offset ) ) {
-				$args['value'] -= $tz_offset;
+				$args[ 'value' ] -= $tz_offset;
 			}
 		}
 
-		$has_good_value = ! empty( $args['value'] ) && ! is_array( $args['value'] );
+		$has_good_value = ! empty( $args[ 'value' ] ) && ! is_array( $args[ 'value' ] );
 
 		$date_input = parent::render( $this->date_args( $args, $has_good_value ) );
 		$time_input = parent::render( $this->time_args( $args, $has_good_value ) );
@@ -40,31 +40,31 @@ 
 	}
 
 	public function date_args( $args, $has_good_value ) {
-		$date_args = wp_parse_args( $args['datepicker'], array(
+		$date_args = wp_parse_args( $args[ 'datepicker' ], array(
 			'class' => 'cmb2-text-small cmb2-datepicker',
 			'name'  => $this->_name( '[date]' ),
 			'id'    => $this->_id( '_date' ),
-			'value' => $has_good_value ? $this->field->get_timestamp_format( 'date_format', $args['value'] ) : '',
+			'value' => $has_good_value ? $this->field->get_timestamp_format( 'date_format', $args[ 'value' ] ) : '',
 			'desc'  => '',
 		) );
 
-		$date_args['rendered'] = true;
+		$date_args[ 'rendered' ] = true;
 
 		// Let's get the date-format, and set it up as a data attr for the field.
 		return $this->parse_picker_options( 'date', $date_args );
 	}
 
 	public function time_args( $args, $has_good_value ) {
-		$time_args = wp_parse_args( $args['timepicker'], array(
+		$time_args = wp_parse_args( $args[ 'timepicker' ], array(
 			'class' => 'cmb2-timepicker text-time',
 			'name'  => $this->_name( '[time]' ),
 			'id'    => $this->_id( '_time' ),
-			'value' => $has_good_value ? $this->field->get_timestamp_format( 'time_format', $args['value'] ) : '',
-			'desc'  => $args['desc'],
+			'value' => $has_good_value ? $this->field->get_timestamp_format( 'time_format', $args[ 'value' ] ) : '',
+			'desc'  => $args[ 'desc' ],
 			'js_dependencies' => array( 'jquery-ui-core', 'jquery-ui-datepicker', 'jquery-ui-datetimepicker' ),
 		) );
 
-		$time_args['rendered'] = true;
+		$time_args[ 'rendered' ] = true;
 
 		// Let's get the time-format, and set it up as a data attr for the field.
 		return $this->parse_picker_options( 'time', $time_args );

includes/types/CMB2_Type_Wysiwyg.php

Doc Comments -1 removed lines

@@ -15,7 +15,6 @@
 	/**
 	 * Handles outputting a 'wysiwyg' element
 	 * @since  1.1.0
-	 * @param  array  $args Override arguments
 	 * @return string       Form wysiwyg element
 	 */
 	public function render() {

Spacing +2 added lines, -2 removed lines

@@ -26,7 +26,7 @@
 			'options' => $this->field->options(),
 		) );
 
-		wp_editor( $a['value'], $a['id'], $a['options'] );
-		echo $a['desc'];
+		wp_editor( $a[ 'value' ], $a[ 'id' ], $a[ 'options' ] );
+		echo $a[ 'desc' ];
 	}
 }

includes/types/CMB2_Type_Oembed.php

Spacing +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
 			'data-objecttype' => $field->object_type,
 		) )
 		. '<p class="cmb-spinner spinner" style="display:none;"></p>'
-		. '<div id="'. $this->_id( '-status' ). '" class="cmb2-media-status ui-helper-clearfix embed_wrap">' . $oembed . '</div>';
+		. '<div id="' . $this->_id( '-status' ) . '" class="cmb2-media-status ui-helper-clearfix embed_wrap">' . $oembed . '</div>';
 	}
 
 }

includes/types/CMB2_Type_File_Base.php

Spacing +9 added lines, -9 removed lines

@@ -55,11 +55,11 @@ 
 	 */
 	public function img_status_output( $args ) {
 		return sprintf( '<%1$s class="img-status">%2$s<p class="cmb2-remove-wrapper"><a href="#" class="cmb2-remove-file-button"%3$s>%4$s</a></p>%5$s</%1$s>',
-			$args['tag'],
-			$args['image'],
-			isset( $args['cached_id'] ) ? ' rel="' . $args['cached_id'] . '"' : '',
+			$args[ 'tag' ],
+			$args[ 'image' ],
+			isset( $args[ 'cached_id' ] ) ? ' rel="' . $args[ 'cached_id' ] . '"' : '',
 			esc_html( $this->_text( 'remove_image_text', __( 'Remove Image', 'cmb2' ) ) ),
-			isset( $args['id_input'] ) ? $args['id_input'] : ''
+			isset( $args[ 'id_input' ] ) ? $args[ 'id_input' ] : ''
 		);
 	}
 
@@ -71,14 +71,14 @@ 
 	 */
 	public function file_status_output( $args ) {
 		return sprintf( '<%1$s class="file-status"><span>%2$s <strong>%3$s</strong></span>&nbsp;&nbsp; (<a href="%4$s" target="_blank" rel="external">%5$s</a> / <a href="#" class="cmb2-remove-file-button"%6$s>%7$s</a>)%8$s</%1$s>',
-			$args['tag'],
+			$args[ 'tag' ],
 			esc_html( $this->_text( 'file_text', __( 'File:', 'cmb2' ) ) ),
-			cmb2_utils()->get_file_name_from_path( $args['value'] ),
-			$args['value'],
+			cmb2_utils()->get_file_name_from_path( $args[ 'value' ] ),
+			$args[ 'value' ],
 			esc_html( $this->_text( 'file_download_text', __( 'Download', 'cmb2' ) ) ),
-			isset( $args['cached_id'] ) ? ' rel="' . $args['cached_id'] . '"' : '',
+			isset( $args[ 'cached_id' ] ) ? ' rel="' . $args[ 'cached_id' ] . '"' : '',
 			esc_html( $this->_text( 'remove_text', __( 'Remove', 'cmb2' ) ) ),
-			isset( $args['id_input'] ) ? $args['id_input'] : ''
+			isset( $args[ 'id_input' ] ) ? $args[ 'id_input' ] : ''
 		);
 	}
 

includes/types/CMB2_Type_Select_Timezone.php

Spacing +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
 
 	public function render() {
 
-		$this->field->args['default'] = $this->field->get_default()
+		$this->field->args[ 'default' ] = $this->field->get_default()
 			? $this->field->get_default()
 			: cmb2_utils()->timezone_string();
 

includes/types/CMB2_Type_Taxonomy_Multicheck.php

Spacing +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
 				);
 
 				if ( is_array( $saved_terms ) && in_array( $term->slug, $saved_terms ) ) {
-					$args['checked'] = 'checked';
+					$args[ 'checked' ] = 'checked';
 				}
 				$options .= $this->types->list_input( $args, $i );
 				$i++;

includes/types/CMB2_Type_Taxonomy_Radio.php

Spacing +4 added lines, -4 removed lines

@@ -16,7 +16,7 @@ 
 		$field = $this->field;
 		$names = $this->get_object_terms();
 
-		$saved_term = is_wp_error( $names ) || empty( $names ) ? $field->get_default() : $names[key( $names )]->slug;
+		$saved_term = is_wp_error( $names ) || empty( $names ) ? $field->get_default() : $names[ key( $names ) ]->slug;
 		$terms      = get_terms( $field->args( 'taxonomy' ), 'hide_empty=0' );
 		$options    = '';
 		$i = 1;
@@ -24,7 +24,7 @@ 
 		if ( ! $terms ) {
 			$options .= sprintf( '<li><label>%s</label></li>', esc_html( $this->types->_text( 'no_terms_text', __( 'No terms', 'cmb2' ) ) ) );
 		} else {
-			$option_none  = $field->args( 'show_option_none' );
+			$option_none = $field->args( 'show_option_none' );
 			if ( ! empty( $option_none ) ) {
 
 				$field_id = $this->_id();
@@ -54,7 +54,7 @@ 
 					'label' => $option_none,
 				);
 				if ( $saved_term == $option_none_value ) {
-					$args['checked'] = 'checked';
+					$args[ 'checked' ] = 'checked';
 				}
 				$options .= $this->list_input( $args, $i );
 				$i++;
@@ -67,7 +67,7 @@ 
 				);
 
 				if ( $saved_term == $term->slug ) {
-					$args['checked'] = 'checked';
+					$args[ 'checked' ] = 'checked';
 				}
 				$options .= $this->list_input( $args, $i );
 				$i++;