Add phpstan- prefix to annotations which are not supported by IDE yet

orisai · Dec 3, 2020 · 003ae0a · 003ae0a
1 parent 3787811
commit 003ae0a
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/src/Authentication/BaseFirewall.php b/src/Authentication/BaseFirewall.php
@@ -18,8 +18,8 @@
 use Orisai\Exceptions\Message;
 
 /**
- * @template T of Identity
- * @implements Firewall<T>
+ * @phpstan-template T of Identity
+ * @phpstan-implements Firewall<T>
  */
 abstract class BaseFirewall implements Firewall
 {

diff --git a/src/Authentication/Firewall.php b/src/Authentication/Firewall.php
@@ -10,7 +10,7 @@
 use Orisai\Auth\Authentication\Exception\CannotSetExpiration;
 
 /**
- * @template T of Identity
+ * @phpstan-template T of Identity
  */
 interface Firewall
 {
@@ -24,20 +24,20 @@ interface Firewall
 	public function isLoggedIn(): bool;
 
 	/**
-	 * @param T $identity
+	 * @phpstan-param T $identity
 	 */
 	public function login(Identity $identity): void;
 
 	/**
-	 * @param T $identity
+	 * @phpstan-param T $identity
 	 * @throws CannotRenewIdentity When user is not logged id
 	 */
 	public function renewIdentity(Identity $identity): void;
 
 	public function logout(): void;
 
 	/**
-	 * @return T
+	 * @phpstan-return T
 	 * @throws CannotAccessIdentity When user is not logged id
 	 */
 	public function getIdentity(): Identity;

diff --git a/src/Authentication/IdentityRenewer.php b/src/Authentication/IdentityRenewer.php
@@ -3,13 +3,13 @@
 namespace Orisai\Auth\Authentication;
 
 /**
- * @template T of Identity
+ * @phpstan-template T of Identity
  */
 interface IdentityRenewer
 {
 
 	/**
-	 * @return T|null
+	 * @phpstan-return T|null
 	 */
 	public function renewIdentity(Identity $identity): ?Identity;