SimpleHtmlDomNode::findOne() - Code Metrics - Inspection of "[+]: "HtmlDomParser" -> fix clone method for "docu..." - voku/simple_html_dom - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cd20cb...719c7c )

by Lars

created 2017-12-17 02:02 UTC

SimpleHtmlDomNode::findOne() A

↳ Parent: SimpleHtmlDomNode

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

declare(strict_types=1);

namespace voku\helper;

/**
 * Class SimpleHtmlDomNode
 *
 * @package voku\helper
 *
 * @property-read string outertext <p>Get dom node's outer html.</p>
 * @property-read string plaintext <p>Get dom node's plain text.</p>
 */
class SimpleHtmlDomNode extends \ArrayObject implements SimpleHtmlDomNodeInterface
{
  /** @noinspection MagicMethodsValidityInspection */
  /**
   * @param string $name
   *
   * @return array|null
   */
  public function __get($name)
  {
    $name = strtolower($name);

    if ($this->count() > 0) {
      $return = array();

      foreach ($this as $node) {
        if ($node instanceof SimpleHtmlDom) {
          $return[] = $node->{$name};
        }
      }

      return $return;
    }

    return null;
  }

  /**
   * alias for "$this->innerHtml()" (added for compatibly-reasons with v1.x)
   */
  public function outertext()
  {
    $this->innerHtml();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
  }

  /**
   * alias for "$this->innerHtml()" (added for compatibly-reasons with v1.x)
   */
  public function innertext()
  {
    $this->innerHtml();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
  }

  /**
   * @param string $selector
   * @param int    $idx
   *
   * @return SimpleHtmlDomNode[]|SimpleHtmlDomNode|null
   */
  public function __invoke($selector, $idx = null)
  {
    return $this->find($selector, $idx);
  }

  /**
   * @return string
   */
  public function __toString()
  {
    $html = '';
    foreach ($this as $node) {
      $html .= $node->outertext;
    }

    return $html;
  }

  /**
   * Find one node with a CSS selector.
   *
   * @param string $selector
   *
   * @return SimpleHtmlDomNode|null
   */
  public function findOne(string $selector)
  {
    return $this->find($selector, 0);
  }

  /**
   * Find list of nodes with a CSS selector.
   *
   * @param string $selector
   * @param int    $idx
   *
   * @return SimpleHtmlDomNode[]|SimpleHtmlDomNode|null
   */
  public function find(string $selector, $idx = null)
  {
    $elements = new self();
    foreach ($this as $node) {
      foreach ($node->find($selector) as $res) {
        $elements->append($res);
      }
    }

    // return all elements
    if (null === $idx) {
      return $elements;
    }

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

    // return one element
    if (isset($elements[$idx])) {
      return $elements[$idx];
    }

    return null;
  }

  /**
   * Get html of elements.
   *
   * @return array
   */
  public function innerHtml(): array
  {
    $html = array();
    foreach ($this as $node) {
      $html[] = $node->outertext;
    }

    return $html;
  }

  /**
   * Get plain text.
   *
   * @return array
   */
  public function text(): array
  {
    $text = array();
    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		* Class SimpleHtmlDomNode
9		*
10		* @package voku\helper
11		*
12		* @property-read string outertext <p>Get dom node's outer html.</p>
13		* @property-read string plaintext <p>Get dom node's plain text.</p>
14		*/
15		class SimpleHtmlDomNode extends \ArrayObject implements SimpleHtmlDomNodeInterface
16		{
17		/** @noinspection MagicMethodsValidityInspection */
18		/**
19		* @param string $name
20		*
21		* @return array\|null
22		*/
23	3	public function __get($name)
24		{
25	3	$name = strtolower($name);
26
27	3	if ($this->count() > 0) {
28	3	$return = array();
29
30	3	foreach ($this as $node) {
31	3	if ($node instanceof SimpleHtmlDom) {
32	3	$return[] = $node->{$name};
33		}
34		}
35
36	3	return $return;
37		}
38
39		return null;
40		}
41
42		/**
43		* alias for "$this->innerHtml()" (added for compatibly-reasons with v1.x)
44		*/
45		public function outertext()
46		{
47		$this->innerHtml();
		0 ignored issues – show Unused Code introduced 2017-08-03 21:43 UTC by Report Bug Copy Issue Report The call to the method `voku\helper\SimpleHtmlDomNode::innerHtml()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
48		}
49
50		/**
51		* alias for "$this->innerHtml()" (added for compatibly-reasons with v1.x)
52		*/
53		public function innertext()
54		{
55		$this->innerHtml();
		0 ignored issues – show Unused Code introduced 2017-08-03 21:43 UTC by Report Bug Copy Issue Report The call to the method `voku\helper\SimpleHtmlDomNode::innerHtml()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
56		}
57
58		/**
59		* @param string $selector
60		* @param int $idx
61		*
62		* @return SimpleHtmlDomNode[]\|SimpleHtmlDomNode\|null
63		*/
64		public function __invoke($selector, $idx = null)
65		{
66		return $this->find($selector, $idx);
67		}
68
69		/**
70		* @return string
71		*/
72	1	public function __toString()
73		{
74	1	$html = '';
75	1	foreach ($this as $node) {
76	1	$html .= $node->outertext;
77		}
78
79	1	return $html;
80		}
81
82		/**
83		* Find one node with a CSS selector.
84		*
85		* @param string $selector
86		*
87		* @return SimpleHtmlDomNode\|null
88		*/
89		public function findOne(string $selector)
90		{
91		return $this->find($selector, 0);
92		}
93
94		/**
95		* Find list of nodes with a CSS selector.
96		*
97		* @param string $selector
98		* @param int $idx
99		*
100		* @return SimpleHtmlDomNode[]\|SimpleHtmlDomNode\|null
101		*/
102	11	public function find(string $selector, $idx = null)
103		{
104	11	$elements = new self();
105	11	foreach ($this as $node) {
106	11	foreach ($node->find($selector) as $res) {
107	11	$elements->append($res);
108		}
109		}
110
111		// return all elements
112	11	if (null === $idx) {
113	11	return $elements;
114		}
115
116		// handle negative values
117		if ($idx < 0) {
118		$idx = \count($elements) + $idx;
119		}
120
121		// return one element
122		if (isset($elements[$idx])) {
123		return $elements[$idx];
124		}
125
126		return null;
127		}
128
129		/**
130		* Get html of elements.
131		*
132		* @return array
133		*/
134	1	public function innerHtml(): array
135		{
136	1	$html = array();
137	1	foreach ($this as $node) {
138	1	$html[] = $node->outertext;
139		}
140
141	1	return $html;
142		}
143
144		/**
145		* Get plain text.
146		*
147		* @return array
148		*/
149	1	public function text(): array
150		{
151	1	$text = array();
152	1	foreach ($this as $node) {
153	1	$text[] = $node->plaintext;
154		}
155
156	1	return $text;
157		}
158		}
159

voku / simple_html_dom

Push — master ( cd20cb...719c7c )

SimpleHtmlDomNode::findOne() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like