Add an interface for security passports which support attributes

mbabker · mbabker · commit a8aa89ad61be · 2021-07-18T19:10:34.000-05:00
diff --git a/src/Symfony/Component/Security/Http/Authenticator/Passport/AttributedPassportInterface.php b/src/Symfony/Component/Security/Http/Authenticator/Passport/AttributedPassportInterface.php
@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Security\Http\Authenticator\Passport;
+
+/**
+ * Represents a passport which contains attributes.
+ */
+interface AttributedPassportInterface extends PassportInterface
+{
+    /**
+     * @param mixed $value
+     */
+    public function setAttribute(string $name, $value): void;
+
+    /**
+     * @param mixed $default
+     *
+     * @return mixed
+     */
+    public function getAttribute(string $name, $default = null);
+}
diff --git a/src/Symfony/Component/Security/Http/Authenticator/Passport/Passport.php b/src/Symfony/Component/Security/Http/Authenticator/Passport/Passport.php
@@ -21,7 +21,7 @@
  *
  * @author Wouter de Jong <wouter@wouterj.nl>
  */
-class Passport implements UserPassportInterface
+class Passport implements UserPassportInterface, AttributedPassportInterface
 {
     use PassportTrait;
 
@@ -60,17 +60,15 @@ public function getUser(): UserInterface
     }
 
     /**
-     * @param mixed $value
+     * {@inheritdoc}
      */
     public function setAttribute(string $name, $value): void
     {
         $this->attributes[$name] = $value;
     }
 
     /**
-     * @param mixed $default
-     *
-     * @return mixed
+     * {@inheritdoc}
      */
     public function getAttribute(string $name, $default = null)
     {
diff --git a/src/Symfony/Component/Security/Http/CHANGELOG.md b/src/Symfony/Component/Security/Http/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
  * Deprecate not setting the 5th argument (`$exceptionOnNoToken`) of `AccessListener` to `false`
  * Deprecate `DeauthenticatedEvent`, use `TokenDeauthenticatedEvent` instead
+ * Add `AttributedPassportInterface`
 
 5.3
 ---

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`*`
`22`	`22`	`* @author Wouter de Jong <[email protected]>`
`23`	`23`	`*/`
`24`		`-class Passport implements UserPassportInterface`
	`24`	`+class Passport implements UserPassportInterface, AttributedPassportInterface`
`25`	`25`	`{`
`26`	`26`	`use PassportTrait;`
`27`	`27`
`@@ -60,17 +60,15 @@ public function getUser(): UserInterface`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`/**`
`63`		`- * @param mixed $value`
	`63`	`+ * {@inheritdoc}`
`64`	`64`	`*/`
`65`	`65`	`public function setAttribute(string $name, $value): void`
`66`	`66`	`{`
`67`	`67`	`$this->attributes[$name] = $value;`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`/**`
`71`		`- * @param mixed $default`
`72`		`- *`
`73`		`- * @return mixed`
	`71`	`+ * {@inheritdoc}`
`74`	`72`	`*/`
`75`	`73`	`public function getAttribute(string $name, $default = null)`
`76`	`74`	`{`