WebDevStudios / CMB2

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

includes/types/CMB2_Type_Textarea_Code.php

Doc Comments -1 removed lines

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

includes/CMB2_Field.php

Doc Comments +2 added lines, -2 removed lines

@@ -735,7 +735,7 @@ 
 	 * Return a formatted timestamp for a field
 	 * @since  2.0.0
 	 * @param  string $format     Either date_format or time_format
-	 * @param  string $meta_value Optional meta value to check
+	 * @param  integer $meta_value Optional meta value to check
 	 * @return string             Formatted date
 	 */
 	public function get_timestamp_format( $format = 'date_format', $meta_value = 0 ) {
@@ -1007,7 +1007,7 @@ 
 	 * Retrieve options args. Calls options_cb if it exists.
 	 * @since  2.0.0
 	 * @param  string  $key Specific option to retrieve
-	 * @return array        Array of options
+	 * @return string        Array of options
 	 */
 	public function options( $key = '' ) {
 		if ( ! empty( $this->field_options ) ) {

includes/CMB2_Base.php

Braces +2 added lines, -4 removed lines

@@ -370,15 +370,13 @@
 			if ( function_exists( '__' ) ) {
 				if ( ! is_null( $message ) ) {
 					trigger_error( sprintf( __( '%1$s was called with a parameter that is <strong>deprecated</strong> since version %2$s! %3$s', 'cmb2' ), $function, $version, $message ) );
-				}
-				else {
+				} else {
 					trigger_error( sprintf( __( '%1$s was called with a parameter that is <strong>deprecated</strong> since version %2$s with no alternative available.', 'cmb2' ), $function, $version ) );
 				}
 			} else {
 				if ( ! is_null( $message ) ) {
 					trigger_error( sprintf( '%1$s was called with a parameter that is <strong>deprecated</strong> since version %2$s! %3$s', $function, $version, $message ) );
-				}
-				else {
+				} else {
 					trigger_error( sprintf( '%1$s was called with a parameter that is <strong>deprecated</strong> since version %2$s with no alternative available.', $function, $version ) );
 				}
 			}

Doc Comments +1 added lines, -1 removed lines

@@ -159,7 +159,7 @@
 	 * Get object property and optionally set a fallback
 	 * @since  2.0.0
 	 * @param  string $property Metabox config property to retrieve
-	 * @param  mixed  $fallback Fallback value to set if no value found
+	 * @param  boolean|null  $fallback Fallback value to set if no value found
 	 * @return mixed            Metabox config property value or false
 	 */
 	public function prop( $property, $fallback = null ) {

includes/rest-api/CMB2_REST_Controller.php

Doc Comments +1 added lines, -2 removed lines

@@ -198,7 +198,7 @@ 
 	 * @since  2.2.3
 	 *
 	 * @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();
@@ -214,7 +214,6 @@ 
 	 *
 	 * @since 2.2.3
 	 *
-	 * @param  mixed            $item     WordPress representation of the item.
 	 * @param  WP_REST_Request  $request  Request object.
 	 * @return WP_REST_Response $response
 	 */

includes/rest-api/CMB2_REST.php

Doc Comments +2 added lines, -1 removed lines

@@ -202,6 +202,7 @@ 
 	 * @param string|array $object_types Object(s) the field is being registered
 	 *                                   to, "post"|"term"|"comment" etc.
 	 * @param string $object_types       Canonical object type for callbacks.
+	 * @param string $object_type
 	 *
 	 * @return void
 	 */
@@ -701,7 +702,7 @@ 
 	 * Retrieve all CMB2_REST instances from the registry.
 	 *
 	 * @since  2.2.3
-	 * @return CMB2[] Array of all registered CMB2_REST instances.
+	 * @return CMB2_REST[] Array of all registered CMB2_REST instances.
 	 */
 	public static function get_all() {
 		return self::$boxes;

includes/CMB2_hookup.php

Doc Comments +2 added lines, -2 removed lines

@@ -465,7 +465,7 @@ 
 	 * Modify metabox postbox classes.
 	 * @since  2.2.4
 	 * @param  array  $classes Array of classes
-	 * @return array           Modified array of classes
+	 * @return string[]           Modified array of classes
 	 */
 	public function postbox_classes( $classes ) {
 		if ( $this->cmb->prop( 'closed' ) && ! in_array( 'closed', $classes ) ) {
@@ -485,7 +485,7 @@ 
 	 * Modify metabox altnernate context postbox classes.
 	 * @since  2.2.4
 	 * @param  array  $classes Array of classes
-	 * @return array           Modified array of classes
+	 * @return string[]           Modified array of classes
 	 */
 	protected function alternate_context_postbox_classes( $classes ) {
 		$classes[] = 'context-box';

includes/types/CMB2_Type_Base.php

Doc Comments +2 added lines, -3 removed lines

@@ -52,7 +52,7 @@ 
 	/**
 	 * Stores the rendered field output.
 	 * @since  2.2.2
-	 * @param  string|CMB2_Type_Base $rendered Rendered output.
+	 * @param  string $rendered Rendered output.
 	 * @return string|CMB2_Type_Base           Rendered output or this object.
 	 */
 	public function rendered( $rendered ) {
@@ -107,7 +107,6 @@ 
 
 	/**
 	 * Fall back to CMB2_Types methods
-	 * @param string $field
 	 * @throws Exception Throws an exception if the field is invalid.
 	 * @return mixed
 	 */
@@ -128,7 +127,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 ) {

includes/CMB2_Utils.php

Doc Comments +1 added lines, -1 removed lines

@@ -547,7 +547,7 @@
 	 * @since  2.2.3
 	 *
 	 * @param  mixed $value   Value to ensure is array.
-	 * @param  array $default Default array. Defaults to empty array.
+	 * @param  string[] $default Default array. Defaults to empty array.
 	 *
 	 * @return array          The array.
 	 */

Braces +3 added lines, -2 removed lines

@@ -122,7 +122,8 @@ 
 			$tzstring = '';
 		}
 
-		if ( empty( $tzstring ) ) { // Create a UTC+- zone if no timezone string exists
+		if ( empty( $tzstring ) ) {
+// Create a UTC+- zone if no timezone string exists
 			if ( 0 == $current_offset ) {
 				$tzstring = 'UTC+0';
 			} elseif ( $current_offset < 0 ) {
@@ -179,7 +180,7 @@ 
 	 * @param  mixed $value Value to check
 	 * @return bool         True or false
 	 */
-	public static function notempty( $value ){
+	public static function notempty( $value ) {
 		return null !== $value && '' !== $value && false !== $value && array() !== $value;
 	}