Applied fixes from StyleCI

This commit is contained in:
Alex Bilbie
2016-02-19 18:09:39 -05:00
committed by StyleCI Bot
parent 60c45ab8fe
commit a2460886f6
57 changed files with 346 additions and 330 deletions

View File

@@ -1,4 +1,5 @@
<?php
namespace League\OAuth2\Server\Entities;
use League\OAuth2\Server\Entities\Interfaces\AccessTokenEntityInterface;

View File

@@ -1,4 +1,5 @@
<?php
namespace League\OAuth2\Server\Entities;
use League\OAuth2\Server\Entities\Interfaces\AuthCodeEntityInterface;
@@ -6,8 +7,7 @@ use League\OAuth2\Server\Entities\Traits\EntityTrait;
use League\OAuth2\Server\Entities\Traits\TokenEntityTrait;
/**
* Class AuthCodeEntity
* @package League\OAuth2\Server
* Class AuthCodeEntity.
*/
class AuthCodeEntity implements AuthCodeEntityInterface
{

View File

@@ -1,4 +1,5 @@
<?php
namespace League\OAuth2\Server\Entities;
use League\OAuth2\Server\Entities\Interfaces\ClientEntityInterface;
@@ -6,8 +7,7 @@ use League\OAuth2\Server\Entities\Traits\ClientEntityTrait;
use League\OAuth2\Server\Entities\Traits\EntityTrait;
/**
* Class ClientEntity
* @package League\OAuth2\Server
* Class ClientEntity.
*/
class ClientEntity implements ClientEntityInterface
{

View File

@@ -1,7 +1,7 @@
<?php
namespace League\OAuth2\Server\Entities\Interfaces;
interface AccessTokenEntityInterface extends TokenInterface
{
}

View File

@@ -1,29 +1,32 @@
<?php
namespace League\OAuth2\Server\Entities\Interfaces;
interface ClientEntityInterface
{
/**
* Get the client's identifier
* Get the client's identifier.
*
* @return string
*/
public function getIdentifier();
/**
* Set the client's identifier
* Set the client's identifier.
*
* @param $identifier
*/
public function setIdentifier($identifier);
/**
* Get the client's name
* Get the client's name.
*
* @return string
*/
public function getName();
/**
* Set the client's name
* Set the client's name.
*
* @param string $name
*/
@@ -35,31 +38,32 @@ interface ClientEntityInterface
public function setSecret($secret);
/**
* Validate the secret provided by the client
* Validate the secret provided by the client.
*
* @param string $submittedSecret
*
* @return boolean
* @return bool
*/
public function validateSecret($submittedSecret);
/**
* Set the client's redirect uri
* Set the client's redirect uri.
*
* @param string $redirectUri
*/
public function setRedirectUri($redirectUri);
/**
* Returns the registered redirect URI
* Returns the registered redirect URI.
*
* @return string
*/
public function getRedirectUri();
/**
* Returns true if the client is capable of keeping it's secrets secret
* @return boolean
* Returns true if the client is capable of keeping it's secrets secret.
*
* @return bool
*/
public function canKeepASecret();
}

View File

@@ -1,47 +1,54 @@
<?php
namespace League\OAuth2\Server\Entities\Interfaces;
interface RefreshTokenEntityInterface
{
/**
* Get the token's identifier
* Get the token's identifier.
*
* @return string
*/
public function getIdentifier();
/**
* Set the token's identifier
* Set the token's identifier.
*
* @param $identifier
*/
public function setIdentifier($identifier);
/**
* Get the token's expiry date time
* Get the token's expiry date time.
*
* @return \DateTime
*/
public function getExpiryDateTime();
/**
* Set the date time when the token expires
* Set the date time when the token expires.
*
* @param \DateTime $dateTime
*/
public function setExpiryDateTime(\DateTime $dateTime);
/**
* Set the access token that the refresh token was associated with
* Set the access token that the refresh token was associated with.
*
* @param \League\OAuth2\Server\Entities\Interfaces\AccessTokenEntityInterface $accessToken
*/
public function setAccessToken(AccessTokenEntityInterface $accessToken);
/**
* Get the access token that the refresh token was originally associated with
* Get the access token that the refresh token was originally associated with.
*
* @return \League\OAuth2\Server\Entities\Interfaces\AccessTokenEntityInterface
*/
public function getAccessToken();
/**
* Has the token expired?
*
* @return bool
*/
public function isExpired();

View File

@@ -1,16 +1,19 @@
<?php
namespace League\OAuth2\Server\Entities\Interfaces;
interface ScopeEntityInterface extends \JsonSerializable
{
/**
* Get the scope's identifier
* Get the scope's identifier.
*
* @return string
*/
public function getIdentifier();
/**
* Set the scope's identifier
* Set the scope's identifier.
*
* @param $identifier
*/
public function setIdentifier($identifier);

View File

@@ -1,78 +1,91 @@
<?php
namespace League\OAuth2\Server\Entities\Interfaces;
interface TokenInterface
{
/**
* Get the token's identifier
* Get the token's identifier.
*
* @return string
*/
public function getIdentifier();
/**
* Set the token's identifier
* Set the token's identifier.
*
* @param $identifier
*/
public function setIdentifier($identifier);
/**
* Get the token's expiry date time
* Get the token's expiry date time.
*
* @return \DateTime
*/
public function getExpiryDateTime();
/**
* Set the date time when the token expires
* Set the date time when the token expires.
*
* @param \DateTime $dateTime
*/
public function setExpiryDateTime(\DateTime $dateTime);
/**
* Set the identifier of the user associated with the token
* Set the identifier of the user associated with the token.
*
* @param string|int $identifier The identifier of the user
*/
public function setUserIdentifier($identifier);
/**
* Get the token user's identifier
* Get the token user's identifier.
*
* @return string|int
*/
public function getUserIdentifier();
/**
* Get the client that the token was issued to
* Get the client that the token was issued to.
*
* @return ClientEntityInterface
*/
public function getClient();
/**
* Set the client that the token was issued to
* Set the client that the token was issued to.
*
* @param \League\OAuth2\Server\Entities\Interfaces\ClientEntityInterface $client
*/
public function setClient(ClientEntityInterface $client);
/**
* Associate a scope with the token
* Associate a scope with the token.
*
* @param \League\OAuth2\Server\Entities\Interfaces\ScopeEntityInterface $scope
*/
public function addScope(ScopeEntityInterface $scope);
/**
* Get an associated scope by the scope's identifier
* Get an associated scope by the scope's identifier.
*
* @param string $identifier
* @return ScopeEntityInterface|null The scope or null if not found
*
* @return ScopeEntityInterface|null The scope or null if not found
*/
public function getScopeWithIdentifier($identifier);
/**
* Return an array of scopes associated with the token
* Return an array of scopes associated with the token.
*
* @return ScopeEntityInterface[]
*/
public function getScopes();
/**
* Has the token expired?
*
* @return bool
*/
public function isExpired();

View File

@@ -5,7 +5,8 @@ namespace League\OAuth2\Server\Entities\Interfaces;
interface UserEntityInterface
{
/**
* Return the user's identifier
* Return the user's identifier.
*
* @return mixed
*/
public function getIdentifier();

View File

@@ -1,4 +1,5 @@
<?php
namespace League\OAuth2\Server\Entities;
use League\OAuth2\Server\Entities\Interfaces\RefreshTokenEntityInterface;
@@ -6,8 +7,7 @@ use League\OAuth2\Server\Entities\Traits\EntityTrait;
use League\OAuth2\Server\Entities\Traits\RefreshTokenTrait;
/**
* Class RefreshTokenEntity
* @package League\OAuth2\Server
* Class RefreshTokenEntity.
*/
class RefreshTokenEntity implements RefreshTokenEntityInterface
{

View File

@@ -1,19 +1,19 @@
<?php
namespace League\OAuth2\Server\Entities;
use League\OAuth2\Server\Entities\Interfaces\ScopeEntityInterface;
use League\OAuth2\Server\Entities\Traits\EntityTrait;
/**
* Class ScopeEntity
* @package League\OAuth2\Server
* Class ScopeEntity.
*/
class ScopeEntity implements ScopeEntityInterface
{
use EntityTrait;
/**
* @inheritdoc
* {@inheritdoc}
*/
public function jsonSerialize()
{

View File

@@ -1,4 +1,5 @@
<?php
namespace League\OAuth2\Server\Entities\Traits;
trait ClientEntityTrait
@@ -19,7 +20,7 @@ trait ClientEntityTrait
protected $redirectUri;
/**
* @inheritdoc
* {@inheritdoc}
*/
public function getName()
{
@@ -27,7 +28,7 @@ trait ClientEntityTrait
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function setName($name)
{
@@ -35,7 +36,7 @@ trait ClientEntityTrait
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function canKeepASecret()
{
@@ -43,7 +44,7 @@ trait ClientEntityTrait
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function setSecret($secret)
{
@@ -51,7 +52,7 @@ trait ClientEntityTrait
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function validateSecret($submittedSecret)
{
@@ -59,7 +60,7 @@ trait ClientEntityTrait
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function setRedirectUri($redirectUri)
{
@@ -67,7 +68,7 @@ trait ClientEntityTrait
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function getRedirectUri()
{

View File

@@ -1,4 +1,5 @@
<?php
namespace League\OAuth2\Server\Entities\Traits;
trait EntityTrait

View File

@@ -1,4 +1,5 @@
<?php
namespace League\OAuth2\Server\Entities\Traits;
use DateTime;
@@ -17,7 +18,7 @@ trait RefreshTokenTrait
protected $expiryDateTime;
/**
* @inheritdoc
* {@inheritdoc}
*/
public function setAccessToken(AccessTokenEntityInterface $accessToken)
{
@@ -25,7 +26,7 @@ trait RefreshTokenTrait
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function getAccessToken()
{
@@ -33,7 +34,8 @@ trait RefreshTokenTrait
}
/**
* Get the token's expiry date time
* Get the token's expiry date time.
*
* @return DateTime
*/
public function getExpiryDateTime()
@@ -42,7 +44,7 @@ trait RefreshTokenTrait
}
/**
* Set the date time when the token expires
* Set the date time when the token expires.
*
* @param DateTime $dateTime
*/
@@ -53,6 +55,7 @@ trait RefreshTokenTrait
/**
* Has the token expired?
*
* @return bool
*/
public function isExpired()

View File

@@ -1,4 +1,5 @@
<?php
namespace League\OAuth2\Server\Entities\Traits;
use DateTime;
@@ -28,7 +29,7 @@ trait TokenEntityTrait
protected $client;
/**
* Associate a scope with the token
* Associate a scope with the token.
*
* @param \League\OAuth2\Server\Entities\Interfaces\ScopeEntityInterface $scope
*/
@@ -38,11 +39,11 @@ trait TokenEntityTrait
}
/**
* Get an associated scope by the scope's identifier
* Get an associated scope by the scope's identifier.
*
* @param string $identifier
*
* @return ScopeEntityInterface|null The scope or null if not found
* @return ScopeEntityInterface|null The scope or null if not found
*/
public function getScopeWithIdentifier($identifier)
{
@@ -50,7 +51,8 @@ trait TokenEntityTrait
}
/**
* Return an array of scopes associated with the token
* Return an array of scopes associated with the token.
*
* @return ScopeEntityInterface[]
*/
public function getScopes()
@@ -59,7 +61,8 @@ trait TokenEntityTrait
}
/**
* Get the token's expiry date time
* Get the token's expiry date time.
*
* @return DateTime
*/
public function getExpiryDateTime()
@@ -68,7 +71,7 @@ trait TokenEntityTrait
}
/**
* Set the date time when the token expires
* Set the date time when the token expires.
*
* @param DateTime $dateTime
*/
@@ -78,7 +81,7 @@ trait TokenEntityTrait
}
/**
* Set the identifier of the user associated with the token
* Set the identifier of the user associated with the token.
*
* @param string|int $identifier The identifier of the user
*/
@@ -88,7 +91,8 @@ trait TokenEntityTrait
}
/**
* Get the token user's identifier
* Get the token user's identifier.
*
* @return string|int
*/
public function getUserIdentifier()
@@ -97,7 +101,8 @@ trait TokenEntityTrait
}
/**
* Get the client that the token was issued to
* Get the client that the token was issued to.
*
* @return ClientEntityInterface
*/
public function getClient()
@@ -106,7 +111,7 @@ trait TokenEntityTrait
}
/**
* Set the client that the token was issued to
* Set the client that the token was issued to.
*
* @param \League\OAuth2\Server\Entities\Interfaces\ClientEntityInterface $client
*/
@@ -117,6 +122,7 @@ trait TokenEntityTrait
/**
* Has the token expired?
*
* @return bool
*/
public function isExpired()