SearchResult
in package
implements
JsonSerializable
FinalYes
Tags
Table of Contents
Interfaces
- JsonSerializable
Properties
- $cursor : int|string|null
- $entries : array<string|int, SearchResultEntry>
- $isPaginated : bool
- $name : string
Methods
- complete() : static
- jsonSerialize() : array<string|int, mixed>
- paginated() : static
- __construct() : mixed
Properties
$cursor
private
int|string|null
$cursor
$entries
private
array<string|int, SearchResultEntry>
$entries
$isPaginated
private
bool
$isPaginated
$name
private
string
$name
Methods
complete()
public
static complete(string $name, array<string|int, SearchResultEntry> $entries) : static
Parameters
- $name : string
- $entries : array<string|int, SearchResultEntry>
Tags
Return values
staticjsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>paginated()
public
static paginated(string $name, array<string|int, SearchResultEntry> $entries, int|string $cursor) : static
Parameters
- $name : string
- $entries : array<string|int, SearchResultEntry>
- $cursor : int|string
Tags
Return values
static__construct()
private
__construct(string $name, bool $isPaginated, array<string|int, SearchResultEntry> $entries[, int|null|string|null $cursor = null ]) : mixed
Parameters
- $name : string
-
the translated name of the result section or group, e.g. "Mail"
- $isPaginated : bool
- $entries : array<string|int, SearchResultEntry>
- $cursor : int|null|string|null = null