CMB2_Boxes - Code Metrics - WebDevStudios/CMB2 - Measure and Improve Code Quality continuously with Scrutinizer

CMB2_Boxes A
last analyzed 2017-04-04 11:15 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

40.91%

Importance

Changes

Metric	Value
dl	0
loc	85
ccs	9
cts	22
cp	0.4091
rs	10
c	0
b	0
f	0
wmc	10
lcom	1
cbo	1

5 Methods

Rating	Name	Size	Complexity
A	add()	3	1
A	remove()	5	2
A	get()	7	3
A	get_all()	3	1
A	get_by_property()	14	3

<?php

/**
 * A CMB2 object instance registry for storing every CMB2 instance.
 *
 * @category  WordPress_Plugin
 * @package   CMB2
 * @author    WebDevStudios
 * @license   GPL-2.0+
 * @link      http://webdevstudios.com
 */
class CMB2_Boxes {
namespace YourVendor;

class YourClass { }

	/**
	 * Array of all metabox objects.
	 *
	 * @since 2.0.0
	 * @var array
	 */
	protected static $cmb2_instances = array();

	/**
	 * Add a CMB2 instance object to the registry.
	 *
	 * @since 1.X.X
	 *
	 * @param CMB2 $cmb_instance CMB2 instance.
	 */
	public static function add( CMB2 $cmb_instance ) {
		self::$cmb2_instances[ $cmb_instance->cmb_id ] = $cmb_instance;
<?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.");
        }
    }

}
	}

	/**
	 * Remove a CMB2 instance object from the registry.
	 *
	 * @since 1.X.X
	 *
	 * @param string $cmb_id A CMB2 instance id.
	 */
	public static function remove( $cmb_id ) {
		if ( array_key_exists( $cmb_id, self::$cmb2_instances ) ) {
			unset( self::$cmb2_instances[ $cmb_id ] );
		}
	}

	/**
	 * Retrieve a CMB2 instance by cmb id.
	 *
	 * @since 1.X.X
	 *
	 * @param string $cmb_id A CMB2 instance id.
	 *
	 * @return CMB2|bool False or CMB2 object instance.
	 */
	public static function get( $cmb_id ) {
		if ( empty( self::$cmb2_instances ) || empty( self::$cmb2_instances[ $cmb_id ] ) ) {
			return false;
		}

		return self::$cmb2_instances[ $cmb_id ];
	}

	/**
	 * Retrieve all CMB2 instances registered.
	 *
	 * @since  1.X.X
	 * @return CMB2[] Array of all registered cmb2 instances.
	 */
	public static function get_all() {
		return self::$cmb2_instances;
	}

	/**
	 * Retrieve all CMB2 instances that have the specified property set.
	 *
	 * @since  2.2.3
	 * @param  string $property Property name.
	 * @param  mixed  $ignore   The value to ignore.
	 * @return CMB2[]           Array of matching cmb2 instances.
	 */
	public static function get_by_property( $property, $ignore = null ) {
		$by_property[ $property ] = array();
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

		foreach ( self::$cmb2_instances as $cmb_id => $cmb ) {

			if ( $ignore === $cmb->prop( $property ) ) {
				continue;
			}

			$by_property[ $property ][ $cmb_id ] = $cmb;
		}

		return $by_property[ $property ];
	}

}


1		<?php
2
3		/**
4		* A CMB2 object instance registry for storing every CMB2 instance.
5		*
6		* @category WordPress_Plugin
7		* @package CMB2
8		* @author WebDevStudios
9		* @license GPL-2.0+
10		* @link http://webdevstudios.com
11		*/
12		class CMB2_Boxes {
		0 ignored issues – show Coding Style Compatibility introduced 2015-11-24 04:05 UTC by Report Bug Copy Issue Report 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...
13
14		/**
15		* Array of all metabox objects.
16		*
17		* @since 2.0.0
18		* @var array
19		*/
20		protected static $cmb2_instances = array();
21
22		/**
23		* Add a CMB2 instance object to the registry.
24		*
25		* @since 1.X.X
26		*
27		* @param CMB2 $cmb_instance CMB2 instance.
28		*/
29	48	public static function add( CMB2 $cmb_instance ) {
30	48	self::$cmb2_instances[ $cmb_instance->cmb_id ] = $cmb_instance;
		0 ignored issues – show Documentation introduced 2017-03-01 01:21 UTC by Report Bug Copy Issue Report The property `$cmb_id` is declared protected in `CMB2_Base`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
31	48	}
32
33		/**
34		* Remove a CMB2 instance object from the registry.
35		*
36		* @since 1.X.X
37		*
38		* @param string $cmb_id A CMB2 instance id.
39		*/
40		public static function remove( $cmb_id ) {
41		if ( array_key_exists( $cmb_id, self::$cmb2_instances ) ) {
42		unset( self::$cmb2_instances[ $cmb_id ] );
43		}
44		}
45
46		/**
47		* Retrieve a CMB2 instance by cmb id.
48		*
49		* @since 1.X.X
50		*
51		* @param string $cmb_id A CMB2 instance id.
52		*
53		* @return CMB2\|bool False or CMB2 object instance.
54		*/
55	34	public static function get( $cmb_id ) {
56	34	if ( empty( self::$cmb2_instances ) \|\| empty( self::$cmb2_instances[ $cmb_id ] ) ) {
57	5	return false;
58		}
59
60	32	return self::$cmb2_instances[ $cmb_id ];
61		}
62
63		/**
64		* Retrieve all CMB2 instances registered.
65		*
66		* @since 1.X.X
67		* @return CMB2[] Array of all registered cmb2 instances.
68		*/
69	1	public static function get_all() {
70	1	return self::$cmb2_instances;
71		}
72
73		/**
74		* Retrieve all CMB2 instances that have the specified property set.
75		*
76		* @since 2.2.3
77		* @param string $property Property name.
78		* @param mixed $ignore The value to ignore.
79		* @return CMB2[] Array of matching cmb2 instances.
80		*/
81		public static function get_by_property( $property, $ignore = null ) {
82		$by_property[ $property ] = array();
		0 ignored issues – show Coding Style Comprehensibility introduced 2015-12-07 19:40 UTC by Report Bug Copy Issue Report `$by_property` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$by_property = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
83
84		foreach ( self::$cmb2_instances as $cmb_id => $cmb ) {
85
86		if ( $ignore === $cmb->prop( $property ) ) {
87		continue;
88		}
89
90		$by_property[ $property ][ $cmb_id ] = $cmb;
91		}
92
93		return $by_property[ $property ];
94		}
95
96		}
97

WebDevStudios / CMB2

CMB2_Boxes A last analyzed 2017-04-04 11:15 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

5 Methods

Duplication Side-by-Side

Filter issues like

CMB2_Boxes A
last analyzed 2017-04-04 11:15 UTC