Completed
Push — master ( b9c485...94fed1 )
by Michał
13:51
created

Sylius/Component/Rbac/Resolver/RolesResolver.php (1 issue)

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

1
<?php
2
3
/*
4
 * This file is part of the Sylius package.
5
 *
6
 * (c) Paweł Jędrzejewski
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 Sylius\Component\Rbac\Resolver;
13
14
use Sylius\Component\Rbac\Model\IdentityInterface;
15
16
/**
17
 * Default hierarchical roles resolver.
18
 *
19
 * @author Paweł Jędrzejewski <[email protected]>
20
 */
21
class RolesResolver implements RolesResolverInterface
22
{
23
    /**
24
     * {@inheritdoc}
25
     */
26
    public function getRoles(IdentityInterface $identity)
27
    {
28
        return new \RecursiveIteratorIterator(
0 ignored issues
show
Bug Best Practice introduced by
The return type of return new \RecursiveIte...rIterator::SELF_FIRST); (RecursiveIteratorIterator) is incompatible with the return type declared by the interface Sylius\Component\Rbac\Re...lverInterface::getRoles 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...
29
            new RecursiveRoleIterator($identity->getAuthorizationRoles()),
30
            \RecursiveIteratorIterator::SELF_FIRST
31
        );
32
    }
33
}
34