Improved documentation

lucadegasperi · Dec 11, 2013 · 2a96807 · 2a96807
1 parent 2543f09
commit 2a96807
Show file tree

Hide file tree

Showing 3 changed files with 351 additions and 1 deletion.
diff --git a/src/LucaDegasperi/OAuth2Server/Repositories/FluentClient.php b/src/LucaDegasperi/OAuth2Server/Repositories/FluentClient.php
@@ -6,7 +6,46 @@
 
 class FluentClient implements ClientInterface
 {
-
+    /**
+     * Validate a client
+     *
+     * Example SQL query:
+     *
+     * <code>
+     * # Client ID + redirect URI
+     * SELECT oauth_clients.id, oauth_clients.secret, oauth_client_endpoints.redirect_uri, oauth_clients.name
+     *  FROM oauth_clients LEFT JOIN oauth_client_endpoints ON oauth_client_endpoints.client_id = oauth_clients.id
+     *  WHERE oauth_clients.id = :clientId AND oauth_client_endpoints.redirect_uri = :redirectUri
+     *
+     * # Client ID + client secret
+     * SELECT oauth_clients.id, oauth_clients.secret, oauth_clients.name FROM oauth_clients WHERE
+     *  oauth_clients.id = :clientId AND oauth_clients.secret = :clientSecret
+     *
+     * # Client ID + client secret + redirect URI
+     * SELECT oauth_clients.id, oauth_clients.secret, oauth_client_endpoints.redirect_uri, oauth_clients.name FROM
+     *  oauth_clients LEFT JOIN oauth_client_endpoints ON oauth_client_endpoints.client_id = oauth_clients.id
+     *  WHERE oauth_clients.id = :clientId AND oauth_clients.secret = :clientSecret AND
+     *  oauth_client_endpoints.redirect_uri = :redirectUri
+     * </code>
+     *
+     * Response:
+     *
+     * <code>
+     * Array
+     * (
+     *     [client_id] => (string) The client ID
+     *     [client secret] => (string) The client secret
+     *     [redirect_uri] => (string) The redirect URI used in this request
+     *     [name] => (string) The name of the client
+     * )
+     * </code>
+     *
+     * @param  string     $clientId     The client's ID
+     * @param  string     $clientSecret The client's secret (default = "null")
+     * @param  string     $redirectUri  The client's redirect URI (default = "null")
+     * @param  string     $grantType    The grant type used in the request (default = "null")
+     * @return bool|array               Returns false if the validation fails, array on success
+     */
     public function getClient($clientId, $clientSecret = null, $redirectUri = null, $grantType = null)
     {
         $query = null;

diff --git a/src/LucaDegasperi/OAuth2Server/Repositories/FluentScope.php b/src/LucaDegasperi/OAuth2Server/Repositories/FluentScope.php
@@ -7,6 +7,32 @@
 class FluentScope implements ScopeInterface
 {
 
+    /**
+     * Return information about a scope
+     *
+     * Example SQL query:
+     *
+     * <code>
+     * SELECT * FROM oauth_scopes WHERE scope = :scope
+     * </code>
+     *
+     * Response:
+     *
+     * <code>
+     * Array
+     * (
+     *     [id] => (int) The scope's ID
+     *     [scope] => (string) The scope itself
+     *     [name] => (string) The scope's name
+     *     [description] => (string) The scope's description
+     * )
+     * </code>
+     *
+     * @param  string     $scope     The scope
+     * @param  string     $clientId  The client ID (default = "null")
+     * @param  string     $grantType The grant type used in the request (default = "null")
+     * @return bool|array If the scope doesn't exist return false
+     */
     public function getScope($scope, $clientId = null, $grantType = null)
     {
          $query = DB::table('oauth_scopes')