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

Braces +2 added lines, -1 removed lines

@@ -234,7 +234,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 ) {

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

example-functions.php

Braces +20 added lines, -20 removed lines

@@ -15,9 +15,9 @@ 
  * Get the bootstrap! If using the plugin from wordpress.org, REMOVE THIS!

  */

 

-if ( file_exists( dirname( __FILE__ ) . '/cmb2/init.php' ) ) {

+if ( file_exists( dirname( __FILE__ ) . '/cmb2/init.php' ) ) {
 	require_once dirname( __FILE__ ) . '/cmb2/init.php';

-} elseif ( file_exists( dirname( __FILE__ ) . '/CMB2/init.php' ) ) {

+} elseif ( file_exists( dirname( __FILE__ ) . '/CMB2/init.php' ) ) {
 	require_once dirname( __FILE__ ) . '/CMB2/init.php';

 }

 

@@ -28,9 +28,9 @@ 
  *

  * @return bool             True if metabox should show

  */

-function yourprefix_show_if_front_page( $cmb ) {

+function yourprefix_show_if_front_page( $cmb ) {
 	// Don't show this metabox if it's not the front page template.

-	if ( get_option( 'page_on_front' ) !== $cmb->object_id ) {

+	if ( get_option( 'page_on_front' ) !== $cmb->object_id ) {
 		return false;

 	}

 	return true;

@@ -43,9 +43,9 @@ 
  *

  * @return bool                     True if metabox should show

  */

-function yourprefix_hide_if_no_cats( $field ) {

+function yourprefix_hide_if_no_cats( $field ) {
 	// Don't show this field if not in the cats category.

-	if ( ! has_tag( 'cats', $field->object_id ) ) {

+	if ( ! has_tag( 'cats', $field->object_id ) ) {
 		return false;

 	}

 	return true;

@@ -57,7 +57,7 @@ 
  * @param  array      $field_args Array of field arguments.

  * @param  CMB2_Field $field      The field object.

  */

-function yourprefix_render_row_cb( $field_args, $field ) {

+function yourprefix_render_row_cb( $field_args, $field ) {
 	$classes     = $field->row_classes();

 	$id          = $field->args( 'id' );

 	$label       = $field->args( 'name' );

@@ -79,7 +79,7 @@ 
  * @param  array      $field_args Array of field arguments.

  * @param  CMB2_Field $field      The field object.

  */

-function yourprefix_display_text_small_column( $field_args, $field ) {

+function yourprefix_display_text_small_column( $field_args, $field ) {
 	?>

 	<div class="custom-column-display <?php echo esc_attr( $field->row_classes() ); ?>">

 		<p><?php echo $field->escaped_value(); ?></p>

@@ -94,10 +94,10 @@ 
  * @param  array             $field_args Array of field parameters.

  * @param  CMB2_Field object $field      Field object.

  */

-function yourprefix_before_row_if_2( $field_args, $field ) {

-	if ( 2 == $field->object_id ) {

+function yourprefix_before_row_if_2( $field_args, $field ) {
+	if ( 2 == $field->object_id ) {
 		echo '<p>Testing <b>"before_row"</b> parameter (on $post_id 2)</p>';

-	} else {

+	} else {
 		echo '<p>Testing <b>"before_row"</b> parameter (<b>NOT</b> on $post_id 2)</p>';

 	}

 }

@@ -106,7 +106,7 @@ 
 /**

  * Hook in and add a demo metabox. Can only happen on the 'cmb2_admin_init' or 'cmb2_init' hook.

  */

-function yourprefix_register_demo_metabox() {

+function yourprefix_register_demo_metabox() {
 	$prefix = 'yourprefix_demo_';

 

 	/**

@@ -432,7 +432,7 @@ 
 /**

  * Hook in and add a metabox that only appears on the 'About' page

  */

-function yourprefix_register_about_page_metabox() {

+function yourprefix_register_about_page_metabox() {
 	$prefix = 'yourprefix_about_';

 

 	/**

@@ -461,7 +461,7 @@ 
 /**

  * Hook in and add a metabox to demonstrate repeatable grouped fields

  */

-function yourprefix_register_repeatable_group_field_metabox() {

+function yourprefix_register_repeatable_group_field_metabox() {
 	$prefix = 'yourprefix_group_';

 

 	/**

@@ -525,7 +525,7 @@ 
 /**

  * Hook in and add a metabox to add fields to the user profile pages

  */

-function yourprefix_register_user_profile_metabox() {

+function yourprefix_register_user_profile_metabox() {
 	$prefix = 'yourprefix_user_';

 

 	/**

@@ -595,7 +595,7 @@ 
 /**

  * Hook in and add a metabox to add fields to taxonomy terms

  */

-function yourprefix_register_taxonomy_metabox() {

+function yourprefix_register_taxonomy_metabox() {
 	$prefix = 'yourprefix_term_';

 

 	/**

@@ -637,7 +637,7 @@ 
 /**

  * Hook in and register a metabox to handle a theme options page

  */

-function yourprefix_register_theme_options_metabox() {

+function yourprefix_register_theme_options_metabox() {
 

 	$option_key = 'yourprefix_theme_options';

 

@@ -680,8 +680,8 @@ 
  *

  * @return bool                 Whether this box and its fields are allowed to be viewed.

  */

-function yourprefix_limit_rest_view_to_logged_in_users( $is_allowed, $cmb_controller ) {

-	if ( ! is_user_logged_in() ) {

+function yourprefix_limit_rest_view_to_logged_in_users( $is_allowed, $cmb_controller ) {
+	if ( ! is_user_logged_in() ) {
 		$is_allowed = false;

 	}

 

@@ -693,7 +693,7 @@ 
  * Hook in and add a box to be available in the CMB2 REST API. Can only happen on the 'cmb2_init' hook.

  * More info: https://github.com/WebDevStudios/CMB2/wiki/REST-API

  */

-function yourprefix_register_rest_api_box() {

+function yourprefix_register_rest_api_box() {
 	$prefix = 'yourprefix_rest_';

 

 	$cmb_rest = new_cmb2_box( array(

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