Parser::__construct() - Code Metrics - Inspection of "Merge pull request #19 from poef/master" - Ariadne-CMS/arc-xml - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2edd85...fdf780 )

by Auke

created 2016-01-24 14:20 UTC

Parser::__construct() A

↳ Parent: Parser

Complexity

Conditions	3
Paths	3

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	3.3332

Importance

Changes	4
Bugs	1	Features	2

Metric	Value
c	4
b	1
f	2
dl	0
loc	9
ccs	4
cts	6
cp	0.6667
rs	9.6666
cc	3
eloc	5
nc	3
nop	1
crap	3.3332

<?php
/*
 * This file is part of the Ariadne Component Library.
 *
 * (c) Muze <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace arc\xml;

/**
 * This class implements a XML parser based on DOMDocument->loadXML()
 * But it returns a Proxy for both SimpleXMLElement and DOMElement.
 * It also allows parsing of partial XML content.
 */
class Parser
{

    /**
     * A list of namespaces to use when importing partial xml
     * @var string[] $namespaces
     */
    public $namespaces = array();

    /**
     * @param array $options Allows you to set the namespaces property immediately
     */
    public function __construct( $options = array() )
    {
        $optionList = array( 'namespaces' );
        foreach( $options as $option => $optionValue) {
            if (in_array( $option, $optionList )) {
                $this->{$option} = $optionValue;
            }
        }
    }

    /**
     * Parses an XML string and returns a Proxy for it.
     * @param string|Proxy|null $xml
     * @param string $encoding The character set to use, defaults to UTF-8
     * @return Proxy
     */
    public function parse( $xml=null, $encoding = null )
    {
        if (!$xml) {
            return Proxy( null );
        }
        if ($xml instanceof Proxy) { // already parsed
            return $xml->cloneNode();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        }
        $xml = (string) $xml;
        try {
            return $this->parseFull( $xml, $encoding );
        } catch( \arc\Exception $e) {
            return $this->parsePartial( $xml, $encoding );
        }
    }

    private function parsePartial( $xml, $encoding )
    {
        // add a known (single) root element with all declared namespaces
        // libxml will barf on multiple root elements
        // and it will silently drop namespace prefixes not defined in the document
        $root = '<arcxmlroot';
        foreach ($this->namespaces as $name => $uri) {
            if ($name === 0) {
                $root .= ' xmlns="';
            } else {
                $root .= ' xmlns:'.$name.'="';
            }
            $root .= htmlspecialchars( $uri ) . '"';
        }
        $root .= '>';
$a = "a";
$ab = "ab";
$abc = "abc";
        $result = $this->parseFull( $root.$xml.'</arcxmlroot>', $encoding );
        $result = $result->firstChild->childNodes;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        return $result;
    }

    private function parseFull( $xml, $encoding = null )
    {
        $dom = new \DomDocument();
        if ($encoding) {
            $xml = '<?xml encoding="' . $encoding . '">' . $xml;
        }
        libxml_disable_entity_loader(); // prevents XXE attacks
        $prevErrorSetting = libxml_use_internal_errors(true);
        if ($dom->loadXML( $xml )) {
            if ($encoding) {
                foreach( $dom->childNodes as $item) {
                    if ($item->nodeType == XML_PI_NODE) {
                        $dom->removeChild( $item );
                        break;
                    }
                }
                $dom->encoding = $encoding;
            }
	        libxml_use_internal_errors( $prevErrorSetting );
            return new Proxy( simplexml_import_dom( $dom ), $this );
        }
        $errors = libxml_get_errors();
        libxml_clear_errors();
        libxml_use_internal_errors( $prevErrorSetting );
        $message = 'Incorrect xml passed.';
        foreach ($errors as $error) {
            $message .= '\nline: '.$error->line.'; column: '.$error->column.'; '.$error->message;
        }
        throw new \arc\Exception( $message, \arc\exceptions::ILLEGAL_ARGUMENT );
    }
}


1		<?php
2		/*
3		* This file is part of the Ariadne Component Library.
4		*
5		* (c) Muze <[email protected]>
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*/
10
11		namespace arc\xml;
12
13		/**
14		* This class implements a XML parser based on DOMDocument->loadXML()
15		* But it returns a Proxy for both SimpleXMLElement and DOMElement.
16		* It also allows parsing of partial XML content.
17		*/
18		class Parser
19		{
20
21		/**
22		* A list of namespaces to use when importing partial xml
23		* @var string[] $namespaces
24		*/
25		public $namespaces = array();
26
27		/**
28		* @param array $options Allows you to set the namespaces property immediately
29		*/
30	6	public function __construct( $options = array() )
31		{
32	6	$optionList = array( 'namespaces' );
33	6	foreach( $options as $option => $optionValue) {
34		if (in_array( $option, $optionList )) {
35		$this->{$option} = $optionValue;
36		}
37		}
38	6	}
39
40		/**
41		* Parses an XML string and returns a Proxy for it.
42		* @param string\|Proxy\|null $xml
43		* @param string $encoding The character set to use, defaults to UTF-8
44		* @return Proxy
45		*/
46	6	public function parse( $xml=null, $encoding = null )
47		{
48	6	if (!$xml) {
49		return Proxy( null );
50		}
51	6	if ($xml instanceof Proxy) { // already parsed
52		return $xml->cloneNode();
		0 ignored issues – show Documentation Bug introduced 2016-01-23 21:15 UTC by Report Bug Copy Issue Report The method `cloneNode` does not exist on `object<arc\xml\Proxy>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
53		}
54	6	$xml = (string) $xml;
55		try {
56	6	return $this->parseFull( $xml, $encoding );
57	1	} catch( \arc\Exception $e) {
58	1	return $this->parsePartial( $xml, $encoding );
59		}
60		}
61
62	1	private function parsePartial( $xml, $encoding )
63		{
64		// add a known (single) root element with all declared namespaces
65		// libxml will barf on multiple root elements
66		// and it will silently drop namespace prefixes not defined in the document
67	1	$root = '<arcxmlroot';
68	1	foreach ($this->namespaces as $name => $uri) {
69		if ($name === 0) {
70		$root .= ' xmlns="';
71		} else {
72		$root .= ' xmlns:'.$name.'="';
73		}
74		$root .= htmlspecialchars( $uri ) . '"';
75		}
76	1	$root .= '>';
		0 ignored issues – show Coding Style introduced 2016-01-17 16:47 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
77	1	$result = $this->parseFull( $root.$xml.'</arcxmlroot>', $encoding );
78		$result = $result->firstChild->childNodes;
		0 ignored issues – show Documentation introduced 2015-12-24 15:06 UTC by Report Bug Copy Issue Report The property `firstChild` does not exist on `object<arc\xml\Proxy>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
79		return $result;
80		}
81
82	6	private function parseFull( $xml, $encoding = null )
83		{
84	6	$dom = new \DomDocument();
85	6	if ($encoding) {
86		$xml = '<?xml encoding="' . $encoding . '">' . $xml;
87		}
88	6	libxml_disable_entity_loader(); // prevents XXE attacks
89	6	$prevErrorSetting = libxml_use_internal_errors(true);
90	6	if ($dom->loadXML( $xml )) {
91	6	if ($encoding) {
92		foreach( $dom->childNodes as $item) {
93		if ($item->nodeType == XML_PI_NODE) {
94		$dom->removeChild( $item );
95		break;
96		}
97		}
98		$dom->encoding = $encoding;
99		}
100	6	libxml_use_internal_errors( $prevErrorSetting );
101	6	return new Proxy( simplexml_import_dom( $dom ), $this );
102		}
103	1	$errors = libxml_get_errors();
104	1	libxml_clear_errors();
105	1	libxml_use_internal_errors( $prevErrorSetting );
106	1	$message = 'Incorrect xml passed.';
107	1	foreach ($errors as $error) {
108	1	$message .= '\nline: '.$error->line.'; column: '.$error->column.'; '.$error->message;
109		}
110	1	throw new \arc\Exception( $message, \arc\exceptions::ILLEGAL_ARGUMENT );
111		}
112		}
113

Ariadne-CMS / arc-xml

Push — master ( 2edd85...fdf780 )

Parser::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like