XmlParser::__callStatic() - Code Metrics - Inspection of "[+]: add "XmlParser" + simple tests" - voku/simple_html_dom - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 162761...d36330 )

by Lars

created 2019-06-29 00:25 UTC

XmlParser::__callStatic() A

↳ Parent: XmlParser

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	20
Ratio	100 %

Code Coverage

Tests	9
CRAP Score	3.009

Importance

Changes

Metric	Value
dl	20
loc	20
ccs	9
cts	10
cp	0.9
rs	9.6
c	0
b	0
f	0
cc	3
nc	3
nop	2
crap	3.009

<?php

declare(strict_types=1);

namespace voku\helper;

/**
 * @method static XmlParser file_get_xml($xml, $libXMLExtraOptions = null)
 *                                 <p>Load XML from file.</p>
 * @method static XmlParser str_get_xml($xml, $libXMLExtraOptions = null)
 *                                 <p>Load XML from string.</p>
 */
class XmlParser extends HtmlDomParser
{
    /**
     * @param string $name
     * @param array  $arguments
     *
     * @throws \BadMethodCallException
     * @throws \RuntimeException
     *
     * @return XmlParser
     */
    public static function __callStatic($name, $arguments)

    {
        $arguments0 = $arguments[0] ?? '';

        $arguments1 = $arguments[1] ?? null;

        if ($name === 'str_get_xml') {
            $parser = new static();

            return $parser->loadXml($arguments0, $arguments1);
        }

        if ($name === 'file_get_xml') {
            $parser = new static();

            return $parser->loadXmlFile($arguments0, $arguments1);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        throw new \BadMethodCallException('Method does not exist');
    }

    /**
     * @return string
     */
    public function __toString()
    {
        return $this->xml(false, false, true, 0);
    }

    /**
     * Create DOMDocument from XML.
     *
     * @param string   $xml
     * @param int|null $libXMLExtraOptions
     *
     * @return \DOMDocument
     */
    protected function createDOMDocument(string $xml, $libXMLExtraOptions = null): \DOMDocument
    {
        // set error level
        $internalErrors = \libxml_use_internal_errors(true);
        $disableEntityLoader = \libxml_disable_entity_loader(true);
        \libxml_clear_errors();

        $optionsXml = \LIBXML_DTDLOAD | \LIBXML_DTDATTR | \LIBXML_NONET;

        if (\defined('LIBXML_BIGLINES')) {
            $optionsXml |= \LIBXML_BIGLINES;
        }

        if (\defined('LIBXML_COMPACT')) {
            $optionsXml |= \LIBXML_COMPACT;
        }

        if ($libXMLExtraOptions !== null) {
            $optionsXml |= $libXMLExtraOptions;
        }

        $xml = self::replaceToPreserveHtmlEntities($xml);

        $documentFound = false;
        $sxe = \simplexml_load_string($xml, \SimpleXMLElement::class, $optionsXml);
        if ($sxe !== false && \count(\libxml_get_errors()) === 0) {

            $domElementTmp = \dom_import_simplexml($sxe);
            if ($domElementTmp) {
                $documentFound = true;
                $this->document = $domElementTmp->ownerDocument;
            }
        }

        if ($documentFound === false) {


            // UTF-8 hack: http://php.net/manual/en/domdocument.loadhtml.php#95251
            $xmlHackUsed = false;
            if (\stripos('<?xml', $xml) !== 0) {
                $xmlHackUsed = true;
                $xml = '<?xml encoding="' . $this->getEncoding() . '" ?>' . $xml;
            }

            $this->document->loadXML($xml, $optionsXml);

            // remove the "xml-encoding" hack
            if ($xmlHackUsed) {
                foreach ($this->document->childNodes as $child) {
                    if ($child->nodeType === \XML_PI_NODE) {
                        /** @noinspection UnusedFunctionResultInspection */
                        $this->document->removeChild($child);

                        break;
                    }
                }
            }
        }

        // set encoding
        $this->document->encoding = $this->getEncoding();

        // restore lib-xml settings
        \libxml_clear_errors();
        \libxml_use_internal_errors($internalErrors);
        \libxml_disable_entity_loader($disableEntityLoader);

        return $this->document;
    }

    /**
     * Load XML from string.
     *
     * @param string   $xml
     * @param int|null $libXMLExtraOptions
     *
     * @return XmlParser
     */
    public function loadXml(string $xml, $libXMLExtraOptions = null): self
    {
        $this->document = $this->createDOMDocument($xml, $libXMLExtraOptions);

        return $this;
    }

    /**
     * Load XML from file.
     *
     * @param string   $filePath
     * @param int|null $libXMLExtraOptions
     *
     * @throws \RuntimeException
     *
     * @return XmlParser
     */
    public function loadXmlFile(string $filePath, $libXMLExtraOptions = null): self

    {
        if (
            !\preg_match("/^https?:\/\//i", $filePath)
            &&
            !\file_exists($filePath)
        ) {
            throw new \RuntimeException("File ${filePath} not found");
        }

        try {
            if (\class_exists('\voku\helper\UTF8')) {
                /** @noinspection PhpUndefinedClassInspection */
                $xml = UTF8::file_get_contents($filePath);
            } else {
                $xml = \file_get_contents($filePath);
            }
        } catch (\Exception $e) {
            throw new \RuntimeException("Could not load file ${filePath}");
        }

        if ($xml === false) {
            throw new \RuntimeException("Could not load file ${filePath}");
        }

        return $this->loadXml($xml, $libXMLExtraOptions);
    }

    /**
     * @param callable      $callback
     * @param \DOMNode|null $domNode
     */
    public function replaceTextWithCallback($callback, \DOMNode $domNode = null)
    {
        if ($domNode === null) {
            $domNode = $this->document;
        }

        if ($domNode->hasChildNodes()) {
            $children = [];

            // since looping through a DOM being modified is a bad idea we prepare an array:
            foreach ($domNode->childNodes as $child) {
                $children[] = $child;
            }

            foreach ($children as $child) {
                if ($child->nodeType === \XML_TEXT_NODE) {
                    $oldText = self::putReplacedBackToPreserveHtmlEntities($child->wholeText);
                    $newText = $callback($oldText);
                    if ($domNode->ownerDocument) {
                        $newTextNode = $domNode->ownerDocument->createTextNode(self::replaceToPreserveHtmlEntities($newText));
                        $domNode->replaceChild($newTextNode, $child);
                    }
                } else {
                    $this->replaceTextWithCallback($callback, $child);
                }
            }
        }
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace voku\helper;
6
7			/**
8			* @method static XmlParser file_get_xml($xml, $libXMLExtraOptions = null)
9			* <p>Load XML from file.</p>
10			* @method static XmlParser str_get_xml($xml, $libXMLExtraOptions = null)
11			* <p>Load XML from string.</p>
12			*/
13			class XmlParser extends HtmlDomParser
14			{
15			/**
16			* @param string $name
17			* @param array $arguments
18			*
19			* @throws \BadMethodCallException
20			* @throws \RuntimeException
21			*
22			* @return XmlParser
23			*/
24	3	View Code Duplication	public static function __callStatic($name, $arguments)
			0 ignored issues – show Duplication introduced 2019-06-29 00:27 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
25			{
26	3		$arguments0 = $arguments[0] ?? '';
27
28	3		$arguments1 = $arguments[1] ?? null;
29
30	3		if ($name === 'str_get_xml') {
31	1		$parser = new static();
32
33	1		return $parser->loadXml($arguments0, $arguments1);
34			}
35
36	2		if ($name === 'file_get_xml') {
37	2		$parser = new static();
38
39	2		return $parser->loadXmlFile($arguments0, $arguments1);
			0 ignored issues – show Bug Best Practice introduced 2019-06-29 00:27 UTC by Report Bug Copy Issue Report The return type of `return $parser->loadXmlF...guments0, $arguments1);` (`self`) is incompatible with the return type documented by `voku\helper\XmlParser::__callStatic` of type `voku\helper\XmlParser`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
40			}
41
42			throw new \BadMethodCallException('Method does not exist');
43			}
44
45			/**
46			* @return string
47			*/
48	2		public function __toString()
49			{
50	2		return $this->xml(false, false, true, 0);
51			}
52
53			/**
54			* Create DOMDocument from XML.
55			*
56			* @param string $xml
57			* @param int\|null $libXMLExtraOptions
58			*
59			* @return \DOMDocument
60			*/
61	3		protected function createDOMDocument(string $xml, $libXMLExtraOptions = null): \DOMDocument
62			{
63			// set error level
64	3		$internalErrors = \libxml_use_internal_errors(true);
65	3		$disableEntityLoader = \libxml_disable_entity_loader(true);
66	3		\libxml_clear_errors();
67
68	3		$optionsXml = \LIBXML_DTDLOAD \| \LIBXML_DTDATTR \| \LIBXML_NONET;
69
70	3		if (\defined('LIBXML_BIGLINES')) {
71	3		$optionsXml \|= \LIBXML_BIGLINES;
72			}
73
74	3		if (\defined('LIBXML_COMPACT')) {
75	3		$optionsXml \|= \LIBXML_COMPACT;
76			}
77
78	3		if ($libXMLExtraOptions !== null) {
79			$optionsXml \|= $libXMLExtraOptions;
80			}
81
82	3		$xml = self::replaceToPreserveHtmlEntities($xml);
83
84	3		$documentFound = false;
85	3		$sxe = \simplexml_load_string($xml, \SimpleXMLElement::class, $optionsXml);
86	3	View Code Duplication	if ($sxe !== false && \count(\libxml_get_errors()) === 0) {
			0 ignored issues – show Duplication introduced 2019-06-29 00:27 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
87	3		$domElementTmp = \dom_import_simplexml($sxe);
88	3		if ($domElementTmp) {
89	3		$documentFound = true;
90	3		$this->document = $domElementTmp->ownerDocument;
91			}
92			}
93
94	3	View Code Duplication	if ($documentFound === false) {
			0 ignored issues – show Duplication introduced 2019-06-29 00:27 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
95
96			// UTF-8 hack: http://php.net/manual/en/domdocument.loadhtml.php#95251
97			$xmlHackUsed = false;
98			if (\stripos('<?xml', $xml) !== 0) {
99			$xmlHackUsed = true;
100			$xml = '<?xml encoding="' . $this->getEncoding() . '" ?>' . $xml;
101			}
102
103			$this->document->loadXML($xml, $optionsXml);
104
105			// remove the "xml-encoding" hack
106			if ($xmlHackUsed) {
107			foreach ($this->document->childNodes as $child) {
108			if ($child->nodeType === \XML_PI_NODE) {
109			/** @noinspection UnusedFunctionResultInspection */
110			$this->document->removeChild($child);
111
112			break;
113			}
114			}
115			}
116			}
117
118			// set encoding
119	3		$this->document->encoding = $this->getEncoding();
120
121			// restore lib-xml settings
122	3		\libxml_clear_errors();
123	3		\libxml_use_internal_errors($internalErrors);
124	3		\libxml_disable_entity_loader($disableEntityLoader);
125
126	3		return $this->document;
127			}
128
129			/**
130			* Load XML from string.
131			*
132			* @param string $xml
133			* @param int\|null $libXMLExtraOptions
134			*
135			* @return XmlParser
136			*/
137	3		public function loadXml(string $xml, $libXMLExtraOptions = null): self
138			{
139	3		$this->document = $this->createDOMDocument($xml, $libXMLExtraOptions);
140
141	3		return $this;
142			}
143
144			/**
145			* Load XML from file.
146			*
147			* @param string $filePath
148			* @param int\|null $libXMLExtraOptions
149			*
150			* @throws \RuntimeException
151			*
152			* @return XmlParser
153			*/
154	2	View Code Duplication	public function loadXmlFile(string $filePath, $libXMLExtraOptions = null): self
			0 ignored issues – show Duplication introduced 2019-06-29 00:27 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
155			{
156			if (
157	2		!\preg_match("/^https?:\/\//i", $filePath)
158			&&
159	2		!\file_exists($filePath)
160			) {
161			throw new \RuntimeException("File ${filePath} not found");
162			}
163
164			try {
165			if (\class_exists('\voku\helper\UTF8')) {
166			/** @noinspection PhpUndefinedClassInspection */
167			$xml = UTF8::file_get_contents($filePath);
168			} else {
169			$xml = \file_get_contents($filePath);
170			}
171			} catch (\Exception $e) {
172			throw new \RuntimeException("Could not load file ${filePath}");
173			}
174
175	2		if ($xml === false) {
176			throw new \RuntimeException("Could not load file ${filePath}");
177			}
178
179	2		return $this->loadXml($xml, $libXMLExtraOptions);
180			}
181
182			/**
183			* @param callable $callback
184			* @param \DOMNode\|null $domNode
185			*/
186			public function replaceTextWithCallback($callback, \DOMNode $domNode = null)
187			{
188	1		if ($domNode === null) {
189	1		$domNode = $this->document;
190			}
191
192	1		if ($domNode->hasChildNodes()) {
193	1		$children = [];
194
195			// since looping through a DOM being modified is a bad idea we prepare an array:
196	1		foreach ($domNode->childNodes as $child) {
197	1		$children[] = $child;
198			}
199
200	1		foreach ($children as $child) {
201	1		if ($child->nodeType === \XML_TEXT_NODE) {
202	1		$oldText = self::putReplacedBackToPreserveHtmlEntities($child->wholeText);
203	1		$newText = $callback($oldText);
204	1		if ($domNode->ownerDocument) {
205	1		$newTextNode = $domNode->ownerDocument->createTextNode(self::replaceToPreserveHtmlEntities($newText));
206	1		$domNode->replaceChild($newTextNode, $child);
207			}
208			} else {
209	1		$this->replaceTextWithCallback($callback, $child);
210			}
211			}
212			}
213	1		}
214			}
215

voku / simple_html_dom

Push — master ( 162761...d36330 )

XmlParser::__callStatic() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like