Resolver::relationResolve() - Code Metrics - Inspection of "fix scrutinizer issue" - xinningsu/html-query - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — scrutinizer (dd8772)

by Thomas

created 2019-07-30 07:51 UTC

Resolver::relationResolve() B

↳ Parent: Resolver

Complexity

Conditions	8
Paths	10

Size

Total Lines	26
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
cc	8
eloc	13
c	1
b	1
f	0
nc	10
nop	2
dl	0
loc	26
rs	8.4444

<?php

namespace Sulao\HtmlQuery;

use Closure;
use DOMDocument, DOMNode, DOMNodeList, DOMXPath;
use ReflectionFunction;

/**
 * Trait Selector
 *
 * @package Sulao\HtmlQuery
 */
trait Resolver
{
    /**
     * @var DOMDocument
     */
    protected $doc;

    /**
     * @var DOMNode[]
     */
    protected $nodes;

    /**
     * Selector constructor.
     *
     * @param DOMDocument                          $doc
     * @param DOMNode|DOMNode[]|DOMNodeList|static $nodes
     *
     * @return static
     */
    abstract public function __construct(DOMDocument $doc, $nodes);

    /**
     * Get the descendants of each matched node, filtered by a selector.
     *
     * @param string|DOMNode|DOMNode[]|DOMNodeList|static $selector
     *
     * @return static
     */
    abstract public function find($selector);

    /**
     * Resolve DOMNode(s) to a static instance.
     *
     * @param DOMNode|DOMNode[]|DOMNodeList|static $nodes
     *
     * @return static
     */
    protected function resolve($nodes)
    {
        if ($nodes instanceof static) {
            return $nodes;
        }

        return new static($this->doc, $nodes);
    }

    /**
     * If the parameter is a css selector, get the descendants
     * of dom document filtered by the css selector.
     * If the parameter is selection, resolve that selection to static object.
     *
     * @param string|DOMNode|DOMNode[]|DOMNodeList|static $selector
     *
     * @return static
     */
    protected function targetResolve($selector)
    {
        if (is_string($selector)) {
            return $this->resolve($this->doc)->find($selector);
        }

        return $this->resolve($selector);
    }

    /**
     * If the parameter is string, consider it as raw html,
     * then create document fragment for it.
     * If the parameter is selection, resolve that selection to static instance.
     *
     * @param string|DOMNode|DOMNode[]|DOMNodeList|static $content
     *
     * @return static
     */
    protected function contentResolve($content)
    {
        if (is_string($content)) {
            return $this->htmlResolve($content);
        }

        return $this->resolve($content);
    }

    /**
     * Resolve the html content to static instance.
     *
     * @param string $html
     *
     * @return static
     */
    protected function htmlResolve(string $html)
    {
        $frag = $this->doc->createDocumentFragment();
        $frag->appendXML($html);

        return $this->resolve($frag);
    }

    /**
     * Resolve the nodes under the relation to static instance.
     * up to but not including the node matched by the $until selector.
     *
     * @param string $relation
     * @param string|DOMNode|DOMNode[]|DOMNodeList|static $until
     *
     * @return static
     */
    protected function relationResolve(string $relation, ?string $until = null)
    {
        $untilNodes = !is_null($until)
            ? $this->targetResolve($until)->nodes
            : [];

        $nodes = [];
        foreach ($this->nodes as $node) {
            while (($node = $node->$relation)
                && $node->nodeType !== XML_DOCUMENT_NODE
            ) {
                if ($node->nodeType !== XML_ELEMENT_NODE) {
                    continue;
                }

                if (in_array($node, $untilNodes, true)) {
                    break;
                }

                if (!in_array($node, $nodes, true)) {
                    $nodes[] = $node;
                }
            }
        }

        return $this->resolve($nodes);
    }

    /**
     * Get the class of the specified parameter of the closure.
     *
     * @param Closure $function
     * @param int     $index    Which parameter of the closure, starts with 0
     *
     * @return string
     */
    protected function getClosureClass(Closure $function, int $index)
    {
        $reflection = new ReflectionFunction($function);
        $parameters = $reflection->getParameters();

        if (!empty($parameters) && array_key_exists($index, $parameters)) {
            $class = $parameters[$index]->getClass();
            if ($class) {

                return $class->getName();
            }
        }

        return '';
    }

    /**
     * Resolve the node to static or HtmlNode instance or leaving it as DOMNode,
     * Then pass it to closure
     *
     * @param string  $class
     * @param DOMNode $node
     *
     * @return DOMNode|HtmlNode|static
     */
    protected function closureResolve(string $class, DOMNode $node)
    {
        if ($class === static::class) {
            return $this->resolve($node);
        } elseif ($class === HtmlNode::class) {
            return new HtmlNode($node);
        }

        return $node;
    }

    /**
     * Resolve the xpath to static instance.
     *
     * @param string $xpath
     *
     * @return static
     */
    protected function xpathFind(string $xpath)
    {
        $nodes = [];
        foreach ($this->nodes as $node) {
            $nodes = array_merge($nodes, $this->xpathQuery($xpath, $node));
        }

        $nodes = Helper::strictArrayUnique($nodes);

        return $this->resolve($nodes);
    }

    /**
     * Query xpath to an array of DOMNode
     *
     * @param string       $xpath
     * @param DOMNode|null $node
     *
     * @return DOMNode[]
     */
    protected function xpathQuery(
        string $xpath,
        ?DOMNode $node = null
    ): array {
        $docXpath = new DOMXpath($this->doc);
        $nodeList = $docXpath->query($xpath, $node);

        if (!($nodeList instanceof DOMNodeList)) {
            return [];
        }

        return iterator_to_array($nodeList);
    }
}


1			<?php
2
3			namespace Sulao\HtmlQuery;
4
5			use Closure;
6			use DOMDocument, DOMNode, DOMNodeList, DOMXPath;
7			use ReflectionFunction;
8
9			/**
10			* Trait Selector
11			*
12			* @package Sulao\HtmlQuery
13			*/
14			trait Resolver
15			{
16			/**
17			* @var DOMDocument
18			*/
19			protected $doc;
20
21			/**
22			* @var DOMNode[]
23			*/
24			protected $nodes;
25
26			/**
27			* Selector constructor.
28			*
29			* @param DOMDocument $doc
30			* @param DOMNode\|DOMNode[]\|DOMNodeList\|static $nodes
31			*
32			* @return static
33			*/
34			abstract public function __construct(DOMDocument $doc, $nodes);
35
36			/**
37			* Get the descendants of each matched node, filtered by a selector.
38			*
39			* @param string\|DOMNode\|DOMNode[]\|DOMNodeList\|static $selector
40			*
41			* @return static
42			*/
43			abstract public function find($selector);
44
45			/**
46			* Resolve DOMNode(s) to a static instance.
47			*
48			* @param DOMNode\|DOMNode[]\|DOMNodeList\|static $nodes
49			*
50			* @return static
51			*/
52			protected function resolve($nodes)
53			{
54			if ($nodes instanceof static) {
55			return $nodes;
56			}
57
58			return new static($this->doc, $nodes);
59			}
60
61			/**
62			* If the parameter is a css selector, get the descendants
63			* of dom document filtered by the css selector.
64			* If the parameter is selection, resolve that selection to static object.
65			*
66			* @param string\|DOMNode\|DOMNode[]\|DOMNodeList\|static $selector
67			*
68			* @return static
69			*/
70			protected function targetResolve($selector)
71			{
72			if (is_string($selector)) {
73			return $this->resolve($this->doc)->find($selector);
74			}
75
76			return $this->resolve($selector);
77			}
78
79			/**
80			* If the parameter is string, consider it as raw html,
81			* then create document fragment for it.
82			* If the parameter is selection, resolve that selection to static instance.
83			*
84			* @param string\|DOMNode\|DOMNode[]\|DOMNodeList\|static $content
85			*
86			* @return static
87			*/
88			protected function contentResolve($content)
89			{
90			if (is_string($content)) {
91			return $this->htmlResolve($content);
92			}
93
94			return $this->resolve($content);
95			}
96
97			/**
98			* Resolve the html content to static instance.
99			*
100			* @param string $html
101			*
102			* @return static
103			*/
104			protected function htmlResolve(string $html)
105			{
106			$frag = $this->doc->createDocumentFragment();
107			$frag->appendXML($html);
108
109			return $this->resolve($frag);
110			}
111
112			/**
113			* Resolve the nodes under the relation to static instance.
114			* up to but not including the node matched by the $until selector.
115			*
116			* @param string $relation
117			* @param string\|DOMNode\|DOMNode[]\|DOMNodeList\|static $until
118			*
119			* @return static
120			*/
121			protected function relationResolve(string $relation, ?string $until = null)
122			{
123			$untilNodes = !is_null($until)
124			? $this->targetResolve($until)->nodes
125			: [];
126
127			$nodes = [];
128			foreach ($this->nodes as $node) {
129			while (($node = $node->$relation)
130			&& $node->nodeType !== XML_DOCUMENT_NODE
131			) {
132			if ($node->nodeType !== XML_ELEMENT_NODE) {
133			continue;
134			}
135
136			if (in_array($node, $untilNodes, true)) {
137			break;
138			}
139
140			if (!in_array($node, $nodes, true)) {
141			$nodes[] = $node;
142			}
143			}
144			}
145
146			return $this->resolve($nodes);
147			}
148
149			/**
150			* Get the class of the specified parameter of the closure.
151			*
152			* @param Closure $function
153			* @param int $index Which parameter of the closure, starts with 0
154			*
155			* @return string
156			*/
157			protected function getClosureClass(Closure $function, int $index)
158			{
159			$reflection = new ReflectionFunction($function);
160			$parameters = $reflection->getParameters();
161
162			if (!empty($parameters) && array_key_exists($index, $parameters)) {
163			$class = $parameters[$index]->getClass();
164			if ($class) {
			0 ignored issues – show introduced 2019-07-30 07:54 UTC by Report Bug Copy Issue Report `$class` is of type `ReflectionClass`, thus it always evaluated to `true`. Loading history...
165			return $class->getName();
166			}
167			}
168
169			return '';
170			}
171
172			/**
173			* Resolve the node to static or HtmlNode instance or leaving it as DOMNode,
174			* Then pass it to closure
175			*
176			* @param string $class
177			* @param DOMNode $node
178			*
179			* @return DOMNode\|HtmlNode\|static
180			*/
181			protected function closureResolve(string $class, DOMNode $node)
182			{
183			if ($class === static::class) {
184			return $this->resolve($node);
185			} elseif ($class === HtmlNode::class) {
186			return new HtmlNode($node);
187			}
188
189			return $node;
190			}
191
192			/**
193			* Resolve the xpath to static instance.
194			*
195			* @param string $xpath
196			*
197			* @return static
198			*/
199			protected function xpathFind(string $xpath)
200			{
201			$nodes = [];
202			foreach ($this->nodes as $node) {
203			$nodes = array_merge($nodes, $this->xpathQuery($xpath, $node));
204			}
205
206			$nodes = Helper::strictArrayUnique($nodes);
207
208			return $this->resolve($nodes);
209			}
210
211			/**
212			* Query xpath to an array of DOMNode
213			*
214			* @param string $xpath
215			* @param DOMNode\|null $node
216			*
217			* @return DOMNode[]
218			*/
219			protected function xpathQuery(
220			string $xpath,
221			?DOMNode $node = null
222			): array {
223			$docXpath = new DOMXpath($this->doc);
224			$nodeList = $docXpath->query($xpath, $node);
225
226			if (!($nodeList instanceof DOMNodeList)) {
227			return [];
228			}
229
230			return iterator_to_array($nodeList);
231			}
232			}
233

xinningsu / html-query

Branch — scrutinizer (dd8772)

Resolver::relationResolve() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like