CMB2_Hookup_Base::once() - Code Metrics - Inspection of "CMB2 REST API" - WebDevStudios/CMB2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — trunk (#541)

by Justin

created 2016-06-09 05:27 UTC

CMB2_Hookup_Base::once() A

↳ Parent: CMB2_Hookup_Base

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	6
c	1
b	0
f	0
nc	2
nop	4
dl	0
loc	10
ccs	0
cts	7
cp	0
crap	6
rs	9.4285

<?php
/**
 * Base class for hooking CMB2 into WordPress.
 *
 * @since  2.2.0
 *
 * @category  WordPress_Plugin
 * @package   CMB2
 * @author    WebDevStudios
 * @license   GPL-2.0+
 * @link      http://webdevstudios.com
 */
abstract class CMB2_Hookup_Base {
namespace YourVendor;

class YourClass { }

	/**
	 * Array of all hooks done (to be run once)
	 * @var   array
	 * @since 2.0.0
	 */
	protected static $hooks_completed = array();

	/**
	 * @var   CMB2 object
	 * @since 2.0.2
	 */
	protected $cmb;

	/**
	 * The object type we are performing the hookup for
	 * @var   string
	 * @since 2.0.9
	 */
	protected $object_type = 'post';

	public function __construct( CMB2 $cmb ) {
		$this->cmb = $cmb;
		$this->object_type = $this->cmb->mb_object_type();
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
	}

	abstract public function universal_hooks();

	/**
	 * Ensures WordPress hook only gets fired once
	 * @since  2.0.0
	 * @param string   $action        The name of the filter to hook the $hook callback to.
	 * @param callback $hook          The callback to be run when the filter is applied.
	 * @param integer  $priority      Order the functions are executed
	 * @param int      $accepted_args The number of arguments the function accepts.
	 */
	public function once( $action, $hook, $priority = 10, $accepted_args = 1 ) {
		$key = md5( serialize( func_get_args() ) );

		if ( in_array( $key, self::$hooks_completed ) ) {
			return;
		}

		self::$hooks_completed[] = $key;
		add_filter( $action, $hook, $priority, $accepted_args );
	}

}


1			<?php
2			/**
3			* Base class for hooking CMB2 into WordPress.
4			*
5			* @since 2.2.0
6			*
7			* @category WordPress_Plugin
8			* @package CMB2
9			* @author WebDevStudios
10			* @license GPL-2.0+
11			* @link http://webdevstudios.com
12			*/
13			abstract class CMB2_Hookup_Base {
			0 ignored issues – show Coding Style Compatibility introduced 2015-12-07 19:40 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...
14
15			/**
16			* Array of all hooks done (to be run once)
17			* @var array
18			* @since 2.0.0
19			*/
20			protected static $hooks_completed = array();
21
22			/**
23			* @var CMB2 object
24			* @since 2.0.2
25			*/
26			protected $cmb;
27
28			/**
29			* The object type we are performing the hookup for
30			* @var string
31			* @since 2.0.9
32			*/
33			protected $object_type = 'post';
34
35			public function __construct( CMB2 $cmb ) {
36			$this->cmb = $cmb;
37			$this->object_type = $this->cmb->mb_object_type();
			0 ignored issues – show Documentation Bug introduced 2016-04-18 14:50 UTC by Report Bug Copy Issue Report It seems like `$this->cmb->mb_object_type()` can also be of type `false`. However, the property `$object_type` is declared as type `string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
38			}
39
40			abstract public function universal_hooks();
41
42			/**
43			* Ensures WordPress hook only gets fired once
44			* @since 2.0.0
45			* @param string $action The name of the filter to hook the $hook callback to.
46			* @param callback $hook The callback to be run when the filter is applied.
47			* @param integer $priority Order the functions are executed
48			* @param int $accepted_args The number of arguments the function accepts.
49			*/
50			public function once( $action, $hook, $priority = 10, $accepted_args = 1 ) {
51			$key = md5( serialize( func_get_args() ) );
52
53			if ( in_array( $key, self::$hooks_completed ) ) {
54			return;
55			}
56
57			self::$hooks_completed[] = $key;
58			add_filter( $action, $hook, $priority, $accepted_args );
59			}
60
61			}
62

WebDevStudios / CMB2

Pull Request — trunk (#541)

CMB2_Hookup_Base::once() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like