Documentation

AuthorizationFailRequest implements ArrayCopyable, Arrayable, Jsonable Uses ArrayTrait, JsonTrait

Request to Authlete's /api/auth/authorization/fail API.

An authorization endpoint implementation is supposed to call the API to generate an error response to a client application.

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.
getDescription()  : string
Get the custom description about the authorization failure.
getReason()  : string
Get the reason of the failure of the authorization request.
getTicket()  : string
Get the ticket issued by Authlete's /api/auth/authorization API.
setDescription()  : AuthorizationFailRequest
Set the custom description about the authorization failure.
setReason()  : AuthorizationFailRequest
Set the reason of the failure of the authorization request.
setTicket()  : AuthorizationFailRequest
Set the ticket issued by Authlete's /api/auth/authorization 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.

getDescription()

Get the custom description about the authorization failure.

public getDescription() : string
Return values
string —

The custom description.

getReason()

Get the reason of the failure of the authorization request.

public getReason() : string
Return values
string —

The reason of the failure of the authorization request.

getTicket()

Get the ticket issued by Authlete's /api/auth/authorization API.

public getTicket() : string

The ticket is necessary to call Authlete's /api/auth/authorization/fail API.

Return values
string —

The ticket issued by Authlete's /api/auth/authorization API.

setTicket()

Set the ticket issued by Authlete's /api/auth/authorization API.

public setTicket(string $ticket) : AuthorizationFailRequest

This request parameter is mandatory.

The ticket is necessary to call Authlete's /api/auth/authorization/fail API.

Parameters
$ticket : string

The ticket issued by Authlete's /api/auth/authorization API.

Return values
AuthorizationFailRequest —

$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.

Search results