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

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

includes/CMB2.php

Doc Comments +3 added lines, -3 removed lines

@@ -620,7 +620,7 @@ 
 	/**
 	 * Save a repeatable group
 	 * @since  1.x.x
-	 * @param  array $field_group CMB2_Field group field object
+	 * @param  CMB2_Field $field_group CMB2_Field group field object
 	 * @return mixed              Return of CMB2_Field::update_data()
 	 */
 	public function save_group_field( $field_group ) {
@@ -910,7 +910,7 @@ 
 	 * @param  mixed  $field_id     Field (or group field) ID
 	 * @param  mixed  $field_args   Array of field arguments
 	 * @param  mixed  $sub_field_id Sub field ID (if field_group exists)
-	 * @param  mixed  $field_group  If a sub-field, will be the parent group CMB2_Field object
+	 * @param  CMB2_Field|null  $field_group  If a sub-field, will be the parent group CMB2_Field object
 	 * @return array                Array of CMB2_Field arguments
 	 */
 	public function get_field_args( $field_id, $field_args, $sub_field_id, $field_group ) {
@@ -969,7 +969,7 @@ 
 	 * @since  2.0.0
 	 * @param  array  $field           Metabox field config array
 	 * @param  int    $position        (optional) Position of metabox. 1 for first, etc
-	 * @return mixed                   Field id or false
+	 * @return string                   Field id or false
 	 */
 	public function add_field( array $field, $position = 0 ) {
 		if ( ! is_array( $field ) || ! array_key_exists( 'id', $field ) ) {

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

includes/CMB2_REST_Controller_Boxes.php

Doc Comments -1 removed lines

@@ -100,7 +100,6 @@
 	 *
 	 * @since 2.2.0
 	 *
-	 * @param CMB2 $cmb
 	 * @return array
 	 */
 	public function get_rest_box() {

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

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

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',