Map::getPaths() - Code Metrics - fwk/Xml - Measure and Improve Code Quality continuously with Scrutinizer

Map::getPaths() A
last analyzed 2016-06-28 21:07 UTC

↳ Parent: Map

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	3
Bugs	2	Features	1

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

<?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  XML
 * @package   Fwk\Xml
 * @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\Xml;

use \SimpleXMLElement;

/**
 * Map
 *
 * Once executed on a XmlFile, it transforms XML data into an Array according
 * to defined Paths.
 *
 * @category Library
 * @package  Fwk\Xml
 * @author   Julien Ballestracci <[email protected]>
 * @license  http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link     http://www.nitronet.org/fwk
 */
class Map
{
    /**
     * List of Paths
     * @var array
     */
    protected $paths = array();

    /**
     * List of registered namespaces
     * @var array
     */
    protected $namespaces = array();

    /**
     * Adds a Path to this map
     *
     * @param Path|array $path Path (or list of Paths) to be added
     *
     * @throws \InvalidArgumentException if $path is not Path and not an array
     * @return Map
     */
    public function add($path)
    {
        if (!is_array($path)) {
            $path = array($path);
        }

        foreach ($path as $current) {
            if (!$current instanceof Path) {
                throw new \InvalidArgumentException('Argument is not a Path');
            }
            $this->paths[] = $current;
        }

        return $this;
    }

    /**
     * Removes a Path from this map
     *
     * @param Path $path Path object to be removed
     *
     * @return Map
     */
    public function remove(Path $path)
    {
        $paths = array();
        foreach ($this->paths as $current) {
            if ($current !== $path) {
                array_push($paths, $current);
            }
        }

        $this->paths = $paths;

        return $this;
    }

    /**
     * Registers a namespace prefix
     * 
     * @param string $nsPrefix     NS prefix 
     * @param string $namespaceUrl URL to namespace definition
     *
     * @return Map
     */
    public function registerNamespace($nsPrefix, $namespaceUrl)
    {
        $this->namespaces[$nsPrefix] = $namespaceUrl;

        return $this;
    }

    /**
     * Executes the Map against the XmlFile and return parsed values as a PHP
     * array.
     *
     * @param XmlFile $file The XML file
     *
     * @return array
     */
    public function execute(XmlFile $file)
    {
        $paths = $this->paths;
        $final = array();

        $this->registerNamespaces($file);

        foreach ($paths as $path) {
            $key    = $path->getKey();
            $sxml   = $file->xpath($path->getXpath());
            $value  = $path->getDefault();
            if (is_array($sxml) && count($sxml)) {
                $value = $this->pathToValue($sxml, $path);
            } 
            
            $final[$key]    = $value;
        }

        return $final;
    }

    /**
     * Transform a Path to a value.
     *
     * @param array $sxml Current Xpath result
     * @param Path  $path Current Path
     *
     * @return mixed
     */
    protected function pathToValue(array $sxml, Path $path)
    {
        $value = null;

        $this->registerNamespaces(null, $sxml);

        foreach ($sxml as $result) {
            $current = $this->getAttributesArray($path, $result);
            if ($path->isLoop()) {
                if (!count($path->getAttributes())
                    && !count($path->getChildrens())
                ) {
                    $current = $this->getFilteredValue($path, trim((string)$result));
                } elseif (!count($path->getChildrens()) && $path->hasValueKey()) {
                    $val = $this->getFilteredValue($path, trim((string)$result));
                    $current[$path->getValueKey()] = $val;
                } elseif (count($path->getChildrens())) {
                    $current += $this->getChildrens($path, $result);
                }

                $loopId = $path->getLoopId();
                if (empty($loopId)) {
                    $value[] = $current;
                } else {
                    $idValue = $result->xpath($loopId);
                    if (!count($idValue)) {
                        $value[] = $current;
                    } else {
                        $value[trim((string)$idValue[0])] = $current;
                    }
                }
            } else {
                if (!count($path->getAttributes())
                    && !count($path->getChildrens())
                ) {
                    $current = $this->getFilteredValue($path, trim((string)$result));
                    if (empty($current)) {
                        $current = $path->getDefault();
                    }
                } else {
                    $current += $this->getChildrens($path, $result);
                    if ($path->hasValueKey()) {
                        $current[$path->getValueKey()] = $this->getFilteredValue(
                            $path,
                            trim((string)$result)
                        );
                    }
                }
                $value = $current;
            }
        }

        return $value;
    }

    /**
     * Returns a value, filtered if needed.
     *
     * @param Path   $path  Current Path
     * @param string $value Actual value
     *
     * @return mixed
     */
    protected function getFilteredValue(Path $path, $value)
    {
        if ($path->hasFilter()) {
            return call_user_func($path->getFilter(), $value);
        }
        
        return $value;
    }


    /**
     * Returns Path attributes list
     *
     * @param Path             $path Current Path
     * @param SimpleXMLElement $node Current SimpleXML node
     *
     * @return array
     */
    protected function getAttributesArray(Path $path,
        SimpleXMLElement $node
    ) {
        $current = array();
        foreach ($path->getAttributes() as $keyName => $attr) {
            $val = (isset($node[$attr]) ? trim((string)$node[$attr]) : null);
            $current[$keyName] = self::getFilteredValue($path, $val);
        }

        return $current;
    }

    /**
     * Returns childrens values
     *
     * @param Path             $path Current Path
     * @param SimpleXMLElement $node Current SimpleXML node
     *
     * @return array
     */
    protected function getChildrens(Path $path, SimpleXMLElement $node)
    {
        $current = array();

        foreach ($path->getChildrens() as $child) {
            $key    = $child->getKey();
            $csxml  = $node->xpath($child->getXpath());
            $val    = $child->getDefault();
            
            if (is_array($csxml) && count($csxml)) {
                $val = $this->pathToValue($csxml, $child);
            } 
            
            $current[$key]  = $val;
            if ($val === null && $child->isLoop()) {
                $current[$key] = array();
            }
        }

        return $current;
    }

    /**
     * Apply rules for registered namespaces
     * 
     * @param XmlFile $file The current XmlFile object

     * @param array   $sxml SimpleXML results

     * 
     * @return void
     */
    protected function registerNamespaces(XmlFile $file = null, 
        array $sxml = null
    ) {
        if (null === $sxml && $file instanceof XmlFile) {
            foreach ($this->namespaces as $prefix => $ns) {
                $file->open()->registerXPathNamespace($prefix, $ns);
            }
        } elseif (null !== $sxml) {
            foreach ($sxml as $node) {
                foreach ($this->namespaces as $prefix => $ns) {
                    $node->registerXPathNamespace($prefix, $ns);
                }
            }
        }
    }

    /**
     * Returns Map's Paths
     *
     * @return array
     */
    public function getPaths()
    {
        return $this->paths;
    }
}

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 XML
27		* @package Fwk\Xml
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\Xml;
34
35		use \SimpleXMLElement;
36
37		/**
38		* Map
39		*
40		* Once executed on a XmlFile, it transforms XML data into an Array according
41		* to defined Paths.
42		*
43		* @category Library
44		* @package Fwk\Xml
45		* @author Julien Ballestracci <[email protected]>
46		* @license http://www.opensource.org/licenses/bsd-license.php BSD License
47		* @link http://www.nitronet.org/fwk
48		*/
49		class Map
50		{
51		/**
52		* List of Paths
53		* @var array
54		*/
55		protected $paths = array();
56
57		/**
58		* List of registered namespaces
59		* @var array
60		*/
61		protected $namespaces = array();
62
63		/**
64		* Adds a Path to this map
65		*
66		* @param Path\|array $path Path (or list of Paths) to be added
67		*
68		* @throws \InvalidArgumentException if $path is not Path and not an array
69		* @return Map
70		*/
71	14	public function add($path)
72		{
73	14	if (!is_array($path)) {
74	12	$path = array($path);
75		}
76
77	14	foreach ($path as $current) {
78	14	if (!$current instanceof Path) {
79	1	throw new \InvalidArgumentException('Argument is not a Path');
80		}
81	13	$this->paths[] = $current;
82		}
83
84	13	return $this;
85		}
86
87		/**
88		* Removes a Path from this map
89		*
90		* @param Path $path Path object to be removed
91		*
92		* @return Map
93		*/
94	1	public function remove(Path $path)
95		{
96	1	$paths = array();
97	1	foreach ($this->paths as $current) {
98	1	if ($current !== $path) {
99	1	array_push($paths, $current);
100		}
101		}
102
103	1	$this->paths = $paths;
104
105	1	return $this;
106		}
107
108		/**
109		* Registers a namespace prefix
110		*
111		* @param string $nsPrefix NS prefix
112		* @param string $namespaceUrl URL to namespace definition
113		*
114		* @return Map
115		*/
116	1	public function registerNamespace($nsPrefix, $namespaceUrl)
117		{
118	1	$this->namespaces[$nsPrefix] = $namespaceUrl;
119
120	1	return $this;
121		}
122
123		/**
124		* Executes the Map against the XmlFile and return parsed values as a PHP
125		* array.
126		*
127		* @param XmlFile $file The XML file
128		*
129		* @return array
130		*/
131	12	public function execute(XmlFile $file)
132		{
133	12	$paths = $this->paths;
134	12	$final = array();
135
136	12	$this->registerNamespaces($file);
137
138	12	foreach ($paths as $path) {
139	12	$key = $path->getKey();
140	12	$sxml = $file->xpath($path->getXpath());
141	12	$value = $path->getDefault();
142	12	if (is_array($sxml) && count($sxml)) {
143	11	$value = $this->pathToValue($sxml, $path);
144		}
145
146	12	$final[$key] = $value;
147		}
148
149	12	return $final;
150		}
151
152		/**
153		* Transform a Path to a value.
154		*
155		* @param array $sxml Current Xpath result
156		* @param Path $path Current Path
157		*
158		* @return mixed
159		*/
160	11	protected function pathToValue(array $sxml, Path $path)
161		{
162	11	$value = null;
163
164	11	$this->registerNamespaces(null, $sxml);
165
166	11	foreach ($sxml as $result) {
167	11	$current = $this->getAttributesArray($path, $result);
168	11	if ($path->isLoop()) {
169	7	if (!count($path->getAttributes())
170	7	&& !count($path->getChildrens())
171		) {
172	5	$current = $this->getFilteredValue($path, trim((string)$result));
173	5	} elseif (!count($path->getChildrens()) && $path->hasValueKey()) {
174	1	$val = $this->getFilteredValue($path, trim((string)$result));
175	1	$current[$path->getValueKey()] = $val;
176	4	} elseif (count($path->getChildrens())) {
177	4	$current += $this->getChildrens($path, $result);
178		}
179
180	7	$loopId = $path->getLoopId();
181	7	if (empty($loopId)) {
182	5	$value[] = $current;
183		} else {
184	2	$idValue = $result->xpath($loopId);
185	2	if (!count($idValue)) {
186	1	$value[] = $current;
187		} else {
188	7	$value[trim((string)$idValue[0])] = $current;
189		}
190		}
191		} else {
192	7	if (!count($path->getAttributes())
193	7	&& !count($path->getChildrens())
194		) {
195	6	$current = $this->getFilteredValue($path, trim((string)$result));
196	6	if (empty($current)) {
197	6	$current = $path->getDefault();
198		}
199		} else {
200	4	$current += $this->getChildrens($path, $result);
201	4	if ($path->hasValueKey()) {
202	3	$current[$path->getValueKey()] = $this->getFilteredValue(
203		$path,
204	3	trim((string)$result)
205		);
206		}
207		}
208	11	$value = $current;
209		}
210		}
211
212	11	return $value;
213		}
214
215		/**
216		* Returns a value, filtered if needed.
217		*
218		* @param Path $path Current Path
219		* @param string $value Actual value
220		*
221		* @return mixed
222		*/
223	9	protected function getFilteredValue(Path $path, $value)
224		{
225	9	if ($path->hasFilter()) {
226	1	return call_user_func($path->getFilter(), $value);
227		}
228
229	8	return $value;
230		}
231
232
233		/**
234		* Returns Path attributes list
235		*
236		* @param Path $path Current Path
237		* @param SimpleXMLElement $node Current SimpleXML node
238		*
239		* @return array
240		*/
241	11	protected function getAttributesArray(Path $path,
242		SimpleXMLElement $node
243		) {
244	11	$current = array();
245	11	foreach ($path->getAttributes() as $keyName => $attr) {
246	4	$val = (isset($node[$attr]) ? trim((string)$node[$attr]) : null);
247	4	$current[$keyName] = self::getFilteredValue($path, $val);
248		}
249
250	11	return $current;
251		}
252
253		/**
254		* Returns childrens values
255		*
256		* @param Path $path Current Path
257		* @param SimpleXMLElement $node Current SimpleXML node
258		*
259		* @return array
260		*/
261	5	protected function getChildrens(Path $path, SimpleXMLElement $node)
262		{
263	5	$current = array();
264
265	5	foreach ($path->getChildrens() as $child) {
266	5	$key = $child->getKey();
267	5	$csxml = $node->xpath($child->getXpath());
268	5	$val = $child->getDefault();
269
270	5	if (is_array($csxml) && count($csxml)) {
271	3	$val = $this->pathToValue($csxml, $child);
272		}
273
274	5	$current[$key] = $val;
275	5	if ($val === null && $child->isLoop()) {
276	5	$current[$key] = array();
277		}
278		}
279
280	5	return $current;
281		}
282
283		/**
284		* Apply rules for registered namespaces
285		*
286		* @param XmlFile $file The current XmlFile object
		0 ignored issues – show Documentation introduced 2016-06-28 20:44 UTC by Report Bug Copy Issue Report Should the type for parameter `$file` not be `null\|XmlFile`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
287		* @param array $sxml SimpleXML results
		0 ignored issues – show Documentation introduced 2016-06-28 20:44 UTC by Report Bug Copy Issue Report Should the type for parameter `$sxml` not be `null\|array`? Also, consider making the array more specific, something like `array<String>`, or `String[]`. This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. In addition it looks for parameters that have the generic type `array` and suggests a stricter type like `array<String>`. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
288		*
289		* @return void
290		*/
291	12	protected function registerNamespaces(XmlFile $file = null,
292		array $sxml = null
293		) {
294	12	if (null === $sxml && $file instanceof XmlFile) {
295	12	foreach ($this->namespaces as $prefix => $ns) {
296	12	$file->open()->registerXPathNamespace($prefix, $ns);
297		}
298	11	} elseif (null !== $sxml) {
299	11	foreach ($sxml as $node) {
300	11	foreach ($this->namespaces as $prefix => $ns) {
301	11	$node->registerXPathNamespace($prefix, $ns);
302		}
303		}
304		}
305	12	}
306
307		/**
308		* Returns Map's Paths
309		*
310		* @return array
311		*/
312	1	public function getPaths()
313		{
314	1	return $this->paths;
315		}
316		}

fwk / Xml

Map::getPaths() A last analyzed 2016-06-28 21:07 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Map::getPaths() A
last analyzed 2016-06-28 21:07 UTC