Graviton\SecurityBundle\Voter\ServiceAllowedVoter

Complexity

Total Complexity

8

Size/Duplication

Total Lines	106
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	1
Bugs	0	Features	1

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getSupportedClasses()	0	6	1
A	getSupportedAttributes()	0	6	1
A	isGranted()	0	4	1
A	voteOnAttribute()	0	4	1
A	supportsAttribute()	0	5	1
A	supportsClass()	0	5	1
A	supports()	0	4	1

<?php
/**
 * Voter deciding, if the provided object is
 */
namespace Graviton\SecurityBundle\Voter;

use Symfony\Component\Security\Core\Authorization\Voter\Voter;
use Symfony\Component\Security\Core\User\UserInterface;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;

/**
 * @author   List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
 * @license  http://opensource.org/licenses/gpl-license.php GNU Public License
 * @link     http://swisscom.ch
 */
class ServiceAllowedVoter extends Voter
{
    /** @var array List of services always allowed to be called. */
    private $whitelist = array();


    /**
     * @param array $whiteList Set of services to be allowed to be called.
     */
    public function __construct($whiteList = array())
    {
        $this->whitelist = $whiteList;
    }

    /**
     * Return an array of supported classes. This will be called by supportsClass
     *
     * @return array an array of supported classes, i.e. array('Acme\DemoBundle\Model\Product')
     */
    protected function getSupportedClasses()
    {
        return array(
            'Symfony\Component\HttpFoundation\Request'
        );
    }

    /**
     * Return an array of supported attributes. This will be called by supportsAttribute
     *
     * @return array an array of supported attributes, i.e. array('CREATE', 'READ')
     */
    protected function getSupportedAttributes()
    {
        return array(
            'VIEW'
        );
    }

    /**
     * Perform a single access check operation on a given attribute, object and (optionally) user
     * It is safe to assume that $attribute and $object's class pass supportsAttribute/supportsClass
     * $user can be one of the following:
     *   a UserInterface object (fully authenticated user)
     *   a string               (anonymously authenticated user)
     *
     * @param string               $attribute The attribute to be checked against.
     * @param object               $object    The object the access shall be granted for.
     * @param UserInterface|string $user      The user asking for permission.
     *
     * @return bool
     */
    protected function isGranted($attribute, $object, $user = null)

The parameter $attribute is not used and could be removed.

The parameter $user is not used and could be removed.

    {
        return in_array($object->getPathInfo(), $this->whitelist);
    }

    /**
     * todo Implement new voter attribute since symfony 2.8
     *
     * @param string         $attribute Object attribute
     * @param mixed          $subject   Subject to be supported
     * @param TokenInterface $token     Token
     *
     * @return bool
     */
    protected function voteOnAttribute($attribute, $subject, TokenInterface $token)
    {
        return true;
    }

    /**
     * @param string $attribute To be supported
     * @return void
     * @throws \BadMethodCallException
     */
    public function supportsAttribute($attribute)
    {
        $msg = 'supportsAttribute method is deprecated since version 2.8, to be removed in 3.0';
        throw new \BadMethodCallException($msg);
    }

    /**
     * @param string $class to be supported
     * @return void
     * @throws \BadMethodCallException
     */
    public function supportsClass($class)
    {
        $msg = 'supportsClass method is deprecated since version 2.8, to be removed in 3.0';
        throw new \BadMethodCallException($msg);
    }

    /**
     * Determines if the attribute and subject are supported by this voter.
     * todo implement voters
     *
     * @param string $attribute An attribute
     * @param mixed  $subject   The subject to secure, e.g. an object the user wants to access or any other PHP type
     *
     * @return bool True if the attribute and subject are supported, false otherwise
     */
    protected function supports($attribute, $subject)
    {
        return true;
    }
}