class Client implements ClientEntityInterface (View source)

Constants

CONSENT_NONE

Disable the users ability to allow / deny consent for this client to access details.

This should only be used if a client is fully trusted and owned by this server

CONSENT_SIMPLE

Give the user the option to allow or deny access without changing scopes

Properties

protected $identifier
protected string $name
protected string|string[] $redirectUri
protected string $clientKey
protected string $clientSecret
protected int $consentType The type of consent this client must get from the user

Methods

getIdentifier()

{@inheritdoc}

setIdentifier(string $identifier)

Set the client's identifier.

getName()

{@inheritdoc}

setName(string $name)

Set the client's name.

string
getClientKey()

No description

setClientKey(string $clientKey)

No description

string
getClientSecret()

No description

setClientSecret(string $clientSecret)

No description

getRedirectUri()

{@inheritdoc}

setRedirectUri(string|string[] $redirectUri)

Set the registered redirect URI (as a string), or an indexed array of redirect URIs.

int
getConsentType()

Get the consent type required by this client

setConsentType(int $consentType)

Set the level of consent this client must receive from the authenticating user

Details

getIdentifier()

{@inheritdoc}

See also

\League\OAuth2\Server\Entities\ClientEntityInterface::getIdentifier()

setIdentifier(string $identifier)

Set the client's identifier.

Parameters

string $identifier

getName()

{@inheritdoc}

See also

\League\OAuth2\Server\Entities\ClientEntityInterface::getName()

setName(string $name)

Set the client's name.

Parameters

string $name

string getClientKey()

Return Value

string

setClientKey(string $clientKey)

Parameters

string $clientKey

string getClientSecret()

Return Value

string

setClientSecret(string $clientSecret)

Parameters

string $clientSecret

getRedirectUri()

{@inheritdoc}

See also

\League\OAuth2\Server\Entities\ClientEntityInterface::getRedirectUri()

setRedirectUri(string|string[] $redirectUri)

Set the registered redirect URI (as a string), or an indexed array of redirect URIs.

Parameters

string|string[] $redirectUri

int getConsentType()

Get the consent type required by this client

Return Value

int Client::CONSENT_SIMPLE | Client::CONSENT_NONE

setConsentType(int $consentType)

Set the level of consent this client must receive from the authenticating user

Parameters

int $consentType Client::CONSENT_SIMPLE | Client::CONSENT_NONE