ElyBy-Mirror/oauth2-server
1
0
Fork 0
mirror of https://github.com/elyby/oauth2-server.git synced 2024-12-23 05:29:52 +05:30
Code Issues Packages Projects Releases Wiki Activity

Updated Interface Docs

Browse Source 
Made phpdocs match expectations like null when not found and using array notation for indicating array of <object>
This commit is contained in:
rdohms 2015-03-20 11:33:03 +01:00
parent 19b64c2e65
commit b21de11429
6 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/Storage/AccessTokenInterface.php
View File

@ -24,7 +24,7 @@ interface AccessTokenInterface extends StorageInterface
* *
* @param string $token The access token * @param string $token The access token
* *
* @return \League\OAuth2\Server\Entity\AccessTokenEntity * @return \League\OAuth2\Server\Entity\AccessTokenEntity | null
*/ */
public function get($token); public function get($token);
@ -33,7 +33,7 @@ interface AccessTokenInterface extends StorageInterface
* *
* @param \League\OAuth2\Server\Entity\AccessTokenEntity $token The access token * @param \League\OAuth2\Server\Entity\AccessTokenEntity $token The access token
* *
* @return array Array of \League\OAuth2\Server\Entity\ScopeEntity * @return \League\OAuth2\Server\Entity\ScopeEntity[] Array of \League\OAuth2\Server\Entity\ScopeEntity
*/ */
public function getScopes(AccessTokenEntity $token); public function getScopes(AccessTokenEntity $token);

4
src/Storage/AuthCodeInterface.php
View File

@ -24,7 +24,7 @@ interface AuthCodeInterface extends StorageInterface
* *
* @param string $code * @param string $code
* *
* @return \League\OAuth2\Server\Entity\AuthCodeEntity * @return \League\OAuth2\Server\Entity\AuthCodeEntity | null
*/ */
public function get($code); public function get($code);
@ -45,7 +45,7 @@ interface AuthCodeInterface extends StorageInterface
* *
* @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 * @return \League\OAuth2\Server\Entity\ScopeEntity[] Array of \League\OAuth2\Server\Entity\ScopeEntity
*/ */
public function getScopes(AuthCodeEntity $token); public function getScopes(AuthCodeEntity $token);

4
src/Storage/ClientInterface.php
View File

@ -26,7 +26,7 @@ interface ClientInterface extends StorageInterface
* @param string $redirectUri The client's redirect URI (default = "null") * @param string $redirectUri The client's redirect URI (default = "null")
* @param string $grantType The grant type used (default = "null") * @param string $grantType The grant type used (default = "null")
* *
* @return \League\OAuth2\Server\Entity\ClientEntity * @return \League\OAuth2\Server\Entity\ClientEntity | null
*/ */
public function get($clientId, $clientSecret = null, $redirectUri = null, $grantType = null); public function get($clientId, $clientSecret = null, $redirectUri = null, $grantType = null);
@ -35,7 +35,7 @@ interface ClientInterface extends StorageInterface
* *
* @param \League\OAuth2\Server\Entity\SessionEntity $session The session * @param \League\OAuth2\Server\Entity\SessionEntity $session The session
* *
* @return \League\OAuth2\Server\Entity\ClientEntity * @return \League\OAuth2\Server\Entity\ClientEntity | null
*/ */
public function getBySession(SessionEntity $session); public function getBySession(SessionEntity $session);
} }

2
src/Storage/RefreshTokenInterface.php
View File

@ -23,7 +23,7 @@ interface RefreshTokenInterface extends StorageInterface
* *
* @param string $token * @param string $token
* *
* @return \League\OAuth2\Server\Entity\RefreshTokenEntity * @return \League\OAuth2\Server\Entity\RefreshTokenEntity | null
*/ */
public function get($token); public function get($token);

2
src/Storage/ScopeInterface.php
View File

@ -23,7 +23,7 @@ interface ScopeInterface extends StorageInterface
* @param string $grantType The grant type used in the request (default = "null") * @param string $grantType The grant type used in the request (default = "null")
* @param string $clientId The client sending the request (default = "null") * @param string $clientId The client sending the request (default = "null")
* *
* @return \League\OAuth2\Server\Entity\ScopeEntity * @return \League\OAuth2\Server\Entity\ScopeEntity | null
*/ */
public function get($scope, $grantType = null, $clientId = null); public function get($scope, $grantType = null, $clientId = null);
} }

6
src/Storage/SessionInterface.php
View File

@ -26,7 +26,7 @@ interface SessionInterface extends StorageInterface
* *
* @param \League\OAuth2\Server\Entity\AccessTokenEntity $accessToken The access token * @param \League\OAuth2\Server\Entity\AccessTokenEntity $accessToken The access token
* *
* @return \League\OAuth2\Server\Entity\SessionEntity * @return \League\OAuth2\Server\Entity\SessionEntity | null
*/ */
public function getByAccessToken(AccessTokenEntity $accessToken); public function getByAccessToken(AccessTokenEntity $accessToken);
@ -35,7 +35,7 @@ interface SessionInterface extends StorageInterface
* *
* @param \League\OAuth2\Server\Entity\AuthCodeEntity $authCode The auth code * @param \League\OAuth2\Server\Entity\AuthCodeEntity $authCode The auth code
* *
* @return \League\OAuth2\Server\Entity\SessionEntity * @return \League\OAuth2\Server\Entity\SessionEntity | null
*/ */
public function getByAuthCode(AuthCodeEntity $authCode); public function getByAuthCode(AuthCodeEntity $authCode);
@ -44,7 +44,7 @@ interface SessionInterface extends StorageInterface
* *
* @param \League\OAuth2\Server\Entity\SessionEntity * @param \League\OAuth2\Server\Entity\SessionEntity
* *
* @return array Array of \League\OAuth2\Server\Entity\ScopeEntity * @return \League\OAuth2\Server\Entity\ScopeEntity[] Array of \League\OAuth2\Server\Entity\ScopeEntity
*/ */
public function getScopes(SessionEntity $session); public function getScopes(SessionEntity $session);