TokenFailRequest implements ArrayCopyable, Arrayable, Jsonable Uses ArrayTrait, JsonTrait
Request to Authlete's /api/auth/token/fail API.
Interfaces, Classes and Traits
- ArrayCopyable
- Interface to declare instances can be converted into/from arrays.
- Arrayable
- Interface to declare that instances can be converted into an array.
- Jsonable
- Interface to declare that instances can be converted into JSON strings.
Table of Contents
- copyFromArray() : mixed
- Copy the content of the given array into this object.
- copyToArray() : mixed
- Copy the content of this object into the given array.
- fromArray() : static
- Convert an array into an instance of this class.
- fromJson() : static
- Convert a JSON string into an instance of this class.
- getReason() : TokenFailReason
- Get the reason of the failure of the token request.
- getTicket() : string
- Get the ticket issued from Authlete's /api/auth/token API.
- setReason() : TokenFailRequest
- Set the reason of the failure of the token request.
- setTicket() : TokenFailRequest
- Set the ticket issued from Authlete's /api/auth/token API.
- toArray() : array<string|int, mixed>
- Convert this object into an array.
- toJson() : string
- Convert this object into a JSON string.
Methods
copyFromArray()
Copy the content of the given array into this object.
public
copyFromArray(array<string|int, mixed> &$array) : mixed
Parameters
- $array : array<string|int, mixed>
Return values
mixed —copyToArray()
Copy the content of this object into the given array.
public
copyToArray(array<string|int, mixed> &$array) : mixed
Parameters
- $array : array<string|int, mixed>
Return values
mixed —fromArray()
Convert an array into an instance of this class.
public
static fromArray([array<string|int, mixed> $array = null ]) : static
This static function returns a new instance of this class.
If $array is null, null is returned.
Parameters
- $array : array<string|int, mixed> = null
-
An array
Return values
static —An instance of this class.
fromJson()
Convert a JSON string into an instance of this class.
public
static fromJson(string $json) : static
This static function returns a new instance of this class.
If $json is null or the type of $json is not string,
null is returned.
Parameters
- $json : string
-
A JSON string.
Return values
static —An instance of this class.
getReason()
Get the reason of the failure of the token request.
public
getReason() : TokenFailReason
Return values
TokenFailReason —The reason of the failure of the token request.
getTicket()
Get the ticket issued from Authlete's /api/auth/token API.
public
getTicket() : string
Return values
string —The ticket necessary to call /api/auth/token/fail API.
setReason()
Set the reason of the failure of the token request.
public
setReason([TokenFailReason $reason = null ]) : TokenFailRequest
Parameters
- $reason : TokenFailReason = null
-
The reason of the failure of the token request.
Return values
TokenFailRequest —$this object.
setTicket()
Set the ticket issued from Authlete's /api/auth/token API.
public
setTicket(string $ticket) : TokenFailRequest
This request parameter is mandatory.
Parameters
- $ticket : string
-
The ticket necessary to call /api/auth/token/fail API.
Return values
TokenFailRequest —$this object.
toArray()
Convert this object into an array.
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —An array.
toJson()
Convert this object into a JSON string.
public
toJson(int $options) : string
Parameters
- $options : int
-
Options passed to
json_encode(). This parameter is optional and its default value is 0.
Return values
string —A JSON string.