League\Tactician\Bundle\Security\Voter\HandleCommandVoter

Complexity

Total Complexity

11

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	1
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	supports()	0	4	2
A	voteOnAttribute()	0	11	2
B	getAllowedRoles()	0	12	5
A	getDecisionManager()	0	4	1

<?php

namespace League\Tactician\Bundle\Security\Voter;

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

/**
 * Voter for security checks on handling commands.
 *
 * @author Ron Rademaker
 */
class HandleCommandVoter extends Voter
{
    /**
     * The decision manager.
     *
     * @var AccessDecisionManagerInterface
     */
    private $decisionManager;

    /**
     * Default required role.
     *
     * @var string
     */
    private $defaultRole;

    /**
     * Command - Require role mapping
     *
     * @var array
     */
    private $commandRoleMapping;

    /**
     * Create a new HandleCommandVoter.
     *
     * @param AccessDecisionManagerInterface $decisionManager
     * @param array $commandRoleMapping
     * @param string $defaultRole
     */
    public function __construct(AccessDecisionManagerInterface $decisionManager, array $commandRoleMapping = [], $defaultRole = null)
    {
        $this->decisionManager = $decisionManager;
        $this->commandRoleMapping = $commandRoleMapping;
        $this->defaultRole = $defaultRole;
    }

    /**
     * The voter supports checking handle commands
     *
     * @param string $attribute
     * @param object $subject
     * @return bool
     */
    protected function supports($attribute, $subject)
    {
        return $attribute === 'handle' && is_object($subject);
    }

    /**
     * Checks if the currently logged on user may handle $subject.
     *
     * @param type $attribute
     * @param type $subject
     * @param TokenInterface $token
     *
     * @return bool
     */
    protected function voteOnAttribute($attribute, $subject, TokenInterface $token)
    {
        $allowedRoles = $this->getAllowedRoles(get_class($subject));

        if (count($allowedRoles) > 0) {
            return $this->getDecisionManager()->decide($token, $allowedRoles);
        } else {
            // no required role is action allowed
            return true;
        }
    }

    /**
     * Gets the roles allowed to handle a command of $type
     *
     * @param string $type
     * @return array
     */
    private function getAllowedRoles($type)
    {
        if (false === $type && isset($this->defaultRole)) {
            return [$this->defaultRole];
        } elseif (false === $type) {
            return [];
        } elseif (array_key_exists($type, $this->commandRoleMapping)) {
            return $this->commandRoleMapping[$type];
        } else {
            return $this->getAllowedRoles(get_parent_class($type));
        }
    }

    /**
     * Returns the decisionManager.
     *
     * @return AccessDecisionManagerInterface
     */
    private function getDecisionManager()
    {
        return $this->decisionManager;
    }
}