Adding some inline documentation

Author: lucadegasperi

src/LucaDegasperi/OAuth2Server/Commands/ExpiredTokensCommand.php

@@ -27,6 +27,7 @@ class ExpiredTokensCommand extends Command
     /**
      * Create a new command instance.
      *
+     * @param SessionManagementInterface $sessions an implementation of the session management interface
      * @return void
      */
     public function __construct(SessionManagementInterface $sessions)
@@ -74,6 +75,11 @@ protected function getOptions()
         );
     }
 
+    /**
+     * Deletes the sessions with expired authorization and refresh tokens from the db
+     * 
+     * @return int the number of sessions deleted
+     */
     protected function deleteExpiredTokens()
     {
         return $this->sessions->deleteExpired();

src/LucaDegasperi/OAuth2Server/Facades/AuthorizationServerFacade.php

@@ -6,6 +6,9 @@ class AuthorizationServerFacade extends Facade
 {
 
     /**
+     * Get the registered name of the component
+     *
+     * @return string
      * @codeCoverageIgnore
      */
     protected static function getFacadeAccessor()

src/LucaDegasperi/OAuth2Server/Facades/ResourceServerFacade.php

@@ -6,6 +6,9 @@ class ResourceServerFacade extends Facade
 {
 
     /**
+     * Get the registered name of the component
+     *
+     * @return string
      * @codeCoverageIgnore
      */
     protected static function getFacadeAccessor()

src/LucaDegasperi/OAuth2Server/Filters/CheckAuthorizationParamsFilter.php

@@ -9,6 +9,14 @@
 class CheckAuthorizationParamsFilter
 {
 
+    /**
+     * Run the check authorization params filter
+     *
+     * @param Route $route the route being called
+     * @param Request $request the request object
+     * @param string $scope additional filter arguments
+     * @return Response|null a bad response in case the params are invalid
+     */
     public function filter($route, $request, $scope = null)
     {
         try {

src/LucaDegasperi/OAuth2Server/Filters/OAuthFilter.php

@@ -7,6 +7,14 @@
 class OAuthFilter
 {
 
+    /**
+     * Run the oauth filter
+     *
+     * @param Route $route the route being called
+     * @param Request $request the request object
+     * @param string $scope additional filter arguments
+     * @return Response|null a bad response in case the request is invalid
+     */
     public function filter($route, $request, $scope = null)
     {
         try {

src/LucaDegasperi/OAuth2Server/Filters/OAuthOwnerFilter.php

@@ -5,7 +5,14 @@
 
 class OAuthOwnerFilter
 {
-
+    /**
+     * Run the oauth owner filter
+     *
+     * @param Route $route the route being called
+     * @param Request $request the request object
+     * @param string $scope the allowed owners (comma separated)
+     * @return Response|null a bad response in case the owner is not authorized
+     */
     public function filter($route, $request, $scope = null)
     {
         if (! is_null($scope) and ResourceServer::getOwnerType() !== $scope) {

src/LucaDegasperi/OAuth2Server/Proxies/AuthorizationServerProxy.php

@@ -8,14 +8,29 @@
 
 class AuthorizationServerProxy
 {
-
+    /**
+     * The OAuth authorization server
+     * @var [type]
+     */
     protected $authServer;
 
+    /**
+     * Create a new AuthorizationServerProxy
+     * 
+     * @param Authorization $authServer the OAuth Authorization Server to use
+     */
     public function __construct(Authorization $authServer)
     {
         $this->authServer = $authServer;
     }
 
+    /**
+     * Pass the method call to the underlying Authorization Server
+     * 
+     * @param  string $method the method being called
+     * @param  array|null $args the arguments of the method being called
+     * @return mixed the underlying method retuned value
+     */
     public function __call($method, $args)
     {
         switch (count($args)) {
@@ -34,11 +49,25 @@ public function __call($method, $args)
         }
     }
 
+    /**
+     * Make a redirect to a client redirect URI
+     * @param  string $uri            the uri to redirect to
+     * @param  array  $params         the query string parameters
+     * @param  string $queryDelimeter the query string delimiter
+     * @return Redirect               a Redirect object
+     */
     public function makeRedirect($uri, $params = array(), $queryDelimeter = '?')
     {
         return RedirectUri::make($uri, $params, $queryDelimeter);
     }
 
+    /**
+     * Make a redirect with an authorization code
+     * 
+     * @param  string $code   the authorization code of the redirection
+     * @param  array  $params the redirection parameters
+     * @return Redirect       a Redirect object
+     */
     public function makeRedirectWithCode($code, $params = array())
     {
         return $this->makeRedirect($params['redirect_uri'], array(
@@ -47,6 +76,12 @@ public function makeRedirectWithCode($code, $params = array())
         ));
     }
 
+    /**
+     * Make a redirect with an error
+     * 
+     * @param  array  $params the redirection parameters
+     * @return Redirect       a Redirect object
+     */
     public function makeRedirectWithError($params = array())
     {
         return $this->makeRedirect($params['redirect_uri'], array(
@@ -56,16 +91,34 @@ public function makeRedirectWithError($params = array())
         ));
     }
 
+    /**
+     * Check the authorization code request parameters
+     * 
+     * @throws \OAuth2\Exception\ClientException
+     * @return array Authorize request parameters
+     */
     public function checkAuthorizeParams()
     {
         return $this->authServer->getGrantType('authorization_code')->checkAuthoriseParams();
     }
 
+    /**
+     * Authorize a new client
+     * @param  string $owner    The owner type
+     * @param  string $owner_id The owner id
+     * @param  array  $options  Additional options to issue an authorization code
+     * @return string           An authorization code
+     */
     public function newAuthorizeRequest($owner, $owner_id, $options)
     {
         return $this->authServer->getGrantType('authorization_code')->newAuthoriseRequest($owner, $owner_id, $options);
     }
 
+    /**
+     * Perform the access token flow
+     * 
+     * @return Response the appropriate response object
+     */
     public function performAccessTokenFlow()
     {
         try {