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