Issues in CMB2_REST.php - New Issues - Inspection of "CMB2 REST API" - WebDevStudios/CMB2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — trunk (#541)

by Justin

created 2015-12-10 22:49 UTC

includes/CMB2_REST.php (15 issues)

Labels

Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
/**
 * Handles hooking CMB2 objects/fields into the WordPres REST API
 * which can allow fields to be read and/or updated.
 *
 * @since  2.2.0
 *
 * @category  WordPress_Plugin
 * @package   CMB2
 * @author    WebDevStudios
 * @license   GPL-2.0+
 * @link      http://webdevstudios.com
 */
class CMB2_REST extends CMB2_Hookup_Base {
namespace YourVendor;

class YourClass { }

	/**
	 * The current CMB2 REST endpoint version
	 * @var string
	 * @since 2.2.0
	 */
	const VERSION = '1';

	/**
	 * The CMB2 REST base namespace (v should always be followed by $version)
	 * @var string
	 * @since 2.2.0
	 */
	const BASE = 'cmb2/v1';

	/**
	 * @var   CMB2[] objects
	 * @since 2.2.0
	 */
	protected static $boxes;

	/**
	 * Whether metabox fields can be read via REST API
	 * @var   bool
	 * @since 2.2.0
	 */
	protected $can_read = true;

	/**
	 * Array of readable field objects.
	 * @var   CMB2_Field[]
	 * @since 2.2.0
	 */
	protected static $read_fields = array();

	/**
	 * Array of writeable field objects.
	 * @var   CMB2_Field[]
	 * @since 2.2.0
	 */
	protected static $write_fields = array();

	/**
	 * Whether metabox fields can be written via REST API
	 * @var   bool
	 * @since 2.2.0
	 */
	protected $can_write = false;

	public function __construct( CMB2 $cmb ) {
		$this->cmb = $cmb;
		self::$boxes[ $cmb->cmb_id ] = $cmb;

		$show_value = $this->cmb->prop( 'show_in_rest' );
		$this->cmb->rest_read  = 'write_only' !== $show_value;

		$this->cmb->rest_write = in_array( $show_value, array( 'read_and_write', 'write_only' ), true );

	}

	public function universal_hooks() {
		$this->once( 'rest_api_init', array( __CLASS__, 'register_fields' ), 50 );

		// hook up the CMB rest endpoint classes
		$this->once( 'rest_api_init', array( $this, 'init_routes' ), 0 );

		$this->prepare_read_write_fields();

		add_filter( 'is_protected_meta', array( $this, 'is_protected_meta' ), 10, 3 );
	}

	public function init_routes() {
		global $wp_rest_server;
function myFunction($a, $b) {
    // Do something
}

		$boxes_controller = new CMB2_REST_Controller_Boxes( $wp_rest_server );
		$boxes_controller->register_routes();

		$fields_controller = new CMB2_REST_Controller_Fields( $wp_rest_server );
		$fields_controller->register_routes();
	}

	public static function register_fields() {

		$types = array();
		foreach ( self::$boxes as $cmb_id => $cmb ) {
			$types = array_merge( $types, $cmb->prop( 'object_types' ) );
		}
		$types = array_unique( $types );

		register_api_field(
			$types,
			'cmb2',
			array(
				'get_callback' => array( __CLASS__, 'get_restable_field_values' ),
				'update_callback' => array( __CLASS__, 'update_restable_field_values' ),
				'schema' => null,
			)
		);
	}

	protected function prepare_read_write_fields() {
		foreach ( $this->cmb->prop( 'fields' ) as $field ) {
			$show_in_rest = isset( $field['show_in_rest'] ) ? $field['show_in_rest'] : null;

			if ( false === $show_in_rest ) {
				continue;
			}

			$this->maybe_add_read_field( $field['id'], $show_in_rest );
			$this->maybe_add_write_field( $field['id'], $show_in_rest );
		}
	}

	protected function maybe_add_read_field( $field_id, $show_in_rest ) {

		$can_read = $this->cmb->rest_read
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
			? 'write_only' !== $show_in_rest
			: in_array( $show_in_rest, array( 'read_and_write', 'read_only' ), true );

		if ( $can_read ) {
			self::$read_fields[ $this->cmb->cmb_id ][] = $field_id;
		}
	}

	protected function maybe_add_write_field( $field_id, $show_in_rest ) {

		$can_update = $this->cmb->rest_write
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
			? 'read_only' !== $show_in_rest
			: in_array( $show_in_rest, array( 'read_and_write', 'write_only' ), true );

		if ( $can_update ) {
			self::$write_fields[ $this->cmb->cmb_id ][] = $field_id;
		}
	}

	/**
	 * Handler for getting custom field data.
	 * @since  2.2.0
	 * @param  array           $object   The object from the response
	 * @param  string          $field_id Name of field
	 * @param  WP_REST_Request $request  Current request
	 * @return mixed
	 */
	public static function get_restable_field_values( $object, $field_id, $request ) {

		$values = array();
		if ( ! isset( $object['id'] ) ) {
			return;
		}

		foreach ( self::$read_fields as $cmb_id => $fields ) {
			foreach ( $fields as $field_id ) {

				$field = self::$boxes[ $cmb_id ]->get_field( $field_id );
				$field->object_id = $object['id'];

				if ( isset( $object->type ) ) {
					$field->object_type = $object->type;
				}

				$values[ $cmb_id ][ $field->id( true ) ] = $field->get_data();
			}
		}

		return $values;
	}

	/**
	 * Handler for updating custom field data.
	 * @since  2.2.0
	 * @param  mixed    $value    The value of the field
/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @param  object   $object   The object from the response
	 * @param  string   $field_id Name of field
	 * @return bool|int
	 */
	public static function update_restable_field_values( $values, $object, $field_id ) {
		if ( empty( $values ) || ! is_array( $values ) || 'cmb2' !== $field_id ) {
			return;
		}

		$data = self::get_object_data( $object );
		if ( ! $data ) {
			return;
		}

		$object_id   = $data['object_id'];
		$object_type = $data['object_type'];
		$updated     = array();

		foreach ( self::$write_fields as $cmb_id => $fields ) {
			if ( ! array_key_exists( $cmb_id, $values ) ) {
				continue;
			}

			$cmb = self::$boxes[ $cmb_id ];

			$cmb->object_type( $object_id );
			$cmb->object_type( $object_type );

			$cmb->pre_process();

			foreach ( $fields as $field_id ) {
				if ( ! array_key_exists( $field_id, $values[ $cmb_id ] ) ) {
					continue;
				}

				$field = $cmb->get_field( $field_id );

				if ( 'title' == $field->type() ) {
					continue;
				}

				$field->object_id   = $object_id;
				$field->object_type = $object_type;

				if ( 'group' == $field->type() ) {
					$fields = $field->fields();
					if ( empty( $fields ) ) {
						continue;
					}

					$cmb->data_to_save[ $field_id ] = $values[ $cmb_id ][ $field_id ];
					$updated[ $cmb_id ][ $field_id ] = $cmb->save_group_field( $field );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

				} else {
					$updated[ $cmb_id ][ $field_id ] = $field->save_field( $values[ $cmb_id ][ $field_id ] );
				}

			}

			$cmb->after_save();
		}

		return $updated;
	}

	/**
	 * Filter whether a meta key is protected.
	 * @since 2.2.0
	 * @param bool   $protected Whether the key is protected. Default false.
	 * @param string $meta_key  Meta key.
	 * @param string $meta_type Meta type.
	 */
	public function is_protected_meta( $protected, $meta_key, $meta_type ) {

		if ( $this->field_can_update( $meta_key ) ) {
			return false;
		}

		return $protected;
	}

	public function field_can_update( $field_id ) {

		$field        = $this->cmb->get_field( $field_id );
		$show_in_rest = $field ? $field->args( 'show_in_rest' ) : 'no';
		$can_update   = $this->cmb->rest_write
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
			? 'read_only' !== $show_in_rest
			: in_array( $show_in_rest, array( 'read_and_write', 'write_only' ), true );

		return $can_update ? $field : false;
	}

	protected static function get_object_data( $object ) {
		$object_id = 0;
		if ( isset( $object->ID ) ) {
			$object_id   = intval( $object->ID );
			$object_type = isset( $object->user_login ) ? 'user' : 'post';
		} elseif ( isset( $object->comment_ID ) ) {
			$object_id   = intval( $object->comment_ID );
			$object_type = 'comment';
		} elseif ( is_array( $object ) && isset( $object['term_id'] ) ) {
			$object_id   = intval( $object['term_id'] );
			$object_type = 'term';
		} elseif ( isset( $object->term_id ) ) {
			$object_id   = intval( $object->term_id );
			$object_type = 'term';
		}

		if ( empty( $object_id ) ) {
			return false;
		}

		return compact( 'object_id', 'object_type' );
	}

}


Pull Request — trunk (#541)

includes/CMB2_REST.php (15 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

1. Pass all data via parameters

2. Create a class that maintains your state

1		<?php
2		/**
3		* Handles hooking CMB2 objects/fields into the WordPres REST API
4		* which can allow fields to be read and/or updated.
5		*
6		* @since 2.2.0
7		*
8		* @category WordPress_Plugin
9		* @package CMB2
10		* @author WebDevStudios
11		* @license GPL-2.0+
12		* @link http://webdevstudios.com
13		*/
14		class CMB2_REST extends CMB2_Hookup_Base {
		0 ignored issues – show Coding Style Compatibility introduced 2015-12-10 22:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
15
16		/**
17		* The current CMB2 REST endpoint version
18		* @var string
19		* @since 2.2.0
20		*/
21		const VERSION = '1';
22
23		/**
24		* The CMB2 REST base namespace (v should always be followed by $version)
25		* @var string
26		* @since 2.2.0
27		*/
28		const BASE = 'cmb2/v1';
29
30		/**
31		* @var CMB2[] objects
32		* @since 2.2.0
33		*/
34		protected static $boxes;
35
36		/**
37		* Whether metabox fields can be read via REST API
38		* @var bool
39		* @since 2.2.0
40		*/
41		protected $can_read = true;
42
43		/**
44		* Array of readable field objects.
45		* @var CMB2_Field[]
46		* @since 2.2.0
47		*/
48		protected static $read_fields = array();
49
50		/**
51		* Array of writeable field objects.
52		* @var CMB2_Field[]
53		* @since 2.2.0
54		*/
55		protected static $write_fields = array();
56
57		/**
58		* Whether metabox fields can be written via REST API
59		* @var bool
60		* @since 2.2.0
61		*/
62		protected $can_write = false;
63
64		public function __construct( CMB2 $cmb ) {
65		$this->cmb = $cmb;
66		self::$boxes[ $cmb->cmb_id ] = $cmb;
67
68		$show_value = $this->cmb->prop( 'show_in_rest' );
69		$this->cmb->rest_read = 'write_only' !== $show_value;
		0 ignored issues – show Bug introduced 2015-12-10 22:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `rest_read` does not seem to exist in `CMB2`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
70		$this->cmb->rest_write = in_array( $show_value, array( 'read_and_write', 'write_only' ), true );
		0 ignored issues – show Bug introduced 2015-12-10 22:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `rest_write` does not seem to exist in `CMB2`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
71		}
72
73		public function universal_hooks() {
74		$this->once( 'rest_api_init', array( __CLASS__, 'register_fields' ), 50 );
75
76		// hook up the CMB rest endpoint classes
77		$this->once( 'rest_api_init', array( $this, 'init_routes' ), 0 );
78
79		$this->prepare_read_write_fields();
80
81		add_filter( 'is_protected_meta', array( $this, 'is_protected_meta' ), 10, 3 );
82		}
83
84		public function init_routes() {
85		global $wp_rest_server;
		0 ignored issues – show Compatibility Best Practice introduced 2015-12-10 22:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
86
87		$boxes_controller = new CMB2_REST_Controller_Boxes( $wp_rest_server );
88		$boxes_controller->register_routes();
89
90		$fields_controller = new CMB2_REST_Controller_Fields( $wp_rest_server );
91		$fields_controller->register_routes();
92		}
93
94		public static function register_fields() {
95
96		$types = array();
97		foreach ( self::$boxes as $cmb_id => $cmb ) {
98		$types = array_merge( $types, $cmb->prop( 'object_types' ) );
99		}
100		$types = array_unique( $types );
101
102		register_api_field(
103		$types,
104		'cmb2',
105		array(
106		'get_callback' => array( __CLASS__, 'get_restable_field_values' ),
107		'update_callback' => array( __CLASS__, 'update_restable_field_values' ),
108		'schema' => null,
109		)
110		);
111		}
112
113		protected function prepare_read_write_fields() {
114		foreach ( $this->cmb->prop( 'fields' ) as $field ) {
115		$show_in_rest = isset( $field['show_in_rest'] ) ? $field['show_in_rest'] : null;
116
117		if ( false === $show_in_rest ) {
118		continue;
119		}
120
121		$this->maybe_add_read_field( $field['id'], $show_in_rest );
122		$this->maybe_add_write_field( $field['id'], $show_in_rest );
123		}
124		}
125
126	View Code Duplication	protected function maybe_add_read_field( $field_id, $show_in_rest ) {
		0 ignored issues – show Duplication introduced 2015-12-10 22:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
127		$can_read = $this->cmb->rest_read
		0 ignored issues – show Documentation introduced 2015-12-10 22:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `rest_read` does not exist on `object<CMB2>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
128		? 'write_only' !== $show_in_rest
129		: in_array( $show_in_rest, array( 'read_and_write', 'read_only' ), true );
130
131		if ( $can_read ) {
132		self::$read_fields[ $this->cmb->cmb_id ][] = $field_id;
133		}
134		}
135
136	View Code Duplication	protected function maybe_add_write_field( $field_id, $show_in_rest ) {
		0 ignored issues – show Duplication introduced 2015-12-10 22:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
137		$can_update = $this->cmb->rest_write
		0 ignored issues – show Documentation introduced 2015-12-10 22:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `rest_write` does not exist on `object<CMB2>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
138		? 'read_only' !== $show_in_rest
139		: in_array( $show_in_rest, array( 'read_and_write', 'write_only' ), true );
140
141		if ( $can_update ) {
142		self::$write_fields[ $this->cmb->cmb_id ][] = $field_id;
143		}
144		}
145
146		/**
147		* Handler for getting custom field data.
148		* @since 2.2.0
149		* @param array $object The object from the response
150		* @param string $field_id Name of field
151		* @param WP_REST_Request $request Current request
152		* @return mixed
153		*/
154		public static function get_restable_field_values( $object, $field_id, $request ) {
		0 ignored issues – show Unused Code introduced 2015-12-10 22:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this The parameter `$field_id` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2015-12-10 22:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
155		$values = array();
156		if ( ! isset( $object['id'] ) ) {
157		return;
158		}
159
160		foreach ( self::$read_fields as $cmb_id => $fields ) {
161		foreach ( $fields as $field_id ) {
		0 ignored issues – show Bug introduced 2015-12-10 22:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this The expression `$fields` of type `object<CMB2_Field>` is not traversable. Loading history...
162		$field = self::$boxes[ $cmb_id ]->get_field( $field_id );
163		$field->object_id = $object['id'];
164
165		if ( isset( $object->type ) ) {
166		$field->object_type = $object->type;
167		}
168
169		$values[ $cmb_id ][ $field->id( true ) ] = $field->get_data();
170		}
171		}
172
173		return $values;
174		}
175
176		/**
177		* Handler for updating custom field data.
178		* @since 2.2.0
179		* @param mixed $value The value of the field
		0 ignored issues – show Documentation introduced 2015-12-10 22:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this There is no parameter named `$value`. Did you maybe mean `$values`? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit. Consider the following example. The parameter `$ireland` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $ireland */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was changed, but the annotation was not. Loading history...
180		* @param object $object The object from the response
181		* @param string $field_id Name of field
182		* @return bool\|int
183		*/
184		public static function update_restable_field_values( $values, $object, $field_id ) {
185		if ( empty( $values ) \|\| ! is_array( $values ) \|\| 'cmb2' !== $field_id ) {
186		return;
187		}
188
189		$data = self::get_object_data( $object );
190		if ( ! $data ) {
191		return;
192		}
193
194		$object_id = $data['object_id'];
195		$object_type = $data['object_type'];
196		$updated = array();
197
198		foreach ( self::$write_fields as $cmb_id => $fields ) {
199		if ( ! array_key_exists( $cmb_id, $values ) ) {
200		continue;
201		}
202
203		$cmb = self::$boxes[ $cmb_id ];
204
205		$cmb->object_type( $object_id );
206		$cmb->object_type( $object_type );
207
208		$cmb->pre_process();
209
210		foreach ( $fields as $field_id ) {
211		if ( ! array_key_exists( $field_id, $values[ $cmb_id ] ) ) {
212		continue;
213		}
214
215		$field = $cmb->get_field( $field_id );
216
217		if ( 'title' == $field->type() ) {
218		continue;
219		}
220
221		$field->object_id = $object_id;
222		$field->object_type = $object_type;
223
224		if ( 'group' == $field->type() ) {
225		$fields = $field->fields();
226		if ( empty( $fields ) ) {
227		continue;
228		}
229
230		$cmb->data_to_save[ $field_id ] = $values[ $cmb_id ][ $field_id ];
231		$updated[ $cmb_id ][ $field_id ] = $cmb->save_group_field( $field );
		0 ignored issues – show Documentation introduced 2015-12-10 22:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this `$field` is of type `object<CMB2_Field>\|false`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
232
233		} else {
234		$updated[ $cmb_id ][ $field_id ] = $field->save_field( $values[ $cmb_id ][ $field_id ] );
235		}
236
237		}
238
239		$cmb->after_save();
240		}
241
242		return $updated;
243		}
244
245		/**
246		* Filter whether a meta key is protected.
247		* @since 2.2.0
248		* @param bool $protected Whether the key is protected. Default false.
249		* @param string $meta_key Meta key.
250		* @param string $meta_type Meta type.
251		*/
252		public function is_protected_meta( $protected, $meta_key, $meta_type ) {
		0 ignored issues – show Unused Code introduced 2015-12-10 22:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this The parameter `$meta_type` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
253		if ( $this->field_can_update( $meta_key ) ) {
254		return false;
255		}
256
257		return $protected;
258		}
259
260		public function field_can_update( $field_id ) {
261
262		$field = $this->cmb->get_field( $field_id );
263		$show_in_rest = $field ? $field->args( 'show_in_rest' ) : 'no';
264		$can_update = $this->cmb->rest_write
		0 ignored issues – show Documentation introduced 2015-12-10 22:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `rest_write` does not exist on `object<CMB2>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
265		? 'read_only' !== $show_in_rest
266		: in_array( $show_in_rest, array( 'read_and_write', 'write_only' ), true );
267
268		return $can_update ? $field : false;
269		}
270
271		protected static function get_object_data( $object ) {
272		$object_id = 0;
273		if ( isset( $object->ID ) ) {
274		$object_id = intval( $object->ID );
275		$object_type = isset( $object->user_login ) ? 'user' : 'post';
276		} elseif ( isset( $object->comment_ID ) ) {
277		$object_id = intval( $object->comment_ID );
278		$object_type = 'comment';
279		} elseif ( is_array( $object ) && isset( $object['term_id'] ) ) {
280		$object_id = intval( $object['term_id'] );
281		$object_type = 'term';
282		} elseif ( isset( $object->term_id ) ) {
283		$object_id = intval( $object->term_id );
284		$object_type = 'term';
285		}
286
287		if ( empty( $object_id ) ) {
288		return false;
289		}
290
291		return compact( 'object_id', 'object_type' );
292		}
293
294		}
295

WebDevStudios / CMB2

Pull Request — trunk (#541)

includes/CMB2_REST.php (15 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like