EntryQueryOptions
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. |
|
| bool | $exactTag | Whether the tag should be matched literally instead of as a search expression. |
|
| string|null | $familyHash | The family hash that must belong to retrieved entries. |
|
| int|string|null | $beforeSequence | The ID that all retrieved entries should be less than. |
|
| array|null | $uuids | The list of UUIDs of entries to retrieve. |
|
| int | $limit | The number of entries to retrieve. |
Methods
Create new entry query options for the given batch ID.
Set the batch ID for the query.
Set the list of UUIDs of entries to retrieve.
Set the ID that all retrieved entries should be less than.
Set the tag that must belong to retrieved entries.
Match the tag literally instead of as a search expression.
Set the family hash that must belong to retrieved entries.
Set the number of entries that should be retrieved.
Details
at line 49
static EntryQueryOptions
fromRequest(Request $request)
Create new entry query options from the incoming request.
at line 64
static EntryQueryOptions
forBatchId(string|null $batchId)
Create new entry query options for the given batch ID.
at line 74
EntryQueryOptions
batchId(string|null $batchId)
Set the batch ID for the query.
at line 86
EntryQueryOptions
uuids(array|null $uuids)
Set the list of UUIDs of entries to retrieve.
at line 98
EntryQueryOptions
beforeSequence(int|string|null $id)
Set the ID that all retrieved entries should be less than.
at line 110
EntryQueryOptions
tag(string|null $tag)
Set the tag that must belong to retrieved entries.
at line 122
EntryQueryOptions
exactTag(bool $exactTag = true)
Match the tag literally instead of as a search expression.
at line 134
EntryQueryOptions
familyHash(string|null $familyHash)
Set the family hash that must belong to retrieved entries.
at line 146
EntryQueryOptions
limit(int $limit)
Set the number of entries that should be retrieved.