Container::buildDependenciesTree() - Code Metrics - Inspection of "Added TODO about recurrent dependencies and added..." - samsonframework/di - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 515c2c...37ac0c )

by Vitaly

created 2016-01-25 12:40 UTC

Container::buildDependenciesTree() B

↳ Parent: Container

Complexity

Conditions	6
Paths	4

Size

Total Lines	34
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	18
CRAP Score	6.0052

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	34
ccs	18
cts	19
cp	0.9474
rs	8.439
cc	6
eloc	16
nc	4
nop	2
crap	6.0052

<?php
/**
 * Created by Vitaly Iegorov <[email protected]>.
 * on 22.01.16 at 23:53
 */
namespace samsonframework\di;

use samsonframework\di\exception\ClassNotFoundException;
use samsonframework\di\exception\ContainerException;
use samsonframework\di\exception\NotFoundException;

//TODO: caching
//TODO: Interface & abstract class resolving
//TODO: Other parameter types(not hintable) resolving
//TODO: Lazy creation by default

/**
 * Class Container
 * @package samsonframework\di
 */
class Container implements ContainerInterface
{
    /** @var array[string] Collection of loaded services */
    protected $services = array();

    /** @var array[string] Collection of alias => class name for alias resolving*/
    protected $aliases = array();

    /** @var array[string] Collection of class name dependencies trees */
    protected $dependencies = array();

    /**
     * Get reflection paramater class name type hint if present without
     * autoloading and throwing exceptions.
     *
     * @param \ReflectionParameter $param Parameter for parsing
     *
     * @return string|null Class name typehint or null
     */
    protected function getClassName(\ReflectionParameter $param) {
        preg_match('/\[\s\<\w+?>\s([\w\\\\]+)/s', $param->__toString(), $matches);
        return isset($matches[1]) && $matches[1] !== 'array' ? '\\' . ltrim($matches[1], '\\') : null;
    }

    /**
     * Recursively build class constructor dependencies tree.
     * TODO: Analyze recurrent dependencies and throw an error
     *
     * @param string $className    Current class name for analyzing
     * @param array  $dependencies Reference to tree for filling up
     *
     * @return array [string] Multidimensional array as dependency tree
     * @throws ClassNotFoundException
     */
    protected function buildDependenciesTree($className, array &$dependencies = array())
    {
        // We need this class to exists to use reflections, it will try to autoload it also
        if (class_exists($className)) {
            $class = new \ReflectionClass($className);
            // We can build dependency tree only from constructor dependencies
            $constructor = $class->getConstructor();
            if (null !== $constructor) {
                // Iterate all dependencies
                foreach ($constructor->getParameters() as $parameter) {
                    // Ignore optional parameters
                    if (!$parameter->isOptional()) {
                        // Read dependency class name
                        $dependencyClass = $this->getClassName($parameter);

                        // If we have found dependency class
                        if ($dependencyClass !== null) {
                            // Point dependency class name
                            $dependencies[$className][$parameter->getName()] = $dependencyClass;
                            // Go deeper in recursion and pass new branch there
                            $this->buildDependenciesTree($dependencyClass, $dependencies);
                        }

                    } else { // Stop iterating as first optional parameter is met
                        break;
                    }
                }
            }
        } else { // Something went wrong and class is not auto loaded and missing
            throw new ClassNotFoundException($className);
        }

        return $dependencies;
    }

    /**
     * Finds an entry of the container by its identifier and returns it.
     *
     * @param string $id Identifier of the entry to look for.
     *
     * @throws NotFoundException  No entry was found for this identifier.
     * @throws ContainerException Error while retrieving the entry.
     *
     * @return mixed Entry.
     */
    public function get($id)
    {
        // Set pointer to module
        $module = &$this->services[$id];

        if (null === $module) {
            throw new NotFoundException($id);
        } else {
            if (!is_object($module)) {
                throw new ContainerException($id);
            } else {
                return $module;
            }
        }
    }

    /**
     * Returns true if the container can return an entry for the given identifier.
     * Returns false otherwise.
     *
     * @param string $id Identifier of the entry to look for.
     *
     * @return boolean
     */
    public function has($id)
    {
        return isset($this->services[$id]) || isset($this->aliases[$id]);
    }

    /**
     * Set dependency alias with callback function.
     *
     * @param callable $callable Callable to return dependency
     * @param string   $alias    Dependency name
     *
     * @return self Chaining
     */
    public function callback($callable, $alias = null)
    {
        // TODO: Implement callback() method.
    }

    /**
     * Set service dependency. Upon first creation of this class instance
     * it would be used everywhere where this dependency is needed.
     *
     * @param string $className  Fully qualified class name
     * @param string $alias      Dependency name
     * @param array  $parameters Collection of parameters needed for dependency creation
     *
     * @return self Chaining
     */
    public function service($className, $alias = null, array $parameters = array())
    {
        // TODO: Implement service() method.
    }

    /**
     * Set service dependency by passing object instance.
     *
     * @param mixed  $instance   Instance that needs to be return by this dependency
     * @param string $alias      Dependency name
     * @param array  $parameters Collection of parameters needed for dependency creation
     *
     * @return self Chaining
     */
    public function instance(&$instance, $alias = null, array $parameters = array())
    {

        // TODO: Implement instance() method.
    }

    /**
     * Set dependency.
     *
     * @param string $className  Fully qualified class name
     * @param string $alias      Dependency name
     * @param array  $parameters Collection of parameters needed for dependency creation
     *
     * @return ContainerInterface Chaining
     */
    public function set($className, $alias = null, array $parameters = array())
    {
        // Add this class dependencies to dependency tree
        $this->dependencies = array_merge(
            $this->dependencies,
            $this->buildDependenciesTree($className, $this->dependencies)
        );

        // Merge other class constructor parameters
        $this->dependencies[$className] = array_merge($this->dependencies[$className], $parameters);

        var_dump($this->dependencies);

    }
}


1		<?php
2		/**
3		* Created by Vitaly Iegorov <[email protected]>.
4		* on 22.01.16 at 23:53
5		*/
6		namespace samsonframework\di;
7
8		use samsonframework\di\exception\ClassNotFoundException;
9		use samsonframework\di\exception\ContainerException;
10		use samsonframework\di\exception\NotFoundException;
11
12		//TODO: caching
13		//TODO: Interface & abstract class resolving
14		//TODO: Other parameter types(not hintable) resolving
15		//TODO: Lazy creation by default
16
17		/**
18		* Class Container
19		* @package samsonframework\di
20		*/
21		class Container implements ContainerInterface
22		{
23		/** @var array[string] Collection of loaded services */
24		protected $services = array();
25
26		/** @var array[string] Collection of alias => class name for alias resolving*/
27		protected $aliases = array();
28
29		/** @var array[string] Collection of class name dependencies trees */
30		protected $dependencies = array();
31
32		/**
33		* Get reflection paramater class name type hint if present without
34		* autoloading and throwing exceptions.
35		*
36		* @param \ReflectionParameter $param Parameter for parsing
37		*
38		* @return string\|null Class name typehint or null
39		*/
40	1	protected function getClassName(\ReflectionParameter $param) {
41	1	preg_match('/\[\s\<\w+?>\s([\w\\\\]+)/s', $param->__toString(), $matches);
42	1	return isset($matches[1]) && $matches[1] !== 'array' ? '\\' . ltrim($matches[1], '\\') : null;
43		}
44
45		/**
46		* Recursively build class constructor dependencies tree.
47		* TODO: Analyze recurrent dependencies and throw an error
48		*
49		* @param string $className Current class name for analyzing
50		* @param array $dependencies Reference to tree for filling up
51		*
52		* @return array [string] Multidimensional array as dependency tree
53		* @throws ClassNotFoundException
54		*/
55	1	protected function buildDependenciesTree($className, array &$dependencies = array())
56		{
57		// We need this class to exists to use reflections, it will try to autoload it also
58	1	if (class_exists($className)) {
59	1	$class = new \ReflectionClass($className);
60		// We can build dependency tree only from constructor dependencies
61	1	$constructor = $class->getConstructor();
62	1	if (null !== $constructor) {
63		// Iterate all dependencies
64	1	foreach ($constructor->getParameters() as $parameter) {
65		// Ignore optional parameters
66	1	if (!$parameter->isOptional()) {
67		// Read dependency class name
68	1	$dependencyClass = $this->getClassName($parameter);
69
70		// If we have found dependency class
71	1	if ($dependencyClass !== null) {
72		// Point dependency class name
73	1	$dependencies[$className][$parameter->getName()] = $dependencyClass;
74		// Go deeper in recursion and pass new branch there
75	1	$this->buildDependenciesTree($dependencyClass, $dependencies);
76	1	}
77
78	1	} else { // Stop iterating as first optional parameter is met
79	1	break;
80		}
81	1	}
82	1	}
83	1	} else { // Something went wrong and class is not auto loaded and missing
84		throw new ClassNotFoundException($className);
85		}
86
87	1	return $dependencies;
88		}
89
90		/**
91		* Finds an entry of the container by its identifier and returns it.
92		*
93		* @param string $id Identifier of the entry to look for.
94		*
95		* @throws NotFoundException No entry was found for this identifier.
96		* @throws ContainerException Error while retrieving the entry.
97		*
98		* @return mixed Entry.
99		*/
100		public function get($id)
101		{
102		// Set pointer to module
103		$module = &$this->services[$id];
104
105		if (null === $module) {
106		throw new NotFoundException($id);
107		} else {
108		if (!is_object($module)) {
109		throw new ContainerException($id);
110		} else {
111		return $module;
112		}
113		}
114		}
115
116		/**
117		* Returns true if the container can return an entry for the given identifier.
118		* Returns false otherwise.
119		*
120		* @param string $id Identifier of the entry to look for.
121		*
122		* @return boolean
123		*/
124		public function has($id)
125		{
126		return isset($this->services[$id]) \|\| isset($this->aliases[$id]);
127		}
128
129		/**
130		* Set dependency alias with callback function.
131		*
132		* @param callable $callable Callable to return dependency
133		* @param string $alias Dependency name
134		*
135		* @return self Chaining
136		*/
137		public function callback($callable, $alias = null)
138		{
139		// TODO: Implement callback() method.
140		}
141
142		/**
143		* Set service dependency. Upon first creation of this class instance
144		* it would be used everywhere where this dependency is needed.
145		*
146		* @param string $className Fully qualified class name
147		* @param string $alias Dependency name
148		* @param array $parameters Collection of parameters needed for dependency creation
149		*
150		* @return self Chaining
151		*/
152		public function service($className, $alias = null, array $parameters = array())
153		{
154		// TODO: Implement service() method.
155		}
156
157		/**
158		* Set service dependency by passing object instance.
159		*
160		* @param mixed $instance Instance that needs to be return by this dependency
161		* @param string $alias Dependency name
162		* @param array $parameters Collection of parameters needed for dependency creation
163		*
164		* @return self Chaining
165		*/
166		public function instance(&$instance, $alias = null, array $parameters = array())
167		{
168
169		// TODO: Implement instance() method.
170		}
171
172		/**
173		* Set dependency.
174		*
175		* @param string $className Fully qualified class name
176		* @param string $alias Dependency name
177		* @param array $parameters Collection of parameters needed for dependency creation
178		*
179		* @return ContainerInterface Chaining
180		*/
181	1	public function set($className, $alias = null, array $parameters = array())
182		{
183		// Add this class dependencies to dependency tree
184	1	$this->dependencies = array_merge(
185	1	$this->dependencies,
186	1	$this->buildDependenciesTree($className, $this->dependencies)
187	1	);
188
189		// Merge other class constructor parameters
190	1	$this->dependencies[$className] = array_merge($this->dependencies[$className], $parameters);
191
192	1	var_dump($this->dependencies);
		0 ignored issues – show Security Debugging Code introduced 2016-01-25 12:30 UTC by Report Bug Copy Issue Report `var_dump($this->dependencies);` looks like debug code. Are you sure you do not want to remove it? This might expose sensitive data. Loading history...
193	1	}
194		}
195

samsonframework / di

Push — master ( 515c2c...37ac0c )

Container::buildDependenciesTree() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like