AuthorizationRequest implements ArrayCopyable, Arrayable, Jsonable Uses ArrayTrait, JsonTrait
Request to Authlete's /api/auth/authorization API.
An authorization endpoint implementation is supposed to pass all the request parameters it received from a client application to the 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.
- getParameters() : string
- Get the request parameters that the implementation of your authorization endpoint received from a client application.
- setParameters() : AuthorizationRequest
- Get the request parameters that the implementation of your authorization endpoint received from a client application.
- 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.
getParameters()
Get the request parameters that the implementation of your authorization endpoint received from a client application.
public
getParameters() : string
Return values
string —Request parameters in application/x-www-form-urlencoded format.
setParameters()
Get the request parameters that the implementation of your authorization endpoint received from a client application.
public
setParameters(string $parameters) : AuthorizationRequest
The value passed to this method should be either (1) the entire
query string when the HTTP method of the authorization request
from the client application was GET or (2) the entire entity
body (which is formatted in application/x-www-form-urlencoded)
when the HTTP method of the authorization request from the client
application was POST.
Parameters
- $parameters : string
-
Request parameters in
application/x-www-form-urlencodedformat.
Return values
AuthorizationRequest —$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.