Issues in RabbitFish.php - Filtered Issues - Inspection of "Improve dynamic properties, add isset/unset, impro..." - FluentDOM/FluentDOM - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 357a0a...11ae27 )

by Thomas

created 2017-08-02 17:06 UTC

src/FluentDOM/Serializer/Json/RabbitFish.php (1 issue)

Labels

Severity

Major 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
/**
 * Serialize a DOM to RabbitFish Json: http://www.bramstein.com/projects/xsltjson/
 *
 * @license http://www.opensource.org/licenses/mit-license.php The MIT License
 * @copyright Copyright (c) 2009-2017 FluentDOM Contributors
 */

namespace FluentDOM\Serializer\Json {

  use FluentDOM\DOM\Xpath;

  /**
   * Serialize a DOM to RabbitFish Json: http://www.bramstein.com/projects/xsltjson/
   *
   * @license http://www.opensource.org/licenses/mit-license.php The MIT License
   * @copyright Copyright (c) 2009-2017 FluentDOM Contributors
   */
  class RabbitFish extends BadgerFish {

    /**
     * @param \DOMElement $node
     * @return mixed
     */
    protected function getNodes(\DOMElement $node) {
      $xpath = new Xpath($node->ownerDocument);
      $hasText = $xpath->evaluate('count(text()[normalize-space(.) != ""]) > 0', $node);
      $hasElements = $xpath->evaluate('count(*) > 0', $node);
      $attributes = new \stdClass();
      $this->addAttributes($attributes, $node, $xpath);
      $this->addNamespaces($attributes, $node, $xpath);
      $attributes = (array)$attributes;
      if ($hasText && $hasElements) {
        return $this->getNodesArray($node, $attributes, $xpath);
      }
      if ($hasText && count($attributes) === 0) {
        return $node->nodeValue;
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 parent::getNodes($node);
    }

    /**
     * @param \DOMElement $node
     * @param \stdClass|array $attributes
     * @param Xpath $xpath
     * @return array
     */
    private function getNodesArray(\DOMElement $node, $attributes, $xpath): array {
      $result = [];
      foreach ($attributes as $name => $value) {
        $child = new \stdClass();
        $child->{$name} = $value;
        $result[] = $child;
      }
      foreach ($xpath->evaluate('*|text()[normalize-space(.) != ""]', $node) as $childNode) {
        /** @var \DOMElement|\DOMText|\DOMCdataSection $childNode */
        if ($childNode instanceof \DOMElement) {
          $child = new \stdClass();
          $child->{$childNode->nodeName} = $this->getNodes($childNode);
          $result[] = $child;
        } elseif (!$childNode->isWhitespaceInElementContent()) {
          $result[] = $childNode->nodeValue;
        }
      }
      return $result;
    }
  }
}

1		<?php
2		/**
3		* Serialize a DOM to RabbitFish Json: http://www.bramstein.com/projects/xsltjson/
4		*
5		* @license http://www.opensource.org/licenses/mit-license.php The MIT License
6		* @copyright Copyright (c) 2009-2017 FluentDOM Contributors
7		*/
8
9		namespace FluentDOM\Serializer\Json {
10
11		use FluentDOM\DOM\Xpath;
12
13		/**
14		* Serialize a DOM to RabbitFish Json: http://www.bramstein.com/projects/xsltjson/
15		*
16		* @license http://www.opensource.org/licenses/mit-license.php The MIT License
17		* @copyright Copyright (c) 2009-2017 FluentDOM Contributors
18		*/
19		class RabbitFish extends BadgerFish {
20
21		/**
22		* @param \DOMElement $node
23		* @return mixed
24		*/
25	9	protected function getNodes(\DOMElement $node) {
26	9	$xpath = new Xpath($node->ownerDocument);
27	9	$hasText = $xpath->evaluate('count(text()[normalize-space(.) != ""]) > 0', $node);
28	9	$hasElements = $xpath->evaluate('count(*) > 0', $node);
29	9	$attributes = new \stdClass();
30	9	$this->addAttributes($attributes, $node, $xpath);
31	9	$this->addNamespaces($attributes, $node, $xpath);
32	9	$attributes = (array)$attributes;
33	9	if ($hasText && $hasElements) {
34	2	return $this->getNodesArray($node, $attributes, $xpath);
35		}
36	9	if ($hasText && count($attributes) === 0) {
37	5	return $node->nodeValue;
		1 ignored issue – show Bug Best Practice introduced 2017-08-02 08:07 UTC by Report Bug Copy Issue Report Show Similar Issues like this The return type of `return $node->nodeValue;` (`string`) is incompatible with the return type of the parent method `FluentDOM\Serializer\Json\BadgerFish::getNodes` of type `stdClass`. 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...
38		}
39	6	return parent::getNodes($node);
40		}
41
42		/**
43		* @param \DOMElement $node
44		* @param \stdClass\|array $attributes
45		* @param Xpath $xpath
46		* @return array
47		*/
48	2	private function getNodesArray(\DOMElement $node, $attributes, $xpath): array {
49	2	$result = [];
50	2	foreach ($attributes as $name => $value) {
51	1	$child = new \stdClass();
52	1	$child->{$name} = $value;
53	1	$result[] = $child;
54		}
55	2	foreach ($xpath->evaluate('*\|text()[normalize-space(.) != ""]', $node) as $childNode) {
56		/** @var \DOMElement\|\DOMText\|\DOMCdataSection $childNode */
57	2	if ($childNode instanceof \DOMElement) {
58	2	$child = new \stdClass();
59	2	$child->{$childNode->nodeName} = $this->getNodes($childNode);
60	2	$result[] = $child;
61	2	} elseif (!$childNode->isWhitespaceInElementContent()) {
62	2	$result[] = $childNode->nodeValue;
63		}
64		}
65	2	return $result;
66		}
67		}
68		}

FluentDOM / FluentDOM

Push — master ( 357a0a...11ae27 )

src/FluentDOM/Serializer/Json/RabbitFish.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like