WebDevStudios / CMB2

includes/helper-functions.php

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
 	 */

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.
 	 */

includes/types/CMB2_Type_Text_Datetime_Timestamp.php

Doc Comments +6 added lines

@@ -39,6 +39,9 @@ 
 		return $this->rendered( $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',
@@ -54,6 +57,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',

includes/CMB2_Base.php

Doc Comments +1 added lines, -1 removed lines

@@ -171,7 +171,7 @@
 	 *
 	 * @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/CMB2_Field.php

Doc Comments +2 added lines, -2 removed lines

@@ -751,7 +751,7 @@ 
 	 *
 	 * @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 ) {
@@ -1032,7 +1032,7 @@ 
 	 *
 	 * @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_hookup.php

Doc Comments +2 added lines, -2 removed lines

@@ -484,7 +484,7 @@ 
 	 *
 	 * @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 ) ) {
@@ -505,7 +505,7 @@ 
 	 *
 	 * @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/CMB2_Sanitize.php

Doc Comments +3 added lines

@@ -433,6 +433,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;
@@ -460,6 +461,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 );
@@ -481,6 +483,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/CMB2_Types.php

Doc Comments +1 added lines, -1 removed lines

@@ -239,7 +239,7 @@
 	 * @param  string $fieldtype         The type of field being rendered.
 	 * @param  string $render_class_name The default field type class to use. Defaults to null.
 	 * @param  array  $args              Optional arguments to pass to type class.
-	 * @param  mixed  $additional        Optional additional argument to pass to type class.
+	 * @param  string  $additional        Optional additional argument to pass to type class.
 	 * @return CMB2_Type_Base                    Type object.
 	 */
 	public function get_new_render_type( $fieldtype, $render_class_name = null, $args = array(), $additional = '' ) {

includes/rest-api/CMB2_REST.php

Doc Comments +2 added lines, -1 removed lines

@@ -208,6 +208,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
 	 */
@@ -706,7 +707,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;