ValueNodeToArrayHandler::getArray() - Code Metrics - saxulum/saxulum-json-document - Measure and Improve Code Quality continuously with Scrutinizer

ValueNodeToArrayHandler::getArray() A
last analyzed 2018-04-20 16:22 UTC

↳ Parent: ValueNodeToArrayHandler

Complexity

Conditions	3
Paths	3

Size

Total Lines	12
Code Lines	6

Duplication

Lines	12
Ratio	100 %

Importance

Changes

Metric	Value
dl	12
loc	12
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	6
nc	3
nop	2

<?php

namespace Saxulum\JsonDocument\NodeToArray;

use Saxulum\JsonDocument\AbstractNode;
use Saxulum\JsonDocument\ValueNode;

class ValueNodeToArrayHandler extends AbstractNodeToArrayHandler

{
    /**
     * @param  AbstractNode $node
     * @param  bool         $embedded
     * @return array
     */
    public function getArray(AbstractNode $node, $embedded = false)
    {
        if (!$node instanceof ValueNode) {
            throw new \InvalidArgumentException("Invalid node type!");
        }

        if (!$embedded) {
            return array($node->getName() => $node->getValue());
        }

        return $node->getValue();
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());
}
    }

    /**
     * @param  AbstractNode $node
     * @return bool
     */
    public function isResponsible(AbstractNode $node)
    {
        return $node instanceof ValueNode;
    }
}


1		<?php
2
3		namespace Saxulum\JsonDocument\NodeToArray;
4
5		use Saxulum\JsonDocument\AbstractNode;
6		use Saxulum\JsonDocument\ValueNode;
7
8	View Code Duplication	class ValueNodeToArrayHandler extends AbstractNodeToArrayHandler
		0 ignored issues – show Duplication introduced 2018-04-20 16:22 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...
9		{
10		/**
11		* @param AbstractNode $node
12		* @param bool $embedded
13		* @return array
14		*/
15		public function getArray(AbstractNode $node, $embedded = false)
16		{
17		if (!$node instanceof ValueNode) {
18		throw new \InvalidArgumentException("Invalid node type!");
19		}
20
21		if (!$embedded) {
22		return array($node->getName() => $node->getValue());
23		}
24
25		return $node->getValue();
		0 ignored issues – show Bug Best Practice introduced 2018-04-20 16:22 UTC by Report Bug Copy Issue Report The return type of `return $node->getValue();` (`null\|string\|integer\|double\|boolean`) is incompatible with the return type declared by the abstract method `Saxulum\JsonDocument\Nod...oArrayHandler::getArray` of type `array`. 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...
26		}
27
28		/**
29		* @param AbstractNode $node
30		* @return bool
31		*/
32		public function isResponsible(AbstractNode $node)
33		{
34		return $node instanceof ValueNode;
35		}
36		}
37

saxulum / saxulum-json-document

ValueNodeToArrayHandler::getArray() A last analyzed 2018-04-20 16:22 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ValueNodeToArrayHandler::getArray() A
last analyzed 2018-04-20 16:22 UTC