Documentation

ClientAuthorizationGetListRequest implements ArrayCopyable, Arrayable, Jsonable Uses ArrayTrait, JsonTrait

Request to Authlete's /api/client/authorization/get/list API.

The API returns a list of client applications to which an end-user has granted authorization.

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

__construct()  : mixed
Constructor.
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.
getDeveloper()  : string
Get the unique identifier of a developer.
getEnd()  : int
Get an end index of search results (exclusive).
getStart()  : int
Get a start index of search results (inclusive).
getSubject()  : string
Get the subject (= unique identifier) of the end-user who has granted authorization to the client application.
setDeveloper()  : ClientAuthorizationGetListRequest
Set the unique identifier of a developer.
setEnd()  : ClientAuthorizationGetListRequest
Set an end index of search results (exclusive).
setStart()  : ClientAuthorizationGetListRequest
Set a start index of search results (inclusive).
setSubject()  : ClientAuthorizationGetListRequest
Set the subject (= unique identifier) of the end-user who has granted authorization to the client application.
toArray()  : array<string|int, mixed>
Convert this object into an array.
toJson()  : string
Convert this object into a JSON string.

Methods

__construct()

Constructor.

public __construct([string $subject = null ][, string $developer = null ], int $start[, int $end = 5 ]) : mixed
Parameters
$subject : string = null

The subject (= unique identifier) of the end-user. This argument is optional. The default value is null. However, note that subject request parameter is mandatory for the Authlete API.

$developer : string = null

The unique identifier of a developer. This argument is optional. The default value is null.

$start : int

A start index of search results (inclusive). This argument is optional. The default value is 0.

$end : int = 5

An end index of search results (exclusive). This argument is optional. The default value is 5.

Return values
mixed —

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.

getDeveloper()

Get the unique identifier of a developer.

public getDeveloper() : string
Return values
string —

The unique identifier of a developer.

getEnd()

Get an end index of search results (exclusive).

public getEnd() : int
Return values
int —

An end index of search results (exclusive).

getStart()

Get a start index of search results (inclusive).

public getStart() : int
Return values
int —

A start index of search results (inclusive).

getSubject()

Get the subject (= unique identifier) of the end-user who has granted authorization to the client application.

public getSubject() : string
Return values
string —

The subject of the end-user.

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