Completed
Push — master ( 46b523...907816 )
by WEBEWEB
01:22
created

DefaultNavigationProvider::getView()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 3
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 0
1
<?php
2
3
/**
4
 * This file is part of the adminbsb-material-design-bundle package.
5
 *
6
 * (c) 2017 WEBEWEB
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
namespace WBW\Bundle\AdminBSBBundle\Provider\Navigation;
13
14
use WBW\Bundle\BootstrapBundle\Navigation\NavigationTree;
15
use WBW\Bundle\BootstrapBundle\Provider\Navigation\NavigationProviderInterface;
16
17
/**
18
 * Default navigation provider.
19
 *
20
 * @author webeweb <https://github.com/webeweb/>
21
 * @package WBW\Bundle\AdminBSBBundle\Provider\Navigation
22
 */
23
class DefaultNavigationProvider implements NavigationProviderInterface {
0 ignored issues
show
Bug introduced by
There is one abstract method getTemplate in this class; you could implement it, or declare this class as abstract.
Loading history...
24
25
    /**
26
     * Constructor.
27
     */
28
    public function __construct() {
29
        // NOTHING TO DO.
30
    }
31
32
    /**
33
     * {@inheritdoc}
34
     */
35
    public function getTree() {
36
        return new NavigationTree();
0 ignored issues
show
Bug Best Practice introduced by
The return type of return new \WBW\Bundle\B...ation\NavigationTree(); (WBW\Bundle\BootstrapBund...vigation\NavigationTree) is incompatible with the return type declared by the interface WBW\Bundle\BootstrapBund...viderInterface::getTree of type WBW\Library\Core\Navigation\Tree\NavigationTree.

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...
37
    }
38
39
    /**
40
     * {@inheritdoc}
41
     */
42
    public function getView() {
43
        return "@ABSBMD/html/body/section/aside/div.menu.html.twig";
44
    }
45
46
}
47