Documentation

ClientListResponse implements ArrayCopyable, Arrayable, Jsonable Uses ArrayTrait, JsonTrait

Response from Authlete's /api/client/get/list 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.
getClients()  : array<string|int, Client>
Get the list of client applications that match the query conditions.
getDeveloper()  : string
Get the unique identifier of the developer.
getEnd()  : int
Get the end index (exclusive) for the result set of the query.
getStart()  : int
Get the start index (inclusive) for the result set of the query.
getTotalCount()  : int
Get the total count of client applications of either the entire service (in the case of developer=null) or the developer.
setClients()  : ClientListResponse
Set the list of client applications that match the query conditions.
setDeveloper()  : ClientListResponse
Set the unique identifier of the developer.
setEnd()  : ClientListResponse
Set the end index (exclusive) for the result set of the query.
setStart()  : ClientListResponse
Set the start index (inclusive) for the result set of the query.
setTotalCount()  : ClientListResponse
Set the total count of client applications of either the entire service (in the case of developer=null) or the developer.
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.

getClients()

Get the list of client applications that match the query conditions.

public getClients() : array<string|int, Client>
Return values
array<string|int, Client> —

The list of client applications that match the query conditions.

getDeveloper()

Get the unique identifier of the developer.

public getDeveloper() : string

It is the value contained in the original request (= the value of the developer request parameter), or null. In the case of null, it means that all the clients that belong to the service are targeted.

Return values
string —

The unique identifier of the developer.

getEnd()

Get the end index (exclusive) for the result set of the query.

public getEnd() : int

It is the value contained in the original request (= the value of the end request parameter), or the defaul value defined in the Authlete server if the original request did not contain the parameter.

Return values
int —

The end index (exclusive).

getStart()

Get the start index (inclusive) for the result set of the query.

public getStart() : int

It is the value contained in the original request (= the value of the start request parameter), or the default value (0) if the original request did not contain the parameter.

Return values
int —

The start index (inclusive).

getTotalCount()

Get the total count of client applications of either the entire service (in the case of developer=null) or the developer.

public getTotalCount() : int

The number this method returns is not the size of the array returned from getClients() method. Instead, it is the total number of the client applications (of either the entire service or the developer) which exist in Authlete's database.

Return values
int —

The total number of client applications of either the entire service or the developer.

setClients()

Set the list of client applications that match the query conditions.

public setClients([array<string|int, Client> $clients = null ]) : ClientListResponse
Parameters
$clients : array<string|int, Client> = null

The list of client applications that match the query conditions.

Return values
ClientListResponse —

$this object.

setTotalCount()

Set the total count of client applications of either the entire service (in the case of developer=null) or the developer.

public setTotalCount(int $totalCount) : ClientListResponse
Parameters
$totalCount : int

The total number of client applications of either the entire service or the developer.

Return values
ClientListResponse —

$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