ApiClientAuthentication
in package
FinalYes
Result of verifying an application key: the status and, for a valid key, the client identity.
For a disabled, revoked or expired key it carries only the client and key ids (for the auth log) and no identity, because such a client must not be allowed to do anything.
Table of Contents
Properties
- $clientId : int|null
- $identity : ApiClientIdentity|null
- $keyId : int|null
- $status : ApiClientKeyStatus
Methods
- isValid() : bool
- refused() : self
- valid() : self
- __construct() : mixed
Properties
$clientId read-only
public
int|null
$clientId
= null
$identity read-only
public
ApiClientIdentity|null
$identity
= null
$keyId read-only
public
int|null
$keyId
= null
$status read-only
public
ApiClientKeyStatus
$status
Methods
isValid()
public
isValid() : bool
Return values
boolrefused()
public
static refused(ApiClientKeyStatus $status[, int|null $clientId = null ][, int|null $keyId = null ]) : self
Parameters
- $status : ApiClientKeyStatus
- $clientId : int|null = null
- $keyId : int|null = null
Return values
selfvalid()
public
static valid(ApiClientIdentity $identity) : self
Parameters
- $identity : ApiClientIdentity
Return values
self__construct()
private
__construct(ApiClientKeyStatus $status[, ApiClientIdentity|null $identity = null ][, int|null $clientId = null ][, int|null $keyId = null ]) : mixed
Parameters
- $status : ApiClientKeyStatus
- $identity : ApiClientIdentity|null = null
- $clientId : int|null = null
- $keyId : int|null = null