AbstractContainer   A
last analyzed

Complexity

Total Complexity 7

Size/Duplication

Total Lines 75
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 3

Importance

Changes 0
Metric Value
wmc 7
lcom 1
cbo 3
dl 0
loc 75
rs 10
c 0
b 0
f 0

7 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 4 1
A addChild() 0 6 1
A getChildren() 0 4 1
A addFilter() 0 6 1
A setValue() 0 3 1
A getValue() 0 10 1
A getError() 0 10 1
1
<?php
2
/*
3
 * WellCommerce Open-Source E-Commerce Platform
4
 *
5
 * This file is part of the WellCommerce package.
6
 *
7
 * (c) Adam Piotrowski <[email protected]>
8
 *
9
 * For the full copyright and license information,
10
 * please view the LICENSE file that was distributed with this source code.
11
 */
12
13
namespace WellCommerce\Component\Form\Elements;
14
15
use WellCommerce\Component\Form\Filters\FilterInterface;
16
17
/**
18
 * Class AbstractContainer
19
 *
20
 * @author Adam Piotrowski <[email protected]>
21
 */
22
abstract class AbstractContainer extends AbstractNode
23
{
24
    /**
25
     * @var ElementCollection
26
     */
27
    protected $children;
28
29
    /**
30
     * Constructor
31
     */
32
    public function __construct()
33
    {
34
        $this->children = new ElementCollection();
35
    }
36
37
    /**
38
     * {@inheritdoc}
39
     */
40
    public function addChild(ElementInterface $element)
41
    {
42
        $this->children->add($element);
43
44
        return $element;
45
    }
46
47
    public function getChildren()
48
    {
49
        return $this->children;
50
    }
51
52
    /**
53
     * {@inheritdoc}
54
     */
55
    public function addFilter(FilterInterface $filter)
56
    {
57
        $this->children->forAll(function (ElementInterface $element) use ($filter) {
58
            $element->addFilter($filter);
59
        });
60
    }
61
62
    /**
63
     * {@inheritdoc}
64
     */
65
    public function setValue($data)
66
    {
67
    }
68
69
    /**
70
     * {@inheritdoc}
71
     */
72
    public function getValue()
73
    {
74
        $values = [];
75
76
        $this->getChildren()->forAll(function (ElementInterface $child) use (&$values) {
77
            $values[$child->getName()] = $child->getValue();
78
        });
79
80
        return $values;
81
    }
82
83
    /**
84
     * {@inheritdoc}
85
     */
86
    public function getError()
87
    {
88
        $errors = [];
89
90
        $this->getChildren()->forAll(function (ElementInterface $child) use (&$errors) {
91
            $errors[$child->getName()] = $child->getError();
92
        });
93
94
        return $errors;
0 ignored issues
show
Bug Best Practice introduced by Adam Piotrowski
The return type of return $errors; (array) is incompatible with the return type declared by the interface WellCommerce\Component\F...mentInterface::getError of type string.

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...
95
    }
96
}
97