SimpleHtmlDomNode::innerHtml() - Code Metrics - Inspection of "[+]: fix strings with broken encoding" - voku/simple_html_dom - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a85a91...44c366 )

by Lars

created 2016-06-25 00:56 UTC

SimpleHtmlDomNode::innerHtml() A

↳ Parent: SimpleHtmlDomNode

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace voku\helper;

/**
 * Class SimpleHtmlDomNode
 *
 * @package voku\helper
 *
 * @property-read string outertext Get dom node's outer html
 * @property-read string plaintext Get dom node's plain text
 */
class SimpleHtmlDomNode extends \ArrayObject
{
  /**
   * @param $name
   *
   * @return string
   */
  public function __get($name)
  {
    switch ($name) {
      case 'outertext':
      case 'innertext':
        return $this->innerHtml();
      case 'plaintext':
        return $this->text();
    }

    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 SimpleHtmlDom|SimpleHtmlDomNode|null
   */
  public function __invoke($selector, $idx = null)
  {
    return $this->find($selector, $idx);
  }

  /**
   * @return mixed
   */
  public function __toString()
  {
    return $this->innerHtml();
  }

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

    if (null === $idx) {
      return $elements;
    } else {
      if ($idx < 0) {
        $idx = count($elements) + $idx;
      }
    }

    return (isset($elements[$idx]) ? $elements[$idx] : null);
  }

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

    return $text;
  }

  /**
   * Get plain text
   *
   * @return string
   */
  public function text()
  {
    $text = '';
    foreach ($this as $node) {
      $text .= $node->plaintext;
    }

    return $text;
  }
}


1		<?php
2
3		namespace voku\helper;
4
5		/**
6		* Class SimpleHtmlDomNode
7		*
8		* @package voku\helper
9		*
10		* @property-read string outertext Get dom node's outer html
11		* @property-read string plaintext Get dom node's plain text
12		*/
13		class SimpleHtmlDomNode extends \ArrayObject
14		{
15		/**
16		* @param $name
17		*
18		* @return string
19		*/
20	2	public function __get($name)
21		{
22		switch ($name) {
23	2	case 'outertext':
24	2	case 'innertext':
25	1	return $this->innerHtml();
26	1	case 'plaintext':
27	1	return $this->text();
28		}
29
30		return null;
31		}
32
33		/**
34		* alias for "$this->innerHtml()" (added for compatibly-reasons with v1.x)
35		*/
36		public function outertext()
37		{
38		$this->innerHtml();
		0 ignored issues – show Unused Code introduced 2016-04-01 01:54 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...
39		}
40
41		/**
42		* alias for "$this->innerHtml()" (added for compatibly-reasons with v1.x)
43		*/
44		public function innertext()
45		{
46		$this->innerHtml();
		0 ignored issues – show Unused Code introduced 2016-04-01 01:54 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...
47		}
48
49		/**
50		* @param string $selector
51		* @param int $idx
52		*
53		* @return SimpleHtmlDom\|SimpleHtmlDomNode\|null
54		*/
55		public function __invoke($selector, $idx = null)
56		{
57		return $this->find($selector, $idx);
58		}
59
60		/**
61		* @return mixed
62		*/
63		public function __toString()
64		{
65		return $this->innerHtml();
66		}
67
68		/**
69		* Find list of nodes with a CSS selector
70		*
71		* @param string $selector
72		* @param int $idx
73		*
74		* @return SimpleHtmlDomNode\|SimpleHtmlDomNode[]\|null
75		*/
76	11	public function find($selector, $idx = null)
77		{
78	11	$elements = new self();
79	11	foreach ($this as $node) {
80	11	foreach ($node->find($selector) as $res) {
81	10	$elements->append($res);
82	11	}
83	11	}
84
85	11	if (null === $idx) {
86	11	return $elements;
87		} else {
88		if ($idx < 0) {
89		$idx = count($elements) + $idx;
90		}
91		}
92
93		return (isset($elements[$idx]) ? $elements[$idx] : null);
94		}
95
96		/**
97		* Get html of Elements
98		*
99		* @return string
100		*/
101	1	public function innerHtml()
102		{
103	1	$text = '';
104	1	foreach ($this as $node) {
105	1	$text .= $node->outertext;
106	1	}
107
108	1	return $text;
109		}
110
111		/**
112		* Get plain text
113		*
114		* @return string
115		*/
116	1	public function text()
117		{
118	1	$text = '';
119	1	foreach ($this as $node) {
120	1	$text .= $node->plaintext;
121	1	}
122
123	1	return $text;
124		}
125		}
126

voku / simple_html_dom

Push — master ( a85a91...44c366 )

SimpleHtmlDomNode::innerHtml() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like