MutateInOptions
in package
Table of Contents
- $cas : string|null
- $durabilityLevel : string|null
- $expirySeconds : int|null
- $expiryTimestamp : int|null
- $parentSpan : RequestSpan|null
- $preserveExpiry : bool|null
- $storeSemantics : string
- $timeoutMilliseconds : int|null
- $transcoder : Transcoder
- __construct() : mixed
- build() : MutateInOptions
- Static helper to keep code more readable
- cas() : MutateInOptions
- Sets the cas value to use when performing this operation.
- durabilityLevel() : MutateInOptions
- Sets the durability level to enforce when writing the document.
- encodeValue() : string
- Delegates encoding of the value to associated transcoder
- expiry() : MutateInOptions
- Sets the expiry time for the document.
- parentSpan() : MutateInOptions
- Sets the parent span.
- preserveExpiry() : MutateInOptions
- Sets whether the original expiration should be preserved (by default Replace operation updates expiration).
- storeSemantics() : MutateInOptions
- Sets the document level action to use when performing the operation.
- timeout() : MutateInOptions
- Sets the operation timeout in milliseconds.
- transcoder() : MutateInOptions
- Associate custom transcoder with the request.
Properties
$cas
private
string|null
$cas
= null
$durabilityLevel
private
string|null
$durabilityLevel
= null
$expirySeconds
private
int|null
$expirySeconds
= null
$expiryTimestamp
private
int|null
$expiryTimestamp
= null
$parentSpan
private
RequestSpan|null
$parentSpan
= null
$preserveExpiry
private
bool|null
$preserveExpiry
= null
$storeSemantics
private
string
$storeSemantics
$timeoutMilliseconds
private
int|null
$timeoutMilliseconds
= null
$transcoder
private
Transcoder
$transcoder
Methods
__construct()
public
__construct() : mixed
Tags
Return values
mixed —build()
Static helper to keep code more readable
public
static build() : MutateInOptions
Tags
Return values
MutateInOptions —cas()
Sets the cas value to use when performing this operation.
public
cas(string $cas) : MutateInOptions
Parameters
- $cas : string
-
the CAS value to use
Tags
Return values
MutateInOptions —durabilityLevel()
Sets the durability level to enforce when writing the document.
public
durabilityLevel(string|int $level) : MutateInOptions
Parameters
- $level : string|int
-
the durability level to enforce
Tags
Return values
MutateInOptions —encodeValue()
Delegates encoding of the value to associated transcoder
public
static encodeValue(MutateInOptions|null $options, $document) : string
Parameters
- $options : MutateInOptions|null
- $document :
Tags
Return values
string —expiry()
Sets the expiry time for the document.
public
expiry(int|DateTimeInterface $seconds) : MutateInOptions
Parameters
- $seconds : int|DateTimeInterface
-
the relative expiry time in seconds or DateTimeInterface object for absolute point in time
Tags
Return values
MutateInOptions —parentSpan()
Sets the parent span.
public
parentSpan(RequestSpan $parentSpan) : MutateInOptions
Parameters
- $parentSpan : RequestSpan
-
the parent span
Tags
Return values
MutateInOptions —preserveExpiry()
Sets whether the original expiration should be preserved (by default Replace operation updates expiration).
public
preserveExpiry(bool $shouldPreserve) : MutateInOptions
Parameters
- $shouldPreserve : bool
-
if true, the expiration time will not be updated
Tags
Return values
MutateInOptions —storeSemantics()
Sets the document level action to use when performing the operation.
public
storeSemantics(int|string $semantics) : MutateInOptions
Parameters
- $semantics : int|string
-
the store semantic to use, int parameter is now @deprecated
Tags
Return values
MutateInOptions —timeout()
Sets the operation timeout in milliseconds.
public
timeout(int $milliseconds) : MutateInOptions
Parameters
- $milliseconds : int
-
the operation timeout to apply
Tags
Return values
MutateInOptions —transcoder()
Associate custom transcoder with the request.
public
transcoder(Transcoder $transcoder) : MutateInOptions
Parameters
- $transcoder : Transcoder