CoreLoader::load() - Code Metrics - Inspection of "Daily Inspection: addon class should be loaded pri..." - eventespresso/event-espresso-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — BUG-11137-domain-base (fa6779)

unknown

created 2017-11-09 21:50 UTC

CoreLoader::load() C

↳ Parent: CoreLoader

Complexity

Conditions	7
Paths	17

Size

Total Lines	39
Code Lines	27

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	7
eloc	27
nc	17
nop	3
dl	0
loc	39
rs	6.7272
c	0
b	0
f	0

<?php

namespace EventEspresso\core\services\loaders;

use EE_Error;
use EE_Registry;
use EventEspresso\core\exceptions\InvalidClassException;
use EventEspresso\core\exceptions\InvalidDataTypeException;
use EventEspresso\core\exceptions\InvalidIdentifierException;
use EventEspresso\core\services\container\CoffeeMaker;
use EventEspresso\core\services\container\CoffeeShop;
use EventEspresso\core\services\container\exceptions\InstantiationException;
use EventEspresso\core\services\container\exceptions\ServiceExistsException;
use EventEspresso\core\services\container\exceptions\ServiceNotFoundException;
use InvalidArgumentException;
use OutOfBoundsException;
use ReflectionException;

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;
    }



    /**
     * Calls the appropriate loading method from the installed generator;
     * If EE_Registry is being used, then the additional parameters for the EE_Registry::create() method
     * can be added to the $arguments array and they will be extracted and passed to EE_Registry::create(),
     * but NOT to the class being instantiated.
     * This is done by adding the parameters to the $arguments array as follows:
     *  array(
     *      'EE_Registry::create(from_db)'   => true, // boolean value, default = false
     *      'EE_Registry::create(load_only)' => true, // boolean value, default = false
     *      'EE_Registry::create(addon)'     => true, // boolean value, default = false
     *  )
     *
     * @param string $fqcn
     * @param array  $arguments
     * @param bool   $shared
     * @return mixed
     * @throws OutOfBoundsException
     * @throws ServiceExistsException
     * @throws InstantiationException
     * @throws InvalidIdentifierException
     * @throws InvalidDataTypeException
     * @throws InvalidClassException
     * @throws EE_Error
     * @throws ServiceNotFoundException
     * @throws ReflectionException
     */
    public function load($fqcn, $arguments = array(), $shared = true)
    {
        if($this->generator instanceof EE_Registry) {
            // check if additional EE_Registry::create() arguments have been passed
            // from_db
            $from_db = isset($arguments['EE_Registry::create(from_db)'])
                ? (bool)$arguments['EE_Registry::create(from_db)']
                : false;
            // load_only
            $load_only = isset($arguments['EE_Registry::create(load_only)'])
                ? (bool)$arguments['EE_Registry::create(load_only)']
                : false;
            // addon
            $addon = isset($arguments['EE_Registry::create(addon)'])
                ? (bool)$arguments['EE_Registry::create(addon)']
                : false;
            unset(
                $arguments['EE_Registry::create(from_db)'],
                $arguments['EE_Registry::create(load_only)'],
                $arguments['EE_Registry::create(addon)']
            );
            // addons need to be cached on EE_Registry
            $shared = $addon ? true : $shared;
            return $this->generator->create(
                $fqcn,
                $arguments,
                $shared,
                $from_db,
                $load_only,
                $addon
            );
        }
        return $this->generator->brew(
            $fqcn,
            $arguments,
            $shared ? CoffeeMaker::BREW_SHARED : CoffeeMaker::BREW_NEW
        );

    }



    /**
     * calls reset() on generator if method exists
     *
     * @throws EE_Error
     * @throws ReflectionException
     */
    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\exceptions\InvalidClassException;
8			use EventEspresso\core\exceptions\InvalidDataTypeException;
9			use EventEspresso\core\exceptions\InvalidIdentifierException;
10			use EventEspresso\core\services\container\CoffeeMaker;
11			use EventEspresso\core\services\container\CoffeeShop;
12			use EventEspresso\core\services\container\exceptions\InstantiationException;
13			use EventEspresso\core\services\container\exceptions\ServiceExistsException;
14			use EventEspresso\core\services\container\exceptions\ServiceNotFoundException;
15			use InvalidArgumentException;
16			use OutOfBoundsException;
17			use ReflectionException;
18
19			defined('EVENT_ESPRESSO_VERSION') \|\| exit;
20
21
22
23			/**
24			* Class CoreLoader
25			* Currently uses EE_Registry for instantiating classes,
26			* but will later be replaced by the CoffeeShop DI container
27			*
28			* @package Event Espresso
29			* @author Brent Christensen
30			* @since $VID:$
31			*/
32			class CoreLoader implements LoaderDecoratorInterface
33			{
34
35			/**
36			* @var EE_Registry\|CoffeeShop $generator
37			*/
38			private $generator;
39
40
41
42			/**
43			* CoreLoader constructor.
44			*
45			* @param EE_Registry\|CoffeeShop $generator
46			* @throws InvalidArgumentException
47			*/
48			public function __construct($generator)
49			{
50			if(!($generator instanceof EE_Registry \|\| $generator instanceof CoffeeShop)) {
51			throw new InvalidArgumentException(
52			esc_html__(
53			'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',
54			'event_espresso'
55			)
56			);
57			}
58			$this->generator = $generator;
59			}
60
61
62
63			/**
64			* Calls the appropriate loading method from the installed generator;
65			* If EE_Registry is being used, then the additional parameters for the EE_Registry::create() method
66			* can be added to the $arguments array and they will be extracted and passed to EE_Registry::create(),
67			* but NOT to the class being instantiated.
68			* This is done by adding the parameters to the $arguments array as follows:
69			* array(
70			* 'EE_Registry::create(from_db)' => true, // boolean value, default = false
71			* 'EE_Registry::create(load_only)' => true, // boolean value, default = false
72			* 'EE_Registry::create(addon)' => true, // boolean value, default = false
73			* )
74			*
75			* @param string $fqcn
76			* @param array $arguments
77			* @param bool $shared
78			* @return mixed
79			* @throws OutOfBoundsException
80			* @throws ServiceExistsException
81			* @throws InstantiationException
82			* @throws InvalidIdentifierException
83			* @throws InvalidDataTypeException
84			* @throws InvalidClassException
85			* @throws EE_Error
86			* @throws ServiceNotFoundException
87			* @throws ReflectionException
88			*/
89			public function load($fqcn, $arguments = array(), $shared = true)
90			{
91			if($this->generator instanceof EE_Registry) {
92			// check if additional EE_Registry::create() arguments have been passed
93			// from_db
94			$from_db = isset($arguments['EE_Registry::create(from_db)'])
95			? (bool)$arguments['EE_Registry::create(from_db)']
96			: false;
97			// load_only
98			$load_only = isset($arguments['EE_Registry::create(load_only)'])
99			? (bool)$arguments['EE_Registry::create(load_only)']
100			: false;
101			// addon
102			$addon = isset($arguments['EE_Registry::create(addon)'])
103			? (bool)$arguments['EE_Registry::create(addon)']
104			: false;
105			unset(
106			$arguments['EE_Registry::create(from_db)'],
107			$arguments['EE_Registry::create(load_only)'],
108			$arguments['EE_Registry::create(addon)']
109			);
110			// addons need to be cached on EE_Registry
111			$shared = $addon ? true : $shared;
112			return $this->generator->create(
113			$fqcn,
114			$arguments,
115			$shared,
116			$from_db,
117			$load_only,
118			$addon
119			);
120			}
121			return $this->generator->brew(
122			$fqcn,
123			$arguments,
124			$shared ? CoffeeMaker::BREW_SHARED : CoffeeMaker::BREW_NEW
125			);
126
127			}
128
129
130
131			/**
132			* calls reset() on generator if method exists
133			*
134			* @throws EE_Error
135			* @throws ReflectionException
136			*/
137			public function reset()
138			{
139			if (method_exists($this->generator, 'reset')) {
140			$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...
141			}
142			}
143
144			}
145			// End of file CoreLoader.php
146			// Location: core/services/loaders/CoreLoader.php
147

eventespresso / event-espresso-core

Branch — BUG-11137-domain-base (fa6779)

CoreLoader::load() C

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like