Skip to content

Abstract voter tweaks #15921

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 27, 2015
Merged

Abstract voter tweaks #15921

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 9 additions & 18 deletions src/Symfony/Component/Security/Core/Authorization/Voter/AbstractVoter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,6 @@ public function vote(TokenInterface $token, $object, array $attributes)
$vote = self::ACCESS_ABSTAIN;
$class = get_class($object);

$reflector = new \ReflectionMethod($this, 'voteOnAttribute');
$isNewOverwritten = $reflector->getDeclaringClass()->getName() !== 'Symfony\Component\Security\Core\Authorization\Voter\AbstractVoter';
if (!$isNewOverwritten) {
@trigger_error(sprintf("The AbstractVoter::isGranted method is deprecated since 2.8 and won't be called anymore in 3.0. Override voteOnAttribute() instead.", $reflector->class), E_USER_DEPRECATED);
}

foreach ($attributes as $attribute) {
if (!$this->supports($attribute, $class)) {
continue;
Expand All @@ -84,16 +78,9 @@ public function vote(TokenInterface $token, $object, array $attributes)
// as soon as at least one attribute is supported, default is to deny access
$vote = self::ACCESS_DENIED;

if ($isNewOverwritten) {
if ($this->voteOnAttribute($attribute, $object, $token)) {
// grant access as soon as at least one voter returns a positive response
return self::ACCESS_GRANTED;
}
} else {
if ($this->isGranted($attribute, $object, $token->getUser())) {
// grant access as soon as at least one voter returns a positive response
return self::ACCESS_GRANTED;
}
if ($this->voteOnAttribute($attribute, $object, $token)) {
// grant access as soon as at least one voter returns a positive response
return self::ACCESS_GRANTED;
}
}

Expand Down Expand Up @@ -191,7 +178,8 @@ protected function getSupportedAttributes()
*/
protected function isGranted($attribute, $object, $user = null)
{
return false;
// forces isGranted() or voteOnAttribute() to be overridden
throw new \BadMethodCallException(sprintf('You must override the voteOnAttribute() method in "%s".', get_class($this)));
}

/**
Expand All @@ -211,6 +199,9 @@ protected function isGranted($attribute, $object, $user = null)
*/
protected function voteOnAttribute($attribute, $object, TokenInterface $token)
{
return false;
// the user should override this method, and not rely on the deprecated isGranted()
@trigger_error(sprintf("The AbstractVoter::isGranted() method is deprecated since 2.8 and won't be called anymore in 3.0. Override voteOnAttribute() in %s instead.", get_class($this)), E_USER_DEPRECATED);

return $this->isGranted($attribute, $object, $token->getUser());
}
}
38 changes: 30 additions & 8 deletions src/Symfony/Component/Security/Core/Tests/Authorization/Voter/AbstractVoterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,10 @@
*/
class AbstractVoterTest extends \PHPUnit_Framework_TestCase
{
/**
* @var AbstractVoter
*/
private $voter;

private $token;

protected function setUp()
{
$this->voter = new VoterFixture();

$tokenMock = $this->getMock('Symfony\Component\Security\Core\Authentication\Token\TokenInterface');
$tokenMock
->expects($this->any())
Expand All @@ -44,7 +37,9 @@ protected function setUp()
*/
public function testVote($expectedVote, $object, $attributes, $message)
{
$this->assertEquals($expectedVote, $this->voter->vote($this->token, $object, $attributes), $message);
$voter = new VoterFixture();

$this->assertEquals($expectedVote, $voter->vote($this->token, $object, $attributes), $message);
}

/**
Expand All @@ -58,6 +53,16 @@ public function testVoteUsingDeprecatedIsGranted($expectedVote, $object, $attrib
$this->assertEquals($expectedVote, $voter->vote($this->token, $object, $attributes), $message);
}

/**
* @group legacy
* @expectedException \BadMethodCallException
*/
public function testNoOverriddenMethodsThrowsException()
{
$voter = new DeprecatedVoterNothingImplementedFixture();
$voter->vote($this->token, new ObjectFixture(), array('foo'));
}

public function getData()
{
return array(
Expand Down Expand Up @@ -113,6 +118,23 @@ protected function isGranted($attribute, $object, $user = null)
}
}

class DeprecatedVoterNothingImplementedFixture extends AbstractVoter
{
protected function getSupportedClasses()
{
return array(
'Symfony\Component\Security\Core\Tests\Authorization\Voter\ObjectFixture',
);
}

protected function getSupportedAttributes()
{
return array('foo', 'bar', 'baz');
}

// this is a bad voter that hasn't overridden isGranted or voteOnAttribute
}

class ObjectFixture
{
}
Expand Down