class EntryQueryOptions

Properties

string|null $batchId

The batch ID that entries should belong to.

string|null $tag

The tag that must belong to retrieved entries.

string|null $familyHash

The family hash that must belong to retrieved entries.

mixed $beforeSequence

The ID that all retrieved entries should be less than.

mixed $uuids

The list of UUIDs of entries tor retrieve.

int $limit

The number of entries to retrieve.

Methods

fromRequest(Request $request)

Create new entry query options from the incoming request.

forBatchId(string|null $batchId)

Create new entry query options for the given batch ID.

batchId(string|null $batchId)

Set the batch ID for the query.

uuids(array|null $uuids)

Set the list of UUIDs of entries tor retrieve.

beforeSequence(mixed $id)

Set the ID that all retrieved entries should be less than.

tag(string|null $tag)

Set the tag that must belong to retrieved entries.

familyHash(string|null $familyHash)

Set the family hash that must belong to retrieved entries.

limit(int $limit)

Set the number of entries that should be retrieved.

Details

at line 44
static EntryQueryOptions fromRequest(Request $request)

Create new entry query options from the incoming request.

Parameters

Request $request

Return Value

EntryQueryOptions

at line 58
static EntryQueryOptions forBatchId(string|null $batchId)

Create new entry query options for the given batch ID.

Parameters

string|null $batchId

Return Value

EntryQueryOptions

at line 66
EntryQueryOptions batchId(string|null $batchId)

Set the batch ID for the query.

Parameters

string|null $batchId

Return Value

EntryQueryOptions

at line 76
EntryQueryOptions uuids(array|null $uuids)

Set the list of UUIDs of entries tor retrieve.

Parameters

array|null $uuids

Return Value

EntryQueryOptions

at line 86
EntryQueryOptions beforeSequence(mixed $id)

Set the ID that all retrieved entries should be less than.

Parameters

mixed $id

Return Value

EntryQueryOptions

at line 96
EntryQueryOptions tag(string|null $tag)

Set the tag that must belong to retrieved entries.

Parameters

string|null $tag

Return Value

EntryQueryOptions

at line 106
EntryQueryOptions familyHash(string|null $familyHash)

Set the family hash that must belong to retrieved entries.

Parameters

string|null $familyHash

Return Value

EntryQueryOptions

at line 116
EntryQueryOptions limit(int $limit)

Set the number of entries that should be retrieved.

Parameters

int $limit

Return Value

EntryQueryOptions