bug symfony#3707 make method supportsClass() in custom voter compatible with the interface's documentation (xabbuh)

weaverryan · weaverryan · commit aadc61d4e42a · 2014-03-24T14:57:41.000-04:00
This PR was merged into the 2.3 branch. Discussion ---------- make method supportsClass() in custom voter compatible with the interface's documentation | Q | A | ------------- | --- | Doc fix? | yes | New docs? | no | Applies to | all | Fixed tickets | symfony#3702 Commits ------- 36384db make method supportsClass() in custom voter compatible with the interface's documentation
diff --git a/cookbook/security/voters_data_permission.rst b/cookbook/security/voters_data_permission.rst
@@ -64,7 +64,6 @@ edit a particular object. Here's an example implementation::
     use Symfony\Component\Security\Core\Authorization\Voter\VoterInterface;
     use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
     use Symfony\Component\Security\Core\User\UserInterface;
-    use Acme\DemoBundle\Entity\Post;
 
     class PostVoter implements VoterInterface
     {
@@ -79,9 +78,11 @@ edit a particular object. Here's an example implementation::
             ));
         }
 
-        public function supportsClass($obj)
+        public function supportsClass($class)
         {
-            return $obj instanceof Post;
+            $supportedClass = 'Acme\DemoBundle\Entity\Post';
+
+            return $supportedClass === $class || is_subclass_of($class, $supportedClass);
         }
 
         /**
@@ -90,7 +91,7 @@ edit a particular object. Here's an example implementation::
         public function vote(TokenInterface $token, $post, array $attributes)
         {
             // check if class of this object is supported by this voter
-            if (!$this->supportsClass($post)) {
+            if (!$this->supportsClass(get_class($post))) {
                 return VoterInterface::ACCESS_ABSTAIN;
             }
 

Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,6 @@ edit a particular object. Here's an example implementation::`
`64`	`64`	`use Symfony\Component\Security\Core\Authorization\Voter\VoterInterface;`
`65`	`65`	`use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;`
`66`	`66`	`use Symfony\Component\Security\Core\User\UserInterface;`
`67`		`- use Acme\DemoBundle\Entity\Post;`
`68`	`67`
`69`	`68`	`class PostVoter implements VoterInterface`
`70`	`69`	`{`
`@@ -79,9 +78,11 @@ edit a particular object. Here's an example implementation::`
`79`	`78`	`));`
`80`	`79`	`}`
`81`	`80`
`82`		`- public function supportsClass($obj)`
	`81`	`+ public function supportsClass($class)`
`83`	`82`	`{`
`84`		`- return $obj instanceof Post;`
	`83`	`+ $supportedClass = 'Acme\DemoBundle\Entity\Post';`
	`84`	`+`
	`85`	`+ return $supportedClass === $class \|\| is_subclass_of($class, $supportedClass);`
`85`	`86`	`}`
`86`	`87`
`87`	`88`	`/**`
`@@ -90,7 +91,7 @@ edit a particular object. Here's an example implementation::`
`90`	`91`	`public function vote(TokenInterface $token, $post, array $attributes)`
`91`	`92`	`{`
`92`	`93`	`// check if class of this object is supported by this voter`
`93`		`- if (!$this->supportsClass($post)) {`
	`94`	`+ if (!$this->supportsClass(get_class($post))) {`
`94`	`95`	`return VoterInterface::ACCESS_ABSTAIN;`
`95`	`96`	`}`
`96`	`97`