Replace "Voter" with LastModifiedDeterminator

- removed "parameter"-key from annotation configuration
- put unique advantage forefront in readme

Author: MalteWunsch

NotModified/Annotation/ReplaceWithNotModifiedResponse.php

@@ -11,11 +11,11 @@
 
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpFoundation\Request;
-use Webfactory\HttpCacheBundle\NotModified\VoterInterface;
+use Webfactory\HttpCacheBundle\NotModified\LastModifiedDeterminator;
 
 /**
- * This Annotation determines the last modified date over all of its parameterised voters. This date is used by the
- * \Webfactory\HttpCacheBundle\NotModified\EventListener to possibly replace the execution of a controller with
+ * This Annotation determines the latest last modified date over all of its LastModifiedDeterminators. This date is used
+ * by the \Webfactory\HttpCacheBundle\NotModified\EventListener to possibly replace the execution of a controller with
  * sending a Not Modified HTTP response.
  *
  * @Annotation
@@ -25,8 +25,8 @@ final class ReplaceWithNotModifiedResponse
     /** @var array */
     private $parameters;
 
-    /** @var VoterInterface[] */
-    private $voters;
+    /** @var LastModifiedDeterminator[] */
+    private $lastModifiedDeterminators;
 
     /** @var ContainerInterface */
     private $container;
@@ -48,12 +48,12 @@ public function __construct(array $parameters)
      */
     public function determineLastModified(Request $request)
     {
-        $this->initialiseVoters();
+        $this->initialiseLastModifiedDeterminators();
 
-        foreach ($this->voters as $voter) {
-            $lastModifiedOfCurrentVoter = $voter->getLastModified($request);
-            if ($this->lastModified === null || $this->lastModified < $lastModifiedOfCurrentVoter) {
-                $this->lastModified = $lastModifiedOfCurrentVoter;
+        foreach ($this->lastModifiedDeterminators as $lastModifiedDeterminator) {
+            $lastModifiedOfCurrentDeterminator = $lastModifiedDeterminator->getLastModified($request);
+            if ($this->lastModified === null || $this->lastModified < $lastModifiedOfCurrentDeterminator) {
+                $this->lastModified = $lastModifiedOfCurrentDeterminator;
             }
         }
 
@@ -68,36 +68,36 @@ public function setContainer(ContainerInterface $container)
         $this->container = $container;
     }
 
-    private function initialiseVoters()
+    private function initialiseLastModifiedDeterminators()
     {
-        if (!array_key_exists('voters', $this->parameters) || count($this->parameters['voters']) === 0) {
-            throw new \RuntimeException('The annotation ' . get_class($this) . ' has to be parametrised with voters.');
+        if (count($this->parameters['value']) === 0) {
+            throw new \RuntimeException('The annotation ' . get_class($this) . ' has to be parametrised with LastModifiedDeterminators.');
         }
 
-        foreach ($this->parameters['voters'] as $voterDescription) {
-            $voter = null;
+        foreach ($this->parameters['value'] as $lastModifiedDeterminatorDescription) {
+            $lastModifiedDeterminator = null;
 
-            if (is_string($voterDescription)) {
-                if ($voterDescription[0] === '@') {
-                    $voter = $this->container->get($voterDescription);
+            if (is_string($lastModifiedDeterminatorDescription)) {
+                if ($lastModifiedDeterminatorDescription[0] === '@') {
+                    $lastModifiedDeterminator = $this->container->get($lastModifiedDeterminatorDescription);
                 } else {
-                    $voter = new $voterDescription;
+                    $lastModifiedDeterminator = new $lastModifiedDeterminatorDescription;
                 }
             }
 
-            if (is_array($voterDescription)) {
-                $voterClass = key($voterDescription);
-                $voterParameter = current($voterDescription);
-                $voter = new $voterClass($voterParameter);
+            if (is_array($lastModifiedDeterminatorDescription)) {
+                $lastModifiedDeterminatorClass = key($lastModifiedDeterminatorDescription);
+                $lastModifiedDeterminatorParameter = current($lastModifiedDeterminatorDescription);
+                $lastModifiedDeterminator = new $lastModifiedDeterminatorClass($lastModifiedDeterminatorParameter);
             }
 
-            if (!($voter instanceof VoterInterface)) {
+            if (!($lastModifiedDeterminator instanceof LastModifiedDeterminator)) {
                 throw new \RuntimeException(
-                    'The voter class "' . get_class($voter) . '" does not implement ' . VoterInterface::class . '.'
+                    'The class "' . get_class($lastModifiedDeterminator) . '" does not implement ' . LastModifiedDeterminator::class . '.'
                 );
             }
 
-            $this->voters[] = $voter;
+            $this->lastModifiedDeterminators[] = $lastModifiedDeterminator;
         }
     }
 }

NotModified/VoterInterface.php NotModified/LastModifiedDeterminator.phpNotModified/VoterInterface.php renamed to NotModified/LastModifiedDeterminator.php

@@ -12,12 +12,13 @@
 use Symfony\Component\HttpFoundation\Request;
 
 /**
- * The ReplaceWithNotModifiedResponse method annotation is parameterised with Voters. Each Voter should determine the
- * last modified date of one of the various underlying resources for a response. E.g. if your controller's indexAction
- * builds a response containing News and Users, you can write a NewsVoter determining the date of the last published
- * News and a UserVoter determining the creation date of the last registered User.
+ * The ReplaceWithNotModifiedResponse method annotation is parameterised with instances of LastModifiedDeterminators.
+ * Each of them should determine the last modified date of one of the various underlying resources for a response.
+ * E.g. if your controller's indexAction builds a response containing News and Users, you can write a
+ * NewsLastModifiedDeterminator determining the date of the last published News and a UserLastModifiedDeterminator
+ * determining the creation date of the last registered User.
  */
-interface VoterInterface
+interface LastModifiedDeterminator
 {
     /**
      * @param Request $request