ContainerBuilder::applyClassDefinitions() - Code Metrics - Inspection of "updated documentation" - fwk/Di - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feat-events-tags ( 343dc9...26067f )

by Julien

created 2016-05-29 22:40 UTC

ContainerBuilder::applyClassDefinitions() B

↳ Parent: ContainerBuilder

Complexity

Conditions	4
Paths	5

Size

Total Lines	24
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	18
CRAP Score	4

Importance

Changes	6
Bugs	1	Features	4

Metric	Value
c	6
b	1
f	4
dl	0
loc	24
ccs	18
cts	18
cp	1
rs	8.6845
cc	4
eloc	16
nc	5
nop	2
crap	4

<?php
/**
 * Fwk
 *
 * Copyright (c) 2011-2012, Julien Ballestracci <[email protected]>.
 * All rights reserved.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * PHP Version 5.3
 *
 * @category  DependencyInjection
 * @package   Fwk\Di
 * @author    Julien Ballestracci <[email protected]>
 * @copyright 2011-2014 Julien Ballestracci <[email protected]>
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link      http://www.nitronet.org/fwk
 */
namespace Fwk\Di\Xml;

use Fwk\Di\Definitions\ClassDefinition;
use Fwk\Di\Definitions\LazyClassDefinition;
use Fwk\Di\Exception;
use Fwk\Xml\Map;
use Fwk\Di\Container;
use Fwk\Xml\XmlFile;
use Fwk\Di\Definitions\ArrayDefinition;

/**
 * ContainerBuilder
 * 
 * Builds or extends an existing Container using an Xml Map
 *
 * @category Xml
 * @package  Fwk\Di
 * @author   Julien Ballestracci <[email protected]>
 * @license  http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link     http://www.nitronet.org/fwk
 */
class ContainerBuilder
{
    /**
     * The Map that should return definitions from an Xml file
     * @var Map
     */
    protected $map;
    
    /**
     * Constructor
     * 
     * If no Map is specified, the builder will use the ContainerXmlMap.
     * 
     * @param null|Map $map The Xml Map used to parse the Xml file
     * 
     * @return void

     */
    public function __construct(Map $map = null)
    {
        if (is_null($map)) {
            $map = new ContainerXmlMap();
        }
        
        $this->map = $map;
    }
    
    /**
     * Registers Xml definitions to the provided Container.
     * If no Container is provided, a new one will be created.
     * 
     * @param string|XmlFile $file      Path to Xml (or XmlFile instance)
     * @param null|Container $container Container where definitions are added
     * 
     * @return Container
     */
    public function execute($file, Container $container = null)
    {
        if (!$file instanceof XmlFile) {
            $file = new XmlFile($file);
        }
        if (null === $container) {
            $container = new Container();
        }
        
        $results = $this->map->execute($file);
        
        $container->setProperty('packageDir', dirname($file->getRealPath()));
        $this->applyIniFiles($results['ini'], $container, $file);
        $this->applyDefinitions($results['definitions'], $container);
        $this->applyArrayDefinitions($results['arrayDefs'], $container);
        $this->applyClassDefinitions($results['classDefs'], $container);
        $this->applyListeners($results['listeners'], $container);

        return $container;
    }
    
    
    /**
     * Converts XML definitions from parsing results
     * 
     * @param array     $inis      Parsing results
     * @param Container $container The Di Container
     * @param XmlFile   $file      The XmlFile instance
     * 
     * @return void
     */
    protected function applyIniFiles(array $inis, Container $container, 
        XmlFile $file
    ) {
        foreach ($inis as $infos) {
            $container->iniProperties(
                str_replace(
                    ':baseDir', 
                    dirname($file->getRealPath()), 
                    $infos['value']
                ), 
                $infos['category']
            );
        }
    }
    
    /**
     * Converts XML definitions from parsing results
     * 
     * @param array     $definitions Parsing results
     * @param Container $container   The Di Container
     * 
     * @return void
     */
    protected function applyDefinitions(array $definitions, 
        Container $container
    ) {
        foreach ($definitions as $name => $infos) {
            $container->set(
                $container->propertizeString($name), 
                $container->propertizeString($infos['value'])
            );
        }
    }
    
    /**
     * Converts XML class definitions from parsing results
     * 
     * @param array     $classDefs Parsing results
     * @param Container $container The Di Container
     * 
     * @return void
     */
    protected function applyClassDefinitions(array $classDefs, 
        Container $container
    ) {
        foreach ($classDefs as $name => $infos) {
            $shared = (bool)$this->transformValueType($infos['shared']);
            $lazy = (bool)$this->transformValueType($infos['lazy']);
            $defClass = ($lazy ? LazyClassDefinition::class : ClassDefinition::class);
            $def = new $defClass(
                $infos['className'], 
                $infos['arguments']
            );
            foreach ($infos['methodsCalls'] as $mnfos) {
                $def->addMethodCall(
                    $container->propertizeString($mnfos['method']), 
                    $mnfos['arguments']
                );
            }

            $def->setShared($shared)
                ->setData($infos['data']);
            
            $container->set($name, $def);
        }
    }
    
    /**
     * Converts XML Array definitions from parsing results
     * 
     * @param array     $arrayDefs Parsing results
     * @param Container $container The Di Container
     * 
     * @return void
     */
    protected function applyArrayDefinitions(array $arrayDefs, 
        Container $container
    ) {
        foreach ($arrayDefs as $name => $infos) {
            $shared = (bool)$this->transformValueType($infos['shared']);
            $array  = array();
            foreach ($infos['params'] as $mnfos) {
                $key = (empty($mnfos['key']) ? null : $mnfos['key']);
                $val = $this->transformValueType($mnfos['value']);
                
                if (!empty($key)) {
                    $array[$key] = $val;
                } else {
                    $array[] = $val;
                }
            }

            $def = ArrayDefinition::factory($array)
                    ->setShared($shared)
                    ->setData($infos['data']);

            $container->set($name, $def);
        }
    }

    /**
     * Converts XML definitions from parsing results
     *
     * @param array     $listeners Parsing results
     * @param Container $container The Di Container
     *
     * @return void
     */
    protected function applyListeners(array $listeners, Container $container)
    {
        foreach ($listeners as $infos) {
            $class = $infos['class'];
            $service = $infos['service'];

            if (empty($class) && empty($service)) {
                throw new Exception('Invalid Xml Listener: either "class" or "service" attribute must be defined.');
            }

            if (!empty($class)) {
                $def = new ClassDefinition($class);
                $container->addListener($def->invoke($container));
                continue;
            }

            if (!$container->has($service)) {
                throw new Exception(sprintf('Invalid Xml Listener service ID: "%s"', $service));
            }
            $container->addListener($container->get($service));
        }
    }
    
    /**
     * Transforms a string to a type, if known:
     * 
     * - boolean: true / false
     * - null: null
     * 
     * @param string $value The initial string value
     * 
     * @return null|string|boolean
     */
    protected function transformValueType($value)
    {
        $value = trim($value);
        if (strtolower($value) === "true") {
            $value = true;
        } elseif (strtolower($value) === "false") {
            $value = false;
        } elseif (strtolower($value) === "null") {
            $value = null;
        }
        
        return $value;
    }
    
    /**
     * Returns the Xml Map
     * 
     * @return Map
     */
    public function getMap()
    {
        return $this->map;
    }

    /**
     * Defines the Xml Map used to parse definitions from the Xml file
     * 
     * @param Map $map The Xml Map 
     * 
     * @return void
     */
    public function setMap(Map $map)
    {
        $this->map = $map;
    }
}

1		<?php
2		/**
3		* Fwk
4		*
5		* Copyright (c) 2011-2012, Julien Ballestracci <[email protected]>.
6		* All rights reserved.
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*
11		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
12		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
13		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
14		* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
15		* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
16		* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
17		* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
18		* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
19		* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20		* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
21		* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
22		* POSSIBILITY OF SUCH DAMAGE.
23		*
24		* PHP Version 5.3
25		*
26		* @category DependencyInjection
27		* @package Fwk\Di
28		* @author Julien Ballestracci <[email protected]>
29		* @copyright 2011-2014 Julien Ballestracci <[email protected]>
30		* @license http://www.opensource.org/licenses/bsd-license.php BSD License
31		* @link http://www.nitronet.org/fwk
32		*/
33		namespace Fwk\Di\Xml;
34
35		use Fwk\Di\Definitions\ClassDefinition;
36		use Fwk\Di\Definitions\LazyClassDefinition;
37		use Fwk\Di\Exception;
38		use Fwk\Xml\Map;
39		use Fwk\Di\Container;
40		use Fwk\Xml\XmlFile;
41		use Fwk\Di\Definitions\ArrayDefinition;
42
43		/**
44		* ContainerBuilder
45		*
46		* Builds or extends an existing Container using an Xml Map
47		*
48		* @category Xml
49		* @package Fwk\Di
50		* @author Julien Ballestracci <[email protected]>
51		* @license http://www.opensource.org/licenses/bsd-license.php BSD License
52		* @link http://www.nitronet.org/fwk
53		*/
54		class ContainerBuilder
55		{
56		/**
57		* The Map that should return definitions from an Xml file
58		* @var Map
59		*/
60		protected $map;
61
62		/**
63		* Constructor
64		*
65		* If no Map is specified, the builder will use the ContainerXmlMap.
66		*
67		* @param null\|Map $map The Xml Map used to parse the Xml file
68		*
69		* @return void
		0 ignored issues – show Comprehensibility Best Practice introduced 2015-11-23 00:41 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
70		*/
71	6	public function __construct(Map $map = null)
72		{
73	6	if (is_null($map)) {
74	6	$map = new ContainerXmlMap();
75	6	}
76
77	6	$this->map = $map;
78	6	}
79
80		/**
81		* Registers Xml definitions to the provided Container.
82		* If no Container is provided, a new one will be created.
83		*
84		* @param string\|XmlFile $file Path to Xml (or XmlFile instance)
85		* @param null\|Container $container Container where definitions are added
86		*
87		* @return Container
88		*/
89	5	public function execute($file, Container $container = null)
90		{
91	5	if (!$file instanceof XmlFile) {
92	5	$file = new XmlFile($file);
93	5	}
94	5	if (null === $container) {
95	1	$container = new Container();
96	1	}
97
98	5	$results = $this->map->execute($file);
99
100	5	$container->setProperty('packageDir', dirname($file->getRealPath()));
101	5	$this->applyIniFiles($results['ini'], $container, $file);
102	5	$this->applyDefinitions($results['definitions'], $container);
103	5	$this->applyArrayDefinitions($results['arrayDefs'], $container);
104	5	$this->applyClassDefinitions($results['classDefs'], $container);
105	5	$this->applyListeners($results['listeners'], $container);
106
107	5	return $container;
108		}
109
110
111		/**
112		* Converts XML definitions from parsing results
113		*
114		* @param array $inis Parsing results
115		* @param Container $container The Di Container
116		* @param XmlFile $file The XmlFile instance
117		*
118		* @return void
119		*/
120	5	protected function applyIniFiles(array $inis, Container $container,
121		XmlFile $file
122		) {
123	5	foreach ($inis as $infos) {
124	5	$container->iniProperties(
125	5	str_replace(
126	5	':baseDir',
127	5	dirname($file->getRealPath()),
128	5	$infos['value']
129	5	),
130	5	$infos['category']
131	5	);
132	5	}
133	5	}
134
135		/**
136		* Converts XML definitions from parsing results
137		*
138		* @param array $definitions Parsing results
139		* @param Container $container The Di Container
140		*
141		* @return void
142		*/
143	5	protected function applyDefinitions(array $definitions,
144		Container $container
145		) {
146	5	foreach ($definitions as $name => $infos) {
147	5	$container->set(
148	5	$container->propertizeString($name),
149	5	$container->propertizeString($infos['value'])
150	5	);
151	5	}
152	5	}
153	5
154		/**
155		* Converts XML class definitions from parsing results
156		*
157		* @param array $classDefs Parsing results
158		* @param Container $container The Di Container
159		*
160		* @return void
161		*/
162		protected function applyClassDefinitions(array $classDefs,
163	5	Container $container
164		) {
165		foreach ($classDefs as $name => $infos) {
166	5	$shared = (bool)$this->transformValueType($infos['shared']);
167	5	$lazy = (bool)$this->transformValueType($infos['lazy']);
168	5	$defClass = ($lazy ? LazyClassDefinition::class : ClassDefinition::class);
169	5	$def = new $defClass(
170	5	$infos['className'],
171	5	$infos['arguments']
172	5	);
173	5	foreach ($infos['methodsCalls'] as $mnfos) {
174	5	$def->addMethodCall(
175	5	$container->propertizeString($mnfos['method']),
176	5	$mnfos['arguments']
177	5	);
178	5	}
179	5
180		$def->setShared($shared)
181	5	->setData($infos['data']);
182	5
183	5	$container->set($name, $def);
184		}
185		}
186
187		/**
188		* Converts XML Array definitions from parsing results
189		*
190		* @param array $arrayDefs Parsing results
191		* @param Container $container The Di Container
192		*
193	5	* @return void
194		*/
195		protected function applyArrayDefinitions(array $arrayDefs,
196	5	Container $container
197	5	) {
198	5	foreach ($arrayDefs as $name => $infos) {
199	5	$shared = (bool)$this->transformValueType($infos['shared']);
200	5	$array = array();
201	5	foreach ($infos['params'] as $mnfos) {
202		$key = (empty($mnfos['key']) ? null : $mnfos['key']);
203	5	$val = $this->transformValueType($mnfos['value']);
204	5
205	5	if (!empty($key)) {
206		$array[$key] = $val;
207		} else {
208	5	$array[] = $val;
209		}
210	5	}
211	5
212	5	$def = ArrayDefinition::factory($array)
213		->setShared($shared)
214		->setData($infos['data']);
215
216		$container->set($name, $def);
217		}
218		}
219
220		/**
221		* Converts XML definitions from parsing results
222	5	*
223		* @param array $listeners Parsing results
224	5	* @param Container $container The Di Container
225	5	*
226	5	* @return void
227		*/
228	5	protected function applyListeners(array $listeners, Container $container)
229		{
230		foreach ($listeners as $infos) {
231		$class = $infos['class'];
232	5	$service = $infos['service'];
233	5
234	5	if (empty($class) && empty($service)) {
235	5	throw new Exception('Invalid Xml Listener: either "class" or "service" attribute must be defined.');
236		}
237
238	5	if (!empty($class)) {
239		$def = new ClassDefinition($class);
240		$container->addListener($def->invoke($container));
241	5	continue;
242	5	}
243	5
244		if (!$container->has($service)) {
245		throw new Exception(sprintf('Invalid Xml Listener service ID: "%s"', $service));
246		}
247		$container->addListener($container->get($service));
248		}
249		}
250
251		/**
252		* Transforms a string to a type, if known:
253		*
254		* - boolean: true / false
255	5	* - null: null
256		*
257	5	* @param string $value The initial string value
258	5	*
259	5	* @return null\|string\|boolean
260	5	*/
261		protected function transformValueType($value)
262	5	{
263		$value = trim($value);
264		if (strtolower($value) === "true") {
265		$value = true;
266	5	} elseif (strtolower($value) === "false") {
267		$value = false;
268		} elseif (strtolower($value) === "null") {
269		$value = null;
270		}
271
272		return $value;
273		}
274	1
275		/**
276	1	* Returns the Xml Map
277		*
278		* @return Map
279		*/
280		public function getMap()
281		{
282		return $this->map;
283		}
284
285		/**
286	1	* Defines the Xml Map used to parse definitions from the Xml file
287		*
288	1	* @param Map $map The Xml Map
289	1	*
290		* @return void
291		*/
292		public function setMap(Map $map)
293		{
294		$this->map = $map;
295		}
296		}

fwk / Di

Push — feat-events-tags ( 343dc9...26067f )

ContainerBuilder::applyClassDefinitions() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like