Fixed phpdoc

Author: ezimuel

src/Adapter/BasicAccess.php

@@ -15,20 +15,41 @@
 
 class BasicAccess implements AuthenticationInterface
 {
-    protected $register;
+    /**
+     * @var UserRepositoryInterface
+     */
+    protected $repository;
+
+    /**
+     * @var string
+     */
     protected $realm;
+
+    /**
+     * @var ResponseInterface
+     */
     protected $responsePrototype;
 
+    /**
+     * Constructor
+     *
+     * @param UserRepositoryInterface $repository
+     * @param string $realm
+     * @param ResponseInterface $responsePrototype
+     */
     public function __construct(
-        UserRepositoryInterface $register,
+        UserRepositoryInterface $repository,
         string $realm,
         ResponseInterface $responsePrototype
     ) {
-        $this->register = $register;
+        $this->repository = $repository;
         $this->realm = $realm;
         $this->responsePrototype = $responsePrototype;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public function authenticate(ServerRequestInterface $request): ?UserInterface
     {
         $authHeader = $request->getHeader('Authorization');
@@ -40,9 +61,12 @@ public function authenticate(ServerRequestInterface $request): ?UserInterface
         }
         [$username, $password] = explode(':', base64_decode($match[1]));
 
-        return $this->register->authenticate($username, $password);
+        return $this->repository->authenticate($username, $password);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public function unauthorizedResponse(ServerRequestInterface $request): ResponseInterface
     {
         return $this->responsePrototype->withHeader(

src/Adapter/PhpSession.php

@@ -15,20 +15,41 @@
 
 class PhpSession implements AuthenticationInterface
 {
-    protected $register;
+    /**
+     * @var UserRepositoryInterface
+     */
+    protected $repository;
+
+    /**
+     * @var array
+     */
     protected $config;
+
+    /**
+     * @var ResponseInterface
+     */
     protected $responsePrototype;
 
+    /**
+     * Constructor
+     *
+     * @param UserRepositoryInterface $repository
+     * @param array $config
+     * @param ResponseInterface $responsePrototype
+     */
     public function __construct(
-        UserRepositoryInterface $register,
+        UserRepositoryInterface $repository,
         array $config,
         ResponseInterface $responsePrototype
     ) {
-        $this->register = $register;
+        $this->repository = $repository;
         $this->config = $config;
         $this->responsePrototype = $responsePrototype;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public function authenticate(ServerRequestInterface $request): ?UserInterface
     {
         $cookies = $request->getCookieParams();
@@ -47,7 +68,7 @@ public function authenticate(ServerRequestInterface $request): ?UserInterface
             if (!isset($params[$username]) || !isset($params[$password])) {
                 return null;
             }
-            $user = $this->register->authenticate(
+            $user = $this->repository->authenticate(
                 $params[$username],
                 $params[$password]
             );
@@ -60,6 +81,9 @@ public function authenticate(ServerRequestInterface $request): ?UserInterface
         return null;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public function unauthorizedResponse(ServerRequestInterface $request): ResponseInterface
     {
         return $this->responsePrototype->withHeader(
@@ -68,6 +92,12 @@ public function unauthorizedResponse(ServerRequestInterface $request): ResponseI
         )->withStatus(301);
     }
 
+    /**
+     * Set the PHP SESSION ID
+     *
+     * @param string $id
+     * @return void
+     */
     private function setSessionId(string $id): void
     {
         session_name(AuthenticationInterface::class);

src/Adapter/ZendAuthentication.php

@@ -18,10 +18,28 @@ class ZendAuthentication implements AuthenticationInterface
 {
     use UserTrait;
 
+    /**
+     * @var AuthenticationService
+     */
     protected $auth;
+
+    /**
+     * @var array
+     */
     protected $config;
+
+    /**
+     * @var ResponseInterface
+     */
     protected $responsePrototype;
 
+    /**
+     * Constructor
+     *
+     * @param AuthenticationService $auth
+     * @param array $config
+     * @param ResponseInterface $responsePrototype
+     */
     public function __construct(
         AuthenticationService $auth,
         array $config,
@@ -32,6 +50,9 @@ public function __construct(
         $this->responsePrototype = $responsePrototype;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public function authenticate(ServerRequestInterface $request): ?UserInterface
     {
         if ('POST' === $request->getMethod()) {
@@ -56,6 +77,9 @@ public function authenticate(ServerRequestInterface $request): ?UserInterface
                null;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public function unauthorizedResponse(ServerRequestInterface $request): ResponseInterface
     {
         return $this->responsePrototype->withHeader(

src/ConfigProvider.php

@@ -27,7 +27,7 @@ public function getDependencies() : array
     {
         return [
             'aliases' => [
-                // Change the alias value for Authentication adapter and
+                // Change the alias values for Authentication adapter and
                 // UserRepository adapter
                 AuthenticationInterface::class => Adapter\BasicAccess::class,
                 UserRepositoryInterface::class => UserRepository\Htpasswd::class

src/ResponsePrototypeTrait.php

@@ -12,6 +12,13 @@
 
 trait ResponsePrototypeTrait
 {
+    /**
+     * Return a ResponseInterface service if present or Zend\Diactoros\Response
+     *
+     * @param ContainerInterface $container
+     * @throws Exception\InvalidConfigException
+     * @return ResponseInterface
+     */
     protected function getResponsePrototype(ContainerInterface $container): ResponseInterface
     {
         if (! $container->has(ResponseInterface::class)
@@ -20,7 +27,7 @@ protected function getResponsePrototype(ContainerInterface $container): Response
             throw new Exception\InvalidConfigException(sprintf(
                 'Cannot create %s service; dependency %s is missing. Either define the service, '
                 . 'or install zendframework/zend-diactoros',
-                OAuth2Middleware::class,
+                static::class,
                 ResponseInterface::class
             ));
         }

src/UserRepository/Htpasswd.php

@@ -13,14 +13,17 @@
 /**
  * Adapter for Apache htpasswd file
  * It supports only bcrypt hash password for security reason
+ * @see https://httpd.apache.org/docs/2.4/programs/htpasswd.html
  */
-
 class Htpasswd implements UserRepositoryInterface
 {
-    protected $authenticatedUser = null;
-
     use UserTrait;
 
+    /**
+     * Constructor
+     *
+     * @param string $filename
+     */
     public function __construct(string $filename)
     {
         if (! file_exists($filename)) {

src/UserRepository/PdoDatabase.php

@@ -19,6 +19,12 @@ class PdoDatabase implements UserRepositoryInterface
 {
     use UserTrait;
 
+    /**
+     * Constructor
+     *
+     * @param PDO $pdo
+     * @param array $config
+     */
     public function __construct(PDO $pdo, array $config)
     {
         $this->pdo = $pdo;

src/UserRepository/PdoDatabaseFactory.php

@@ -42,7 +42,11 @@ public function __invoke(ContainerInterface $container) : PdoDatabase
             );
         }
         return new PdoDatabase(
-            new PDO($pdo['dsn'], $pdo['username'] ?? null, $pdo['password'] ?? null),
+            new PDO(
+                $pdo['dsn'],
+                $pdo['username'] ?? null,
+                $pdo['password'] ?? null
+            ),
             $pdo
         );
     }

src/UserRepository/UserTrait.php

@@ -1,14 +1,26 @@
 <?php
+/**
+ * @see       https://github.com/zendframework/zend-expressive-authentication for the canonical source repository
+ * @copyright Copyright (c) 2017 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   https://github.com/zendframework/zend-expressive-authentication/blob/master/LICENSE.md New BSD License
+ */
+
 namespace Zend\Expressive\Authentication\UserRepository;
 
 use Zend\Expressive\Authentication\UserInterface;
 
 trait UserTrait
 {
+    /**
+     * Generate a user from $username and $role
+     *
+     * @param string $username
+     * @param string $role
+     * @return UserInterface
+     */
     protected function generateUser(string $username, string $role): UserInterface
     {
         return new class($username, $role) implements UserInterface {
-
             public function __construct($username, $role)
             {
                 $this->username = $username;