bug #4139 cleaned up the code example (gondo)

weaverryan · weaverryan · commit 53b2c2be9f07 · 2014-08-19T17:42:32.000-04:00
This PR was submitted for the 2.5 branch but it was merged into the 2.3 branch instead (closes #4139). Discussion ---------- cleaned up the code example - added final return for `vote()` function - moved `$user` below attribute check. if attribute fails, we don't need user - used already declared constants in switch statement, rather than harcoded strings Commits ------- 081b3c7 cleaned up the code example
diff --git a/cookbook/security/voters_data_permission.rst b/cookbook/security/voters_data_permission.rst
@@ -105,36 +105,38 @@ edit a particular object. Here's an example implementation::
             // set the attribute to check against
             $attribute = $attributes[0];
 
-            // get current logged in user
-            $user = $token->getUser();
-
             // check if the given attribute is covered by this voter
             if (!$this->supportsAttribute($attribute)) {
                 return VoterInterface::ACCESS_ABSTAIN;
             }
 
+            // get current logged in user
+            $user = $token->getUser();
+
             // make sure there is a user object (i.e. that the user is logged in)
             if (!$user instanceof UserInterface) {
                 return VoterInterface::ACCESS_DENIED;
             }
 
             switch($attribute) {
-                case 'view':
+                case self::VIEW:
                     // the data object could have for example a method isPrivate()
                     // which checks the Boolean attribute $private
                     if (!$post->isPrivate()) {
                         return VoterInterface::ACCESS_GRANTED;
                     }
                     break;
 
-                case 'edit':
+                case self::EDIT:
                     // we assume that our data object has a method getOwner() to
                     // get the current owner user entity for this data object
                     if ($user->getId() === $post->getOwner()->getId()) {
                         return VoterInterface::ACCESS_GRANTED;
                     }
                     break;
             }
+            
+            return VoterInterface::ACCESS_DENIED;
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -105,36 +105,38 @@ edit a particular object. Here's an example implementation::`
`105`	`105`	`// set the attribute to check against`
`106`	`106`	`$attribute = $attributes[0];`
`107`	`107`
`108`		`- // get current logged in user`
`109`		`- $user = $token->getUser();`
`110`		`-`
`111`	`108`	`// check if the given attribute is covered by this voter`
`112`	`109`	`if (!$this->supportsAttribute($attribute)) {`
`113`	`110`	`return VoterInterface::ACCESS_ABSTAIN;`
`114`	`111`	`}`
`115`	`112`
	`113`	`+ // get current logged in user`
	`114`	`+ $user = $token->getUser();`
	`115`	`+`
`116`	`116`	`// make sure there is a user object (i.e. that the user is logged in)`
`117`	`117`	`if (!$user instanceof UserInterface) {`
`118`	`118`	`return VoterInterface::ACCESS_DENIED;`
`119`	`119`	`}`
`120`	`120`
`121`	`121`	`switch($attribute) {`
`122`		`- case 'view':`
	`122`	`+ case self::VIEW:`
`123`	`123`	`// the data object could have for example a method isPrivate()`
`124`	`124`	`// which checks the Boolean attribute $private`
`125`	`125`	`if (!$post->isPrivate()) {`
`126`	`126`	`return VoterInterface::ACCESS_GRANTED;`
`127`	`127`	`}`
`128`	`128`	`break;`
`129`	`129`
`130`		`- case 'edit':`
	`130`	`+ case self::EDIT:`
`131`	`131`	`// we assume that our data object has a method getOwner() to`
`132`	`132`	`// get the current owner user entity for this data object`
`133`	`133`	`if ($user->getId() === $post->getOwner()->getId()) {`
`134`	`134`	`return VoterInterface::ACCESS_GRANTED;`
`135`	`135`	`}`
`136`	`136`	`break;`
`137`	`137`	`}`
	`138`	`+`
	`139`	`+ return VoterInterface::ACCESS_DENIED;`
`138`	`140`	`}`
`139`	`141`	`}`
`140`	`142`