SimpleHtmlDomNode::findOneOrFalse() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/master' into..." - voku/simple_html_dom - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e2f363...35870a )

by Lars

created 2021-03-29 14:36 UTC

SimpleHtmlDomNode::findOneOrFalse() A

↳ Parent: SimpleHtmlDomNode

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	10
Ratio	100 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	10
loc	10
ccs	0
cts	5
cp	0
rs	9.9332
c	0
b	0
f	0
nc	2
cc	2
nop	1
crap	6

<?php

declare(strict_types=1);

namespace voku\helper;

/**
 * {@inheritdoc}
 */
class SimpleHtmlDomNode extends AbstractSimpleHtmlDomNode implements SimpleHtmlDomNodeInterface

{
    /**
     * Find list of nodes with a CSS selector.
     *
     * @param string   $selector
     * @param int|null $idx
     *
     * @return SimpleHtmlDomNodeInterface<SimpleHtmlDomInterface>|SimpleHtmlDomNodeInterface[]|null

     */
    public function find(string $selector, $idx = null)
    {
        // init
        $elements = new static();

        foreach ($this as $node) {
            \assert($node instanceof SimpleHtmlDomInterface);
            foreach ($node->find($selector) as $res) {
                $elements[] = $res;
            }
        }

        // return all elements
        if ($idx === null) {
            if (\count($elements) === 0) {
                return new SimpleHtmlDomNodeBlank();
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());
}
            }

            return $elements;
        }

        // handle negative values
        if ($idx < 0) {
            $idx = \count($elements) + $idx;
        }

        // return one element
        return $elements[$idx] ?? null;
    }

    /**
     * Find nodes with a CSS selector.
     *
     * @param string $selector
     *
     * @return SimpleHtmlDomInterface[]|SimpleHtmlDomNodeInterface<SimpleHtmlDomInterface>

     */
    public function findMulti(string $selector): SimpleHtmlDomNodeInterface
    {
        return $this->find($selector, null);
    }

    /**
     * Find nodes with a CSS selector.
     *
     * @param string $selector
     *
     * @return false|SimpleHtmlDomInterface[]|SimpleHtmlDomNodeInterface<SimpleHtmlDomInterface>

     */
    public function findMultiOrFalse(string $selector)
    {
        $return = $this->find($selector, null);

        if ($return instanceof SimpleHtmlDomNodeBlank) {
            return false;
        }

        return $return;
    }

    /**
     * Find one node with a CSS selector.
     *
     * @param string $selector
     *
     * @return SimpleHtmlDomNodeInterface<SimpleHtmlDomInterface>|null

     */
    public function findOne(string $selector)
    {
        return $this->find($selector, 0);

    }

    /**
     * Find one node with a CSS selector.
     *
     * @param string $selector
     *
     * @return false|SimpleHtmlDomNodeInterface<SimpleHtmlDomInterface>

     */
    public function findOneOrFalse(string $selector)
    {
        $return = $this->find($selector, 0);


        if ($return === null) {
            return false;
        }

        return $return;
    }

    /**
     * Get html of elements.
     *
     * @return string[]
     */
    public function innerHtml(): array
    {
        // init
        $html = [];

        foreach ($this as $node) {
            $html[] = $node->outertext;
        }

        return $html;
    }

    /**
     * alias for "$this->innerHtml()" (added for compatibly-reasons with v1.x)
     *
     * @return string[]
     */
    public function innertext()
    {
        return $this->innerHtml();
    }

    /**
     * alias for "$this->innerHtml()" (added for compatibly-reasons with v1.x)
     *
     * @return string[]
     */
    public function outertext()
    {
        return $this->innerHtml();
    }

    /**
     * Get plain text.
     *
     * @return string[]
     */
    public function text(): array
    {
        // init
        $text = [];

        foreach ($this as $node) {
            $text[] = $node->plaintext;
        }

        return $text;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace voku\helper;
6
7			/**
8			* {@inheritdoc}
9			*/
10		View Code Duplication	class SimpleHtmlDomNode extends AbstractSimpleHtmlDomNode implements SimpleHtmlDomNodeInterface
			0 ignored issues – show Duplication introduced 2019-07-01 08:00 UTC by Report Bug Copy Issue Report This class 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...
11			{
12			/**
13			* Find list of nodes with a CSS selector.
14			*
15			* @param string $selector
16			* @param int\|null $idx
17			*
18			* @return SimpleHtmlDomNodeInterface<SimpleHtmlDomInterface>\|SimpleHtmlDomNodeInterface[]\|null
			0 ignored issues – show Documentation introduced 2019-12-08 01:55 UTC by Report Bug Copy Issue Report The doc-type `SimpleHtmlDomNodeInterfa...DomNodeInterface[]\|null` could not be parsed: Expected "\|" or "end of type", but got "<" at position 26. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
19			*/
20	11		public function find(string $selector, $idx = null)
21			{
22			// init
23	11		$elements = new static();
24
25	11		foreach ($this as $node) {
26			\assert($node instanceof SimpleHtmlDomInterface);
27	11		foreach ($node->find($selector) as $res) {
28	10		$elements[] = $res;
29			}
30			}
31
32			// return all elements
33	11		if ($idx === null) {
34	11		if (\count($elements) === 0) {
35	1		return new SimpleHtmlDomNodeBlank();
			0 ignored issues – show Bug Best Practice introduced 2019-04-25 23:06 UTC by Report Bug Copy Issue Report The return type of `return new \voku\helper\SimpleHtmlDomNodeBlank();` (`voku\helper\SimpleHtmlDomNodeBlank`) is incompatible with the return type declared by the interface `voku\helper\SimpleHtmlDomNodeInterface::find` of type `voku\helper\SimpleHtmlDo...impleHtmlDomNode[]\|null`. 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...
36			}
37
38	10		return $elements;
39			}
40
41			// handle negative values
42			if ($idx < 0) {
43			$idx = \count($elements) + $idx;
44			}
45
46			// return one element
47			return $elements[$idx] ?? null;
48			}
49
50			/**
51			* Find nodes with a CSS selector.
52			*
53			* @param string $selector
54			*
55			* @return SimpleHtmlDomInterface[]\|SimpleHtmlDomNodeInterface<SimpleHtmlDomInterface>
			0 ignored issues – show Documentation introduced 2019-12-08 01:55 UTC by Report Bug Copy Issue Report The doc-type `SimpleHtmlDomInterface[]...SimpleHtmlDomInterface>` could not be parsed: Expected "\|" or "end of type", but got "<" at position 51. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
56			*/
57			public function findMulti(string $selector): SimpleHtmlDomNodeInterface
58			{
59			return $this->find($selector, null);
60			}
61
62			/**
63			* Find nodes with a CSS selector.
64			*
65			* @param string $selector
66			*
67			* @return false\|SimpleHtmlDomInterface[]\|SimpleHtmlDomNodeInterface<SimpleHtmlDomInterface>
			0 ignored issues – show Documentation introduced 2019-12-08 01:55 UTC by Report Bug Copy Issue Report The doc-type `false\|SimpleHtmlDomInter...SimpleHtmlDomInterface>` could not be parsed: Expected "\|" or "end of type", but got "<" at position 57. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
68			*/
69			public function findMultiOrFalse(string $selector)
70			{
71			$return = $this->find($selector, null);
72
73			if ($return instanceof SimpleHtmlDomNodeBlank) {
74			return false;
75			}
76
77			return $return;
78			}
79
80			/**
81			* Find one node with a CSS selector.
82			*
83			* @param string $selector
84			*
85			* @return SimpleHtmlDomNodeInterface<SimpleHtmlDomInterface>\|null
			0 ignored issues – show Documentation introduced 2019-12-08 01:55 UTC by Report Bug Copy Issue Report The doc-type `SimpleHtmlDomNodeInterfa...eHtmlDomInterface>\|null` could not be parsed: Expected "\|" or "end of type", but got "<" at position 26. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
86			*/
87			public function findOne(string $selector)
88			{
89			return $this->find($selector, 0);
			0 ignored issues – show Bug Compatibility introduced 2019-03-31 22:48 UTC by Report Bug Copy Issue Report The expression `$this->find($selector, 0);` of type `voku\helper\SimpleHtmlDo...impleHtmlDomNode[]\|null` adds the type `voku\helper\SimpleHtmlDomNode[]` to the return on line 89 which is incompatible with the return type declared by the interface `voku\helper\SimpleHtmlDomNodeInterface::findOne` of type `voku\helper\SimpleHtmlDomNode\|null`. Loading history...
90			}
91
92			/**
93			* Find one node with a CSS selector.
94			*
95			* @param string $selector
96			*
97			* @return false\|SimpleHtmlDomNodeInterface<SimpleHtmlDomInterface>
			0 ignored issues – show Documentation introduced 2019-12-08 01:55 UTC by Report Bug Copy Issue Report The doc-type `false\|SimpleHtmlDomNodeI...SimpleHtmlDomInterface>` could not be parsed: Expected "\|" or "end of type", but got "<" at position 32. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
98			*/
99			public function findOneOrFalse(string $selector)
100			{
101			$return = $this->find($selector, 0);
			0 ignored issues – show Bug Compatibility introduced 2019-12-08 01:55 UTC by Report Bug Copy Issue Report The expression `$this->find($selector, 0);` of type `voku\helper\SimpleHtmlDo...impleHtmlDomNode[]\|null` adds the type `voku\helper\SimpleHtmlDomNode[]` to the return on line 107 which is incompatible with the return type declared by the interface `voku\helper\SimpleHtmlDo...terface::findOneOrFalse` of type `false\|voku\helper\SimpleHtmlDomNode`. Loading history...
102
103			if ($return === null) {
104			return false;
105			}
106
107			return $return;
108			}
109
110			/**
111			* Get html of elements.
112			*
113			* @return string[]
114			*/
115	1		public function innerHtml(): array
116			{
117			// init
118	1		$html = [];
119
120	1		foreach ($this as $node) {
121	1		$html[] = $node->outertext;
122			}
123
124	1		return $html;
125			}
126
127			/**
128			* alias for "$this->innerHtml()" (added for compatibly-reasons with v1.x)
129			*
130			* @return string[]
131			*/
132			public function innertext()
133			{
134			return $this->innerHtml();
135			}
136
137			/**
138			* alias for "$this->innerHtml()" (added for compatibly-reasons with v1.x)
139			*
140			* @return string[]
141			*/
142			public function outertext()
143			{
144			return $this->innerHtml();
145			}
146
147			/**
148			* Get plain text.
149			*
150			* @return string[]
151			*/
152	7		public function text(): array
153			{
154			// init
155	7		$text = [];
156
157	7		foreach ($this as $node) {
158	7		$text[] = $node->plaintext;
159			}
160
161	7		return $text;
162			}
163			}
164

voku / simple_html_dom

Push — master ( e2f363...35870a )

SimpleHtmlDomNode::findOneOrFalse() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like