CoreLoader - Code Metrics - Inspection of "Daily Inspection: allow create() to load non-FQCNs..." - eventespresso/event-espresso-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — FET-10785-ee-system-loader (4ec117)

unknown

created 2017-06-10 21:09 UTC

CoreLoader A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	58
rs	10
c	1
b	0
f	0
wmc	7
lcom	1
cbo	2

3 Methods

Rating	Name	Size	Complexity
A	__construct()	12	3
A	load()	6	2
A	reset()	6	2

<?php

namespace EventEspresso\core\services\loaders;

use EE_Error;
use EE_Registry;
use EventEspresso\core\services\container\CoffeeShop;
use EventEspresso\core\services\container\exceptions\ServiceNotFoundException;
use InvalidArgumentException;

defined('EVENT_ESPRESSO_VERSION') || exit;



/**
 * Class CoreLoader
 * Currently uses EE_Registry for instantiating classes,
 * but will later be replaced by the CoffeeShop DI container
 *
 * @package       Event Espresso
 * @author        Brent Christensen
 * @since         $VID:$
 */
class CoreLoader implements LoaderDecoratorInterface
{

    /**
     * @var EE_Registry|CoffeeShop $generator
     */
    private $generator;



    /**
     * CoreLoader constructor.
     *
     * @param EE_Registry|CoffeeShop $generator
     * @throws InvalidArgumentException
     */
    public function __construct($generator)
    {
        if(!($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
            throw new InvalidArgumentException(
                esc_html__(
                    'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',
                    'event_espresso'
                )
            );
        }
        $this->generator = $generator;
    }



    /**
     * @param string $fqcn
     * @param array  $arguments
     * @return mixed
     * @throws EE_Error
     * @throws ServiceNotFoundException
     */
    public function load($fqcn, $arguments = array())
    {
        return $this->generator instanceof EE_Registry
            ? $this->generator->create($fqcn, $arguments)
            : $this->generator->brew($fqcn, $arguments);
    }



    /**
     * calls reset() on generator if method exists
     */
    public function reset()
    {
        if (method_exists($this->generator, 'reset')) {
            $this->generator->reset();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        }
    }

}
// End of file CoreLoader.php
// Location: core/services/loaders/CoreLoader.php


1			<?php
2
3			namespace EventEspresso\core\services\loaders;
4
5			use EE_Error;
6			use EE_Registry;
7			use EventEspresso\core\services\container\CoffeeShop;
8			use EventEspresso\core\services\container\exceptions\ServiceNotFoundException;
9			use InvalidArgumentException;
10
11			defined('EVENT_ESPRESSO_VERSION') \|\| exit;
12
13
14
15			/**
16			* Class CoreLoader
17			* Currently uses EE_Registry for instantiating classes,
18			* but will later be replaced by the CoffeeShop DI container
19			*
20			* @package Event Espresso
21			* @author Brent Christensen
22			* @since $VID:$
23			*/
24			class CoreLoader implements LoaderDecoratorInterface
25			{
26
27			/**
28			* @var EE_Registry\|CoffeeShop $generator
29			*/
30			private $generator;
31
32
33
34			/**
35			* CoreLoader constructor.
36			*
37			* @param EE_Registry\|CoffeeShop $generator
38			* @throws InvalidArgumentException
39			*/
40			public function __construct($generator)
41			{
42			if(!($generator instanceof EE_Registry \|\| $generator instanceof CoffeeShop)) {
43			throw new InvalidArgumentException(
44			esc_html__(
45			'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',
46			'event_espresso'
47			)
48			);
49			}
50			$this->generator = $generator;
51			}
52
53
54
55			/**
56			* @param string $fqcn
57			* @param array $arguments
58			* @return mixed
59			* @throws EE_Error
60			* @throws ServiceNotFoundException
61			*/
62			public function load($fqcn, $arguments = array())
63			{
64			return $this->generator instanceof EE_Registry
65			? $this->generator->create($fqcn, $arguments)
66			: $this->generator->brew($fqcn, $arguments);
67			}
68
69
70
71			/**
72			* calls reset() on generator if method exists
73			*/
74			public function reset()
75			{
76			if (method_exists($this->generator, 'reset')) {
77			$this->generator->reset();
			0 ignored issues – show Bug introduced 2017-04-13 23:11 UTC by Report Bug Copy Issue Report The method `reset` does only exist in `EE_Registry`, but not in `EventEspresso\core\services\container\CoffeeShop`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
78			}
79			}
80
81			}
82			// End of file CoreLoader.php
83			// Location: core/services/loaders/CoreLoader.php
84

eventespresso / event-espresso-core

Branch — FET-10785-ee-system-loader (4ec117)

CoreLoader A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like