CS fixes and added docblocs

Author: vinkla

src/Authorizer.php

@@ -48,14 +48,16 @@ class Authorizer
 
     /**
      * The redirect uri generator.
+     *
+     * @var bool|null
      */
     protected $redirectUriGenerator = null;
 
     /**
      * Create a new Authorizer instance.
      *
-     * @param Issuer $issuer
-     * @param Checker $checker
+     * @param \League\OAuth2\Server\AuthorizationServer $issuer
+     * @param \League\OAuth2\Server\ResourceServer $checker
      */
     public function __construct(Issuer $issuer, Checker $checker)
     {
@@ -65,6 +67,8 @@ public function __construct(Issuer $issuer, Checker $checker)
     }
 
     /**
+     * Get the issuer.
+     *
      * @return \League\OAuth2\Server\AuthorizationServer
      */
     public function getIssuer()
@@ -73,6 +77,8 @@ public function getIssuer()
     }
 
     /**
+     * Get the checker.
+     *
      * @return \League\OAuth2\Server\ResourceServer
      */
     public function getChecker()
@@ -249,7 +255,7 @@ public function getResourceOwnerType()
     }
 
     /**
-     * get the client id of the current request.
+     * Get the client id of the current request.
      *
      * @return string
      */

src/Middleware/CheckAuthCodeRequestMiddleware.php

@@ -29,13 +29,23 @@ class CheckAuthCodeRequestMiddleware
     protected $authorizer;
 
     /**
-     * @param Authorizer $authorizer
+     * Create a new check auth code request middleware instance.
+     *
+     * @param \LucaDegasperi\OAuth2Server\Authorizer $authorizer
      */
     public function __construct(Authorizer $authorizer)
     {
         $this->authorizer = $authorizer;
     }
 
+    /**
+     * Handle an incoming request.
+     *
+     * @param \Illuminate\Http\Request  $request
+     * @param \Closure $next
+     *
+     * @return mixed
+     */
     public function handle($request, Closure $next)
     {
         $this->authorizer->checkAuthCodeRequest();

src/Middleware/OAuthExceptionHandlerMiddleware.php

@@ -22,18 +22,25 @@
  */
 class OAuthExceptionHandlerMiddleware
 {
+    /**
+     * Handle an incoming request.
+     *
+     * @param \Illuminate\Http\Request  $request
+     * @param \Closure $next
+     *
+     * @return mixed
+     */
     public function handle($request, Closure $next)
     {
         try {
             return $next($request);
         } catch (OAuthException $e) {
-            return new JsonResponse([
-                    'error' => $e->errorType,
-                    'error_description' => $e->getMessage(),
-                ],
-                $e->httpStatusCode,
-                $e->getHttpHeaders()
-            );
+            $data = [
+                'error' => $e->errorType,
+                'error_description' => $e->getMessage(),
+            ];
+
+            return new JsonResponse($data, $e->httpStatusCode, $e->getHttpHeaders());
         }
     }
 }

src/Middleware/OAuthMiddleware.php

@@ -37,7 +37,9 @@ class OAuthMiddleware
     protected $httpHeadersOnly = false;
 
     /**
-     * @param Authorizer $authorizer
+     * Create a new oauth middleware instance.
+     *
+     * @param \LucaDegasperi\OAuth2Server\Authorizer $authorizer
      * @param bool $httpHeadersOnly
      */
     public function __construct(Authorizer $authorizer, $httpHeadersOnly = false)
@@ -46,6 +48,17 @@ public function __construct(Authorizer $authorizer, $httpHeadersOnly = false)
         $this->httpHeadersOnly = $httpHeadersOnly;
     }
 
+    /**
+     * Handle an incoming request.
+     *
+     * @param \Illuminate\Http\Request $request
+     * @param \Closure $next
+     * @param string|null $scopesString
+     *
+     * @throws \League\OAuth2\Server\Exception\InvalidScopeException
+     *
+     * @return mixed
+     */
     public function handle($request, Closure $next, $scopesString = null)
     {
         $scopes = [];
@@ -65,7 +78,7 @@ public function handle($request, Closure $next, $scopesString = null)
      *
      * @param $scopes
      *
-     * @throws InvalidScopeException
+     * @throws \League\OAuth2\Server\Exception\InvalidScopeException
      */
     public function validateScopes($scopes)
     {

src/Middleware/OAuthOwnerMiddleware.php

@@ -30,13 +30,26 @@ class OAuthOwnerMiddleware
     protected $authorizer;
 
     /**
-     * @param Authorizer $authorizer
+     * Create a new oauth owner middleware instance.
+     *
+     * @param \LucaDegasperi\OAuth2Server\Authorizer $authorizer
      */
     public function __construct(Authorizer $authorizer)
     {
         $this->authorizer = $authorizer;
     }
 
+    /**
+     * Handle an incoming request.
+     *
+     * @param \Illuminate\Http\Request $request
+     * @param \Closure $next
+     * @param string|null $ownerTypesString
+     *
+     * @throws \League\OAuth2\Server\Exception\AccessDeniedException
+     *
+     * @return mixed
+     */
     public function handle($request, Closure $next, $ownerTypesString = null)
     {
         $ownerTypes = [];

src/Storage/AbstractFluentAdapter.php

@@ -22,36 +22,67 @@
 abstract class AbstractFluentAdapter extends AbstractStorage
 {
     /**
+     * The connection resolver instance.
+     *
      * @var \Illuminate\Database\ConnectionResolverInterface
      */
     protected $resolver;
 
     /**
+     * The connection name.
+     *
      * @var string
      */
     protected $connectionName;
 
+    /**
+     * Create a new abstract fluent adapter instance.
+     *
+     * @param \Illuminate\Database\ConnectionResolverInterface $resolver
+     */
     public function __construct(Resolver $resolver)
     {
         $this->resolver = $resolver;
         $this->connectionName = null;
     }
 
+    /**
+     * Set the resolver.
+     *
+     * @param \Illuminate\Database\ConnectionResolverInterface $resolver
+     */
     public function setResolver(Resolver $resolver)
     {
         $this->resolver = $resolver;
     }
 
+    /**
+     * Get the resolver.
+     *
+     * @return \Illuminate\Database\ConnectionResolverInterface
+     */
     public function getResolver()
     {
         return $this->resolver;
     }
 
+    /**
+     * Set the connection name.
+     *
+     * @param string $connectionName
+     *
+     * @return void
+     */
     public function setConnectionName($connectionName)
     {
         $this->connectionName = $connectionName;
     }
 
+    /**
+     * Get the connection.
+     *
+     * @return \Illuminate\Database\ConnectionInterface
+     */
     protected function getConnection()
     {
         return $this->resolver->connection($this->connectionName);

src/Storage/FluentAccessToken.php

@@ -26,7 +26,7 @@ class FluentAccessToken extends AbstractFluentAdapter implements AccessTokenInte
     /**
      * Get an instance of Entities\AccessToken.
      *
-     * @param  string $token The access token
+     * @param string $token The access token
      *
      * @return null|AbstractTokenEntity
      */
@@ -45,7 +45,8 @@ public function get($token)
                ->setExpireTime((int) $result->expire_time);
     }
 
-    /*public function getByRefreshToken(RefreshTokenEntity $refreshToken)
+    /*
+    public function getByRefreshToken(RefreshTokenEntity $refreshToken)
     {
         $result = $this->getConnection()->table('oauth_access_tokens')
                 ->select('oauth_access_tokens.*')
@@ -60,7 +61,8 @@ public function get($token)
         return (new AccessTokenEntity($this->getServer()))
                ->setId($result->id)
                ->setExpireTime((int)$result->expire_time);
-    }*/
+    }
+    */
 
     /**
      * Get the scopes for an access token.
@@ -92,9 +94,9 @@ public function getScopes(AccessTokenEntity $token)
     /**
      * Creates a new access token.
      *
-     * @param  string $token The access token
-     * @param  int $expireTime The expire time expressed as a unix timestamp
-     * @param  string|int $sessionId The session ID
+     * @param string $token The access token
+     * @param int $expireTime The expire time expressed as a unix timestamp
+     * @param string|int $sessionId The session ID
      *
      * @return \League\OAuth2\Server\Entity\AccessTokenEntity
      */

src/Storage/FluentAuthCode.php

@@ -50,7 +50,7 @@ public function get($code)
     /**
      * Get the scopes for an access token.
      *
-     * @param  \League\OAuth2\Server\Entity\AuthCodeEntity $token The auth code
+     * @param \League\OAuth2\Server\Entity\AuthCodeEntity $token The auth code
      *
      * @return array Array of \League\OAuth2\Server\Entity\ScopeEntity
      */

src/Storage/FluentClient.php

@@ -25,12 +25,16 @@
 class FluentClient extends AbstractFluentAdapter implements ClientInterface
 {
     /**
+     * Limit clients to grants.
+     *
      * @var bool
      */
     protected $limitClientsToGrants = false;
 
     /**
-     * @param Resolver $connection
+     * Create a new fluent client instance.
+     *
+     * @param \Illuminate\Database\ConnectionResolverInterface $resolver
      * @param bool $limitClientsToGrants
      */
     public function __construct(Resolver $resolver, $limitClientsToGrants = false)
@@ -40,6 +44,8 @@ public function __construct(Resolver $resolver, $limitClientsToGrants = false)
     }
 
     /**
+     * Check if clients are limited to grants.
+     *
      * @return bool
      */
     public function areClientsLimitedToGrants()
@@ -48,14 +54,18 @@ public function areClientsLimitedToGrants()
     }
 
     /**
-     * @param bool $limit whether or not to limit clients to grants
+     * Whether or not to limit clients to grants.
+     *
+     * @param bool $limit
      */
     public function limitClientsToGrants($limit = false)
     {
         $this->limitClientsToGrants = $limit;
     }
 
     /**
+     * Get the client.
+     *
      * @param string $clientId
      * @param string $clientSecret
      * @param string $redirectUri
@@ -139,6 +149,8 @@ public function getBySession(SessionEntity $session)
     }
 
     /**
+     * Create a new client.
+     *
      * @param string $name The client's unique name
      * @param string $id The client's unique id
      * @param string $secret The clients' unique secret
@@ -157,6 +169,8 @@ public function create($name, $id, $secret)
     }
 
     /**
+     * Hydrate the entity.
+     *
      * @param $result
      *
      * @return \League\OAuth2\Server\Entity\ClientEntity

src/Storage/FluentRefreshToken.php

@@ -25,7 +25,7 @@ class FluentRefreshToken extends AbstractFluentAdapter implements RefreshTokenIn
     /**
      * Return a new instance of \League\OAuth2\Server\Entity\RefreshTokenEntity.
      *
-     * @param  string $token
+     * @param string $token
      *
      * @return \League\OAuth2\Server\Entity\RefreshTokenEntity
      */