Completed
Push — 0.x ( 85bde2...2931a5 )
by Andrew
01:21
created

ModuleLoader::isContext()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 0
Metric Value
dl 0
loc 4
ccs 2
cts 2
cp 1
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 1
crap 1
1
<?php
2
namespace Cadre\Module;
3
4
use ArrayIterator;
5
use Aura\Di\Container;
6
use Aura\Di\ContainerConfigInterface;
7
8
class ModuleLoader implements ModuleLoaderInterface
9
{
10
    protected $modules = [];
11
    protected $environment;
12
    protected $context;
13
    protected $isResolved = false;
14
    protected $containerConfigs = [];
15
    protected $conflictsWith = [];
16
    protected $replacedWith = [];
17
18 15
    public function __construct(array $modules, $environment = '', $context = '')
19
    {
20 15
        $this->modules = $modules;
21 15
        $this->environment = $environment;
22 15
        $this->context = $context;
23 15
    }
24
25 13
    public function define(Container $di)
26
    {
27 13
        $this->resolveDependencies();
28 8
        foreach ($this->containerConfigs as $containerConfig) {
29 8
            if ($containerConfig instanceof ContainerConfigInterface) {
0 ignored issues
show
Bug introduced by
The class Aura\Di\ContainerConfigInterface does not exist. Did you forget a USE statement, or did you not list all dependencies?

This error could be the result of:

1. Missing dependencies

PHP Analyzer uses your composer.json file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the composer.json to be in the root folder of your repository.

Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the require or require-dev section?

2. Missing use statement

PHP does not complain about undefined classes in ìnstanceof checks. For example, the following PHP code will work perfectly fine:

if ($x instanceof DoesNotExist) {
    // Do something.
}

If you have not tested against this specific condition, such errors might go unnoticed.

Loading history...
30 8
                $containerConfig->define($di);
31
            }
32
        }
33 8
    }
34
35 8
    public function modify(Container $di)
36
    {
37 8
        $this->resolveDependencies();
38 8
        foreach ($this->containerConfigs as $containerConfig) {
39 8
            if ($containerConfig instanceof ContainerConfigInterface) {
0 ignored issues
show
Bug introduced by
The class Aura\Di\ContainerConfigInterface does not exist. Did you forget a USE statement, or did you not list all dependencies?

This error could be the result of:

1. Missing dependencies

PHP Analyzer uses your composer.json file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the composer.json to be in the root folder of your repository.

Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the require or require-dev section?

2. Missing use statement

PHP does not complain about undefined classes in ìnstanceof checks. For example, the following PHP code will work perfectly fine:

if ($x instanceof DoesNotExist) {
    // Do something.
}

If you have not tested against this specific condition, such errors might go unnoticed.

Loading history...
40 8
                $containerConfig->modify($di);
41
            }
42
        }
43 8
    }
44
45 2
    public function loaded($name)
46
    {
47 2
        $this->resolveDependencies();
48 2
        return isset($this->containerConfigs[$name]);
49
    }
50
51 1
    public function isEnv($environment)
52
    {
53 1
        return 0 === strcmp($environment, $this->environment);
54
    }
55
56 1
    public function isContext($context)
57
    {
58 1
        return 0 === strcmp($context, $this->context);
59
    }
60
61 13
    protected function resolveDependencies()
62
    {
63 13
        if ($this->isResolved) {
64 8
            return;
65
        }
66
67 13
        $modules = new ArrayIterator($this->modules);
68
69 13
        foreach ($modules as $module) {
70 13
            $module = $this->getModule($module);
71 12
            $name = get_class($module);
72
73 12
            if (isset($this->containerConfigs[$name])) {
74 1
                continue;
75
            }
76
77 12
            if (isset($this->replacedWith[$name])) {
78 1
                continue;
79
            }
80
81 12
            if (isset($this->conflictsWith[$name])) {
82 1
                throw new ConflictingModuleException($name, $this->conflictsWith[$name]);
83
            }
84
85 12
            $this->containerConfigs[$name] = $module;
86
87 12
            $this->resolveRequire($modules, $module);
88 12
            $this->resolveRequireEnv($modules, $module);
89 12
            $this->resolveConflict($module, $name);
90 12
            $this->resolveReplace($module, $name);
91
        }
92
93 8
        $this->isResolved = true;
94 8
    }
95
96 12
    protected function resolveRequire($modules, $module)
97
    {
98 12
        $requiredModules = $module->require();
99 12
        foreach ($requiredModules as $requiredModule) {
100 3
            $modules->append($requiredModule);
101
        }
102 12
    }
103
104 12
    protected function resolveRequireEnv($modules, $module)
105
    {
106 12
        $envMethod = 'require' . str_replace(' ', '', ucwords(
107 12
            strtolower(str_replace('_', ' ', trim($this->environment)))
108
        ));
109 12
        if ('require' !== $envMethod && method_exists($module, $envMethod)) {
110 2
            $requiredModules = $module->$envMethod();
111 2
            foreach ($requiredModules as $requiredModule) {
112 2
                $modules->append($requiredModule);
113
            }
114
        }
115 12
    }
116
117 12
    protected function resolveConflict($module, $name)
118
    {
119 12
        $conflictingModules = $module->conflict();
120 12
        foreach ($conflictingModules as $conflictingModule) {
121 3
            $this->conflictsWith[$conflictingModule] = $name;
122 3
            if (isset($this->containerConfigs[$conflictingModule])) {
123 3
                throw new ConflictingModuleException($conflictingModule, $name);
124
            }
125
        }
126 12
    }
127
128 12
    protected function resolveReplace($module, $name)
129
    {
130 12
        $replacesModules = $module->replace();
131 12
        foreach ($replacesModules as $replacesModule) {
132 3
            if (isset($this->replacedWith[$replacesModule])) {
133 1
                throw new AlreadyReplacedException(
134 1
                    $name,
135 1
                    $replacesModule,
136 1
                    $this->replacedWith[$replacesModule]
137
                );
138
            }
139 3
            if (isset($this->containerConfigs[$replacesModule])) {
140 1
                throw new AlreadyLoadedException(
141 1
                    $name,
142 1
                    'replace',
143 1
                    $replacesModule
144
                );
145
            }
146 2
            $this->replacedWith[$replacesModule] = $name;
147
        }
148 12
    }
149
150 13
    protected function getModule($module)
151
    {
152 13
        if (is_string($module)) {
153 13
            $module = new $module($this);
154
        }
155
156 13
        if (! $module instanceof ModuleInterface) {
157 1
            throw new \InvalidArgumentException(
158 1
                'Modules must implement ModuleInterface'
159
            );
160
        }
161
162 12
        return $module;
163
    }
164
}
165