Add type hints & remove unnecessary doc block type hints

Author: olivervogel

phpcs.xml.dist

@@ -78,6 +78,10 @@
     <rule ref="SlevomatCodingStandard.TypeHints.NullableTypeForNullDefaultValue"/>
     <rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHintSpacing"/>
     <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHintSpacing"/>
+    <rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHint"/>
+    <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHint"/>
+    <rule ref="SlevomatCodingStandard.TypeHints.PropertyTypeHint"/>
+    <rule ref="SlevomatCodingStandard.TypeHints.UselessConstantTypeHint"/>
     <rule ref="SlevomatCodingStandard.TypeHints.DNFTypeHintFormat">
         <properties>
             <property name="withSpacesAroundOperators" value="no" />

src/Authenticator.php

@@ -13,21 +13,13 @@ class Authenticator
 {
     /**
      * Create new instance
-     *
-     * @param VaultInterface $vault
-     * @return void
      */
     public function __construct(protected VaultInterface $vault)
     {
     }
 
     /**
      * Create HTTP basic auth instance
-     *
-     * @param string $username
-     * @param string $password
-     * @param string $realm
-     * @return Authenticator
      */
     public static function basic(string $username, string $password, string $realm = 'Secured Area'): self
     {
@@ -36,11 +28,6 @@ public static function basic(string $username, string $password, string $realm =
 
     /**
      * Create HTTP digest auth instance
-     *
-     * @param string $username
-     * @param string $password
-     * @param string $realm
-     * @return Authenticator
      */
     public static function digest(string $username, string $password, string $realm = 'Secured Area'): self
     {
@@ -49,9 +36,6 @@ public static function digest(string $username, string $password, string $realm
 
     /**
      * Create auth instance
-     *
-     * @param VaultInterface $vault
-     * @return Authenticator
      */
     public static function withVault(VaultInterface $vault): self
     {
@@ -62,7 +46,6 @@ public static function withVault(VaultInterface $vault): self
      * Create vault by current parameters and secure it
      *
      * @throws NotSupportedException
-     * @return void
      */
     public function secure(?string $message = null): void
     {

src/Environment.php

@@ -15,7 +15,7 @@ class Environment implements EnvironmentInterface
      *
      * @var array<string>
      */
-    protected static $tokenClassnames = [
+    protected static array $tokenClassnames = [
         Tokens\PhpAuthUser::class,
         Tokens\HttpAuthentification::class,
         Tokens\RedirectHttpAuthorization::class,

src/Interfaces/DirectiveInterface.php

@@ -8,8 +8,6 @@ interface DirectiveInterface
 {
     /**
      * Cast directive to string
-     *
-     * @return string
      */
     public function __toString(): string;
 }

src/Interfaces/EnvironmentInterface.php

@@ -12,7 +12,6 @@ interface EnvironmentInterface
      * Try to parse and return auth token from server environment
      *
      * @throws AuthentificationException
-     * @return TokenInterface
      */
     public static function token(): TokenInterface;
 }

src/Interfaces/TokenInterface.php

@@ -15,71 +15,51 @@ public function parse(): array;
 
     /**
      * Access username of token
-     *
-     * @return null|string
      */
     public function username(): ?string;
 
     /**
      * Access password of token
-     *
-     * @return null|string
      */
     public function password(): ?string;
 
     /**
      * Access cnonce of token
-     *
-     * @return null|string
      */
     public function cnonce(): ?string;
 
     /**
      * Access nc of token
-     *
-     * @return null|string
      */
     public function nc(): ?string;
 
     /**
      * Access nonce of token
-     *
-     * @return null|string
      */
     public function nonce(): ?string;
 
     /**
      * Access qop of token
-     *
-     * @return null|string
      */
     public function qop(): ?string;
 
     /**
      * Access response of token
-     *
-     * @return null|string
      */
     public function response(): ?string;
 
     /**
      * Access uri of token
-     *
-     * @return null|string
      */
     public function uri(): ?string;
 
     /**
      * Access realm of token
-     *
-     * @return null|string
      */
     public function realm(): ?string;
 
     /**
      * Access opaque of token
-     *
-     * @return null|string
      */
     public function opaque(): ?string;
 }

src/Interfaces/VaultInterface.php

@@ -11,9 +11,6 @@ interface VaultInterface
 {
     /**
      * Deny access for non-authenticated users
-     *
-     * @param null|string $message
-     * @return void
      */
     public function secure(?string $message = null): void;
 
@@ -22,21 +19,16 @@ public function secure(?string $message = null): void;
      * verification fails
      *
      * @throws AuthentificationException
-     * @return void
      */
     public function verify(TokenInterface $token): void;
 
     /**
      * Type identifier of vault
-     *
-     * @return Type
      */
     public function type(): Type;
 
     /**
      * Build directive for current vault based on credentials and type
-     *
-     * @return DirectiveInterface
      */
     public function directive(): DirectiveInterface;
 }

src/Tokens/AbstractToken.php

@@ -130,8 +130,6 @@ public function opaque(): ?string
      * Returns null if key doesn't exists
      *
      * @param array<mixed> $data
-     * @param mixed $key
-     * @return mixed
      */
     protected function getArrayValue(array $data, mixed $key): mixed
     {

src/Vaults/AbstractVault.php

@@ -14,10 +14,6 @@ abstract class AbstractVault implements VaultInterface
 {
     /**
      * Create new instance
-     *
-     * @param string $username
-     * @param string $password
-     * @param string $realm
      */
     public function __construct(
         #[SensitiveParameter] protected string $username,
@@ -52,9 +48,6 @@ public function secure(?string $message = null): void
 
     /**
      * Set name of realm
-     *
-     * @param string $realm
-     * @return AbstractVault
      */
     public function setRealm(string $realm): self
     {
@@ -65,8 +58,6 @@ public function setRealm(string $realm): self
 
     /**
      * Return current realm name
-     *
-     * @return string
      */
     public function realm(): string
     {
@@ -75,8 +66,6 @@ public function realm(): string
 
     /**
      * Set username for current vault
-     *
-     * @param string $username
      */
     public function setUsername(string $username): self
     {
@@ -87,8 +76,6 @@ public function setUsername(string $username): self
 
     /**
      * Return current username
-     *
-     * @return string
      */
     public function username(): string
     {
@@ -97,9 +84,6 @@ public function username(): string
 
     /**
      * Set password for current vault
-     *
-     * @param string $password
-     * @return AbstractVault
      */
     public function setPassword(string $password): self
     {
@@ -110,8 +94,6 @@ public function setPassword(string $password): self
 
     /**
      * Return current password
-     *
-     * @return string
      */
     public function password(): string
     {
@@ -120,10 +102,6 @@ public function password(): string
 
     /**
      * Set username and password at once
-     *
-     * @param string $username
-     * @param string $password
-     * @return AbstractVault
      */
     public function setCredentials(string $username, string $password): self
     {
@@ -132,8 +110,6 @@ public function setCredentials(string $username, string $password): self
 
     /**
      * Send HTTP 401 Header
-     *
-     * @return void
      */
     protected function denyAccess(?string $message = null): void
     {

src/Vaults/DigestVault.php

@@ -55,9 +55,6 @@ public function directive(): DirectiveInterface
 
     /**
      * Build and return hash from given token
-     *
-     * @param TokenInterface $token
-     * @return string
      */
     private function tokenHash(TokenInterface $token): string
     {