Add return types to adapter interface

Author: ilijastuden

src/Adapter/AdapterInterface.php

@@ -14,18 +14,9 @@
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 
-/**
- * @package ActiveCollab\Authentication\Adapter
- */
 interface AdapterInterface
 {
-    /**
-     * Initialize authentication layer and see if we have a user who's already logged in.
-     *
-     * @param  ServerRequestInterface $request
-     * @return TransportInterface
-     */
-    public function initialize(ServerRequestInterface $request);
+    public function initialize(ServerRequestInterface $request): ?TransportInterface;
 
     public function applyToRequest(
         ServerRequestInterface $request,
@@ -43,20 +34,10 @@ public function applyTo(
         TransportInterface $transport
     ): array;
 
-    /**
-     * Authenticate user against authentication source.
-     *
-     * @param  AuthenticatedUserInterface    $authenticated_user
-     * @param  array                         $credentials
-     * @return AuthenticationResultInterface
-     */
-    public function authenticate(AuthenticatedUserInterface $authenticated_user, array $credentials = []);
-
-    /**
-     * Terminate an instance that was used to authenticate a user.
-     *
-     * @param  AuthenticationResultInterface $authenticated_with
-     * @return TransportInterface
-     */
-    public function terminate(AuthenticationResultInterface $authenticated_with);
+    public function authenticate(
+        AuthenticatedUserInterface $authenticated_user,
+        array $credentials = []
+    ): AuthenticationResultInterface;
+
+    public function terminate(AuthenticationResultInterface $authenticated_with): TransportInterface;
 }

src/Adapter/BrowserSessionAdapter.php

@@ -53,7 +53,7 @@ public function __construct(
         $this->session_cookie_name = $session_cookie_name;
     }
 
-    public function initialize(ServerRequestInterface $request)
+    public function initialize(ServerRequestInterface $request): ?TransportInterface
     {
         $session_id = $this->cookies->get($request, $this->session_cookie_name);
 
@@ -128,12 +128,15 @@ public function applyToResponse(ResponseInterface $response, TransportInterface
         return $response;
     }
 
-    public function authenticate(AuthenticatedUserInterface $authenticated_user, array $credentials = [])
+    public function authenticate(
+        AuthenticatedUserInterface $authenticated_user,
+        array $credentials = []
+    ): AuthenticationResultInterface
     {
         return $this->session_repository->createSession($authenticated_user, $credentials);
     }
 
-    public function terminate(AuthenticationResultInterface $authenticated_with)
+    public function terminate(AuthenticationResultInterface $authenticated_with): TransportInterface
     {
         if (!$authenticated_with instanceof SessionInterface) {
             throw new InvalidArgumentException('Instance is not a browser session');

src/Adapter/TokenBearerAdapter.php

@@ -15,6 +15,7 @@
 use ActiveCollab\Authentication\AuthenticationResult\AuthenticationResultInterface;
 use ActiveCollab\Authentication\AuthenticationResult\Transport\Authentication\AuthenticationTransport;
 use ActiveCollab\Authentication\AuthenticationResult\Transport\Deauthentication\DeauthenticationTransport;
+use ActiveCollab\Authentication\AuthenticationResult\Transport\TransportInterface;
 use ActiveCollab\Authentication\Exception\InvalidTokenException;
 use ActiveCollab\Authentication\Token\RepositoryInterface as TokenRepositoryInterface;
 use ActiveCollab\Authentication\Token\TokenInterface;
@@ -35,10 +36,7 @@ public function __construct(
         $this->token_repository = $token_repository;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function initialize(ServerRequestInterface $request)
+    public function initialize(ServerRequestInterface $request): ?TransportInterface
     {
         if (!$request->hasHeader('Authorization')) {
             return null;
@@ -67,18 +65,15 @@ public function initialize(ServerRequestInterface $request)
         throw new InvalidTokenException();
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function authenticate(AuthenticatedUserInterface $authenticated_user, array $credentials = [])
+    public function authenticate(
+        AuthenticatedUserInterface $authenticated_user,
+        array $credentials = []
+    ): AuthenticationResultInterface
     {
         return $this->token_repository->issueToken($authenticated_user, $credentials);
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function terminate(AuthenticationResultInterface $authenticated_with)
+    public function terminate(AuthenticationResultInterface $authenticated_with): TransportInterface
     {
         if (!$authenticated_with instanceof TokenInterface) {
             throw new InvalidArgumentException('Instance is not a token');