Rename vote $reason to $message, $parameters to $context

symfony · yellow1912 · Sep 23, 2021 · Sep 23, 2021 · Sep 23, 2021 · Sep 23, 2021
commit 7589a16facd12e0000c528d392269394e5bde23c
@@ -376,7 +376,7 @@
                                                    unknown ({{ voter_detail['vote'].access }})
                                                {% endif %}
                                            </td>
-                                            <td class="font-normal text-small">{{ voter_detail['vote'].reason|default('~') }}</td>
+                                            <td class="font-normal text-small">{{ voter_detail['vote'].message|default('~') }}</td>
                                        </tr>
                                    {% endfor %}
                                    </tbody>

@@ -13,25 +13,25 @@

 /**
 * A Vote is returned by a Voter and contains the access (granted, abstain or denied).
- * It can also contain a reason explaining the vote decision.
+ * It can also contain a message explaining the vote decision.
 *
 * @author Dany Maillard <danymaillard93b@gmail.com>
 */
 final class Vote
 {
    /** @var int One of the VoterInterface::ACCESS_* constants */
    private $access;
-    private $reason;
-    private $parameters;
+    private $message;
+    private $context;

    /**
     * @param int $access One of the VoterInterface::ACCESS_* constants
     */
-    public function __construct(int $access, string $reason = '', array $parameters = [])
+    public function __construct(int $access, string $message = '', array $context = [])
    {
        $this->access = $access;
-        $this->reason = $reason;
-        $this->parameters = $parameters;
+        $this->message = $message;
+        $this->context = $context;
    }

    public function getAccess(): int
@@ -54,38 +54,38 @@ public function isDenied(): bool
        return VoterInterface::ACCESS_DENIED === $this->access;
    }

-    public static function create(int $access, string $reason = '', array $parameters = []): self
+    public static function create(int $access, string $message = '', array $context = []): self
    {
-        return new self($access, $reason, $parameters);
+        return new self($access, $message, $context);
    }

-    public static function createGranted(string $reason = '', array $parameters = []): self
+    public static function createGranted(string $message = '', array $context = []): self
    {
-        return new self(VoterInterface::ACCESS_GRANTED, $reason, $parameters);
+        return new self(VoterInterface::ACCESS_GRANTED, $message, $context);
    }

-    public static function createAbstain(string $reason = '', array $parameters = []): self
+    public static function createAbstain(string $message = '', array $context = []): self
    {
-        return new self(VoterInterface::ACCESS_ABSTAIN, $reason, $parameters);
+        return new self(VoterInterface::ACCESS_ABSTAIN, $message, $context);
    }

-    public static function createDenied(string $reason = '', array $parameters = []): self
+    public static function createDenied(string $message = '', array $context = []): self
    {
-        return new self(VoterInterface::ACCESS_DENIED, $reason, $parameters);
+        return new self(VoterInterface::ACCESS_DENIED, $message, $context);
    }

-    public function setReason(string $reason)
+    public function setMessage(string $message)
    {
-        $this->reason = $reason;
+        $this->message = $message;
    }

-    public function getReason(): string
+    public function getMessage(): string
    {
-        return $this->reason;
+        return $this->message;
    }

-    public function getParameters(): array
+    public function getContext(): array
    {
-        return $this->parameters;
+        return $this->context;
    }
 }
@@ -62,7 +62,7 @@ public function vote(TokenInterface $token, $subject, array $attributes)
                return $decision;
            }

-            $vote->setReason($vote->getReason().trim(' '.$decision->getReason()));
+            $vote->setMessage($vote->getMessage().trim(' '.$decision->getMessage()));
        }

        return $vote;
@@ -71,25 +71,25 @@ public function vote(TokenInterface $token, $subject, array $attributes)
    /**
     * Creates a granted vote.
     */
-    protected function grant(string $reason = '', array $parameters = []): Vote
+    protected function grant(string $message = '', array $context = []): Vote
    {
-        return Vote::createGranted($reason, $parameters);
+        return Vote::createGranted($message, $context);
    }

    /**
     * Creates an abstained vote.
     */
-    protected function abstain(string $reason = '', array $parameters = []): Vote
+    protected function abstain(string $message = '', array $context = []): Vote
    {
-        return Vote::createAbstain($reason, $parameters);
+        return Vote::createAbstain($message, $context);
    }

    /**
     * Creates a denied vote.
     */
-    protected function deny(string $reason = '', array $parameters = []): Vote
+    protected function deny(string $message = '', array $context = []): Vote
    {
-        return Vote::createDenied($reason, $parameters);
+        return Vote::createDenied($message, $context);
    }

    /**

@@ -73,11 +73,11 @@ public function setAccessDecision(AccessDecision $accessDecision)
            return;
        }

-        $reasons = array_map(static function (Vote $vote) {
-            return $vote->getReason();
+        $messages = array_map(static function (Vote $vote) {
+            return $vote->getMessage();
        }, $accessDecision->getDeniedVotes());

-        $this->message .= ' '.rtrim(' '.implode(' ', $reasons));
+        $this->message .= ' '.rtrim(' '.implode(' ', $messages));
    }

    public function getAccessDecision(): AccessDecision