DISorcery::__construct() - Code Metrics - iFaxity/di-sorcery - Measure and Improve Code Quality continuously with Scrutinizer

DISorcery::__construct() A
last analyzed 2020-05-10 00:22 UTC

↳ Parent: DISorcery

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Faxity\DI;

use Anax\DI\DIMagicTrait;
use Anax\DI\DIFactoryConfig;
use Anax\DI\Exception\Exception;
use Psr\Container\ContainerInterface;

/**
 * Extending DI factory class with magic methods for getters to allow
 * easy usage to $di as $di->service, compare to a $app.
 *
 * This version also includes autoloading of configs, views and DI services.
 */
class DISorcery extends DIFactoryConfig implements ContainerInterface
{
    use DIMagicTrait;

    /** Regex to check if a path is absolute */
    const PATH_REGEX = '~\A[A-Z]:(?![^/\\\\])~i';

    /**
     * @var array  $sources     List of sources to load from
     * @var bool   $initialized If services has been loaded before
     * @var string $appRoot     Anax app root directory
     * @var string $sourcesRoot Directory to load relative source paths
     */
    private $sources = [];
    private $initialized = false;
    private $appRoot;
    private $sourcesRoot;


    /**
     * Resolves a relative path to a custom root, if not absolute
     * @param string $root Root path
     * @param string $path Relative path to resolve
     *
     * @return string
     */
    protected function resolvePath(string $root, string $path)
    {
        return $path[0] !== DIRECTORY_SEPARATOR && preg_match(self::PATH_REGEX, $path) == 0
            ? "$root/$path"
            : $path;
    }


    /**
     * Custom loader for 'configuration' service
     *
     * @return callable
     */
    protected function configLoader(): callable
    {
        return function () {
            $config = new \Anax\Configure\Configuration();
            $dirs = array_reduce($this->sources, function ($paths, $path) {
                if (is_dir("$path/config")) {
                    $paths[] = "$path/config";
                }

                return $paths;
            }, []);

            $config->setBaseDirectories($dirs);
            return $config;
        };
    }


    /**
     * Custom loader for 'view' service.
     *
     * @return callable
     */
    protected function viewLoader(): callable
    {
        $loader = $this->loaded['view']['loader'];

        return function () use ($loader) {
            $view = $loader();
            $dirs = array_reduce($this->sources, function ($paths, $path) {
                if (is_dir("$path/view")) {
                    $paths[] = "$path/view";
                }

                return $paths;
            }, []);

            $view->setPaths($dirs);
            return $view;
        };
    }


    /**
     * Create a service from a name and an array containing details on
     * how to create it.
     * @param string $name    of service.
     * @param array  $service details to use when creating the service.
     *
     * @throws \Anax\DI\Exception\Exception when configuration is corrupt.
     * @return void
     */
    protected function createService(string $name, array $service): void
    {
        if (!isset($service["callback"])) {
            throw new Exception("The service '$name' is missing a callback.");
        }

        if (isset($service["shared"]) && $service["shared"]) {
            $this->setShared($name, $service["callback"]);
        } else {
            $this->set($name, $service["callback"]);
        }

        if (isset($service["active"]) && $service["active"]) {
            if ($this->initialized) {
                $this->get($name);
            } else {
                $this->active[$name] = null; // Set to null to show its not loaded yet
            }
        }
    }


    /**
     * Constructs class instance, loads sources from file if available.
     * @param string      $appRoot     Anax app root directory
     * @param string|null $sourcesRoot (optional) Directory to load relative source paths, defaults to "$appRoot/vendor"
     *
     * @return DISorcery
     */
    public function __construct(string $appRoot, ?string $sourcesRoot = null)
    {
        $this->appRoot = $appRoot;
        $this->sourcesRoot = $sourcesRoot ?? "$appRoot/vendor";
    }


    /**
     * Gets the source folders to load views, config and DI services from.
     *
     * @return array
     */
    public function getSources(): array
    {
        return $this->sources;
    }


    /**
     * Create services by using $item as a reference to find a
     * configuration for the services. The $item can be an array,
     * a file.php, or an directory containing files named *.php.
     *
     * @param array|string $item referencing the source for configuration.
     *
     * @return $this
     */
    public function loadServices($item) : object
    {
        if (is_array($item)) {
            $this->createServicesFromArray($item, "array");
        } else if (is_readable($item) && is_file($item)) {
            $services = require $item;
            $this->createServicesFromArray($services, $item);
        } else {
            if (is_readable("$item.php") && is_file("$item.php")) {
                $services = require "$item.php";
                $this->createServicesFromArray($services, $item);
            }

            if (is_readable($item) && is_dir($item)) {
                foreach (glob("$item/*.php") as $file) {
                    $services = require "$file";
                    $this->createServicesFromArray($services, $file);
                }
            }
        }

        return $this;
    }


    /**
     * Loads sources and initializes the services.
     * @param string|null $sourcesFile (optional) File to load other Anax source directories from.
     *
     * @return void
     */
    public function initialize(?string $sourcesFile = null): void
    {
        $this->initialized = false;
        $sources = [ $this->appRoot ];

        if (is_string($sourcesFile)) {
            $sourcesFile = $this->resolvePath($this->appRoot, $sourcesFile);
            $dirs = require $sourcesFile;

            $sources = array_map(function ($path) {
                return $this->resolvePath($this->sourcesRoot, $path);
            }, array_merge($sources, $dirs));
        }

        // Reverse the order so we overwrite the later services.
        foreach (array_reverse($sources) as $source) {
            $this->loadServices("$source/config/di");
        }

        // Path loaders in services that needs access to sources
        if (array_key_exists('configuration', $this->loaded)) {
            $this->loaded['configuration']['loader'] = $this->configLoader();
        }

        if (array_key_exists('view', $this->loaded)) {
            $this->loaded['view']['loader'] = $this->viewLoader();
        }

        $this->initialized = true;
        $this->sources = $sources;

        // Preload active services
        foreach (array_keys($this->active) as $name) {
            $this->get($name);
        }
    }
}


1		<?php
2
3		namespace Faxity\DI;
4
5		use Anax\DI\DIMagicTrait;
6		use Anax\DI\DIFactoryConfig;
7		use Anax\DI\Exception\Exception;
8		use Psr\Container\ContainerInterface;
9
10		/**
11		* Extending DI factory class with magic methods for getters to allow
12		* easy usage to $di as $di->service, compare to a $app.
13		*
14		* This version also includes autoloading of configs, views and DI services.
15		*/
16		class DISorcery extends DIFactoryConfig implements ContainerInterface
17		{
18		use DIMagicTrait;
19
20		/** Regex to check if a path is absolute */
21		const PATH_REGEX = '~\A[A-Z]:(?![^/\\\\])~i';
22
23		/**
24		* @var array $sources List of sources to load from
25		* @var bool $initialized If services has been loaded before
26		* @var string $appRoot Anax app root directory
27		* @var string $sourcesRoot Directory to load relative source paths
28		*/
29		private $sources = [];
30		private $initialized = false;
31		private $appRoot;
32		private $sourcesRoot;
33
34
35		/**
36		* Resolves a relative path to a custom root, if not absolute
37		* @param string $root Root path
38		* @param string $path Relative path to resolve
39		*
40		* @return string
41		*/
42	2	protected function resolvePath(string $root, string $path)
43		{
44	2	return $path[0] !== DIRECTORY_SEPARATOR && preg_match(self::PATH_REGEX, $path) == 0
45	2	? "$root/$path"
46	2	: $path;
47		}
48
49
50		/**
51		* Custom loader for 'configuration' service
52		*
53		* @return callable
54		*/
55	1	protected function configLoader(): callable
56		{
57		return function () {
58	1	$config = new \Anax\Configure\Configuration();
59		$dirs = array_reduce($this->sources, function ($paths, $path) {
60	1	if (is_dir("$path/config")) {
61	1	$paths[] = "$path/config";
62		}
63
64	1	return $paths;
65	1	}, []);
66
67	1	$config->setBaseDirectories($dirs);
68	1	return $config;
69	1	};
70		}
71
72
73		/**
74		* Custom loader for 'view' service.
75		*
76		* @return callable
77		*/
78	1	protected function viewLoader(): callable
79		{
80	1	$loader = $this->loaded['view']['loader'];
81
82		return function () use ($loader) {
83	1	$view = $loader();
84		$dirs = array_reduce($this->sources, function ($paths, $path) {
85	1	if (is_dir("$path/view")) {
86	1	$paths[] = "$path/view";
87		}
88
89	1	return $paths;
90	1	}, []);
91
92	1	$view->setPaths($dirs);
93	1	return $view;
94	1	};
95		}
96
97
98		/**
99		* Create a service from a name and an array containing details on
100		* how to create it.
101		* @param string $name of service.
102		* @param array $service details to use when creating the service.
103		*
104		* @throws \Anax\DI\Exception\Exception when configuration is corrupt.
105		* @return void
106		*/
107	5	protected function createService(string $name, array $service): void
108		{
109	5	if (!isset($service["callback"])) {
110	1	throw new Exception("The service '$name' is missing a callback.");
111		}
112
113	4	if (isset($service["shared"]) && $service["shared"]) {
114	4	$this->setShared($name, $service["callback"]);
115		} else {
116	3	$this->set($name, $service["callback"]);
117		}
118
119	4	if (isset($service["active"]) && $service["active"]) {
120	3	if ($this->initialized) {
121	1	$this->get($name);
122		} else {
123	2	$this->active[$name] = null; // Set to null to show its not loaded yet
124		}
125		}
126	4	}
127
128
129		/**
130		* Constructs class instance, loads sources from file if available.
131		* @param string $appRoot Anax app root directory
132		* @param string\|null $sourcesRoot (optional) Directory to load relative source paths, defaults to "$appRoot/vendor"
133		*
134		* @return DISorcery
135		*/
136	6	public function __construct(string $appRoot, ?string $sourcesRoot = null)
137		{
138	6	$this->appRoot = $appRoot;
139	6	$this->sourcesRoot = $sourcesRoot ?? "$appRoot/vendor";
140	6	}
141
142
143		/**
144		* Gets the source folders to load views, config and DI services from.
145		*
146		* @return array
147		*/
148	2	public function getSources(): array
149		{
150	2	return $this->sources;
151		}
152
153
154		/**
155		* Create services by using $item as a reference to find a
156		* configuration for the services. The $item can be an array,
157		* a file.php, or an directory containing files named *.php.
158		*
159		* @param array\|string $item referencing the source for configuration.
160		*
161		* @return $this
162		*/
163	6	public function loadServices($item) : object
164		{
165	6	if (is_array($item)) {
166	1	$this->createServicesFromArray($item, "array");
167	6	} else if (is_readable($item) && is_file($item)) {
168	1	$services = require $item;
169	1	$this->createServicesFromArray($services, $item);
170		} else {
171	6	if (is_readable("$item.php") && is_file("$item.php")) {
172	1	$services = require "$item.php";
173	1	$this->createServicesFromArray($services, $item);
174		}
175
176	6	if (is_readable($item) && is_dir($item)) {
177	4	foreach (glob("$item/*.php") as $file) {
178	4	$services = require "$file";
179	4	$this->createServicesFromArray($services, $file);
180		}
181		}
182		}
183
184	5	return $this;
185		}
186
187
188		/**
189		* Loads sources and initializes the services.
190		* @param string\|null $sourcesFile (optional) File to load other Anax source directories from.
191		*
192		* @return void
193		*/
194	6	public function initialize(?string $sourcesFile = null): void
195		{
196	6	$this->initialized = false;
197	6	$sources = [ $this->appRoot ];
198
199	6	if (is_string($sourcesFile)) {
200	2	$sourcesFile = $this->resolvePath($this->appRoot, $sourcesFile);
201	2	$dirs = require $sourcesFile;
202
203		$sources = array_map(function ($path) {
204	2	return $this->resolvePath($this->sourcesRoot, $path);
205	2	}, array_merge($sources, $dirs));
206		}
207
208		// Reverse the order so we overwrite the later services.
209	6	foreach (array_reverse($sources) as $source) {
210	6	$this->loadServices("$source/config/di");
211		}
212
213		// Path loaders in services that needs access to sources
214	5	if (array_key_exists('configuration', $this->loaded)) {
215	1	$this->loaded['configuration']['loader'] = $this->configLoader();
216		}
217
218	5	if (array_key_exists('view', $this->loaded)) {
219	1	$this->loaded['view']['loader'] = $this->viewLoader();
220		}
221
222	5	$this->initialized = true;
223	5	$this->sources = $sources;
224
225		// Preload active services
226	5	foreach (array_keys($this->active) as $name) {
227	2	$this->get($name);
228		}
229	5	}
230		}
231

iFaxity / di-sorcery

DISorcery::__construct() A last analyzed 2020-05-10 00:22 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

DISorcery::__construct() A
last analyzed 2020-05-10 00:22 UTC