LookupInOptions
in package
Table of Contents
- $timeoutMilliseconds : int|null
- $transcoder : Transcoder
- $withExpiry : bool|null
- __construct() : mixed
- build() : LookupInOptions
- Static helper to keep code more readable
- getTranscoder() : Transcoder
- Returns associated transcoder.
- timeout() : LookupInOptions
- Sets the operation timeout in milliseconds.
- transcoder() : LookupInOptions
- Associate custom transcoder with the request.
- withExpiry() : LookupInOptions
- Sets whether to include document expiry with the document content.
Properties
$timeoutMilliseconds
private
int|null
$timeoutMilliseconds
= null
$transcoder
private
Transcoder
$transcoder
$withExpiry
private
bool|null
$withExpiry
= null
Methods
__construct()
public
__construct() : mixed
Tags
Return values
mixed —build()
Static helper to keep code more readable
public
static build() : LookupInOptions
Tags
Return values
LookupInOptions —getTranscoder()
Returns associated transcoder.
public
static getTranscoder(LookupInOptions|null $options) : Transcoder
Parameters
- $options : LookupInOptions|null
Tags
Return values
Transcoder —timeout()
Sets the operation timeout in milliseconds.
public
timeout(int $milliseconds) : LookupInOptions
Parameters
- $milliseconds : int
-
the operation timeout to apply
Tags
Return values
LookupInOptions —transcoder()
Associate custom transcoder with the request.
public
transcoder(Transcoder $transcoder) : LookupInOptions
Parameters
- $transcoder : Transcoder
Tags
Return values
LookupInOptions —withExpiry()
Sets whether to include document expiry with the document content.
public
withExpiry(bool $fetchExpiry) : LookupInOptions
When used this option will add one extra subdocument path into the LookupIn operation. This can cause the set of subdocument paths to exceed the maximum number (16) of paths allowed in a subdocument operation.
Parameters
- $fetchExpiry : bool
-
whether to include document expiry