SimpleHtmlDomNode::innerHtml() - Code Metrics - Inspection of "[+]: fix url-regex for e.g. links in plain-text-ma..." - voku/simple_html_dom - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8111da...2b9d4e )

by Lars

created 2016-12-01 08:05 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

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

voku / simple_html_dom

Push — master ( 8111da...2b9d4e )

SimpleHtmlDomNode::innerHtml() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like