Documentation

DecrementOptions
in package

Table of Contents

$delta  : int
$durabilityLevel  : string|null
$expirySeconds  : int|null
$expiryTimestamp  : int|null
$initialValue  : int|null
$timeoutMilliseconds  : int|null
build()  : DecrementOptions
Static helper to keep code more readable
delta()  : DecrementOptions
Sets the value to increment the counter by.
durabilityLevel()  : DecrementOptions
Sets the durability level to enforce when writing the document.
expiry()  : DecrementOptions
Sets the expiry time for the document.
initial()  : DecrementOptions
Sets the value to initialize the counter to if the document does not exist.
timeout()  : DecrementOptions
Sets the operation timeout in milliseconds.

Properties

Methods

expiry()

Sets the expiry time for the document.

public expiry(int|DateTimeInterface $seconds) : DecrementOptions
Parameters
$seconds : int|DateTimeInterface

the relative expiry time in seconds or DateTimeInterface object for absolute point in time

Tags
since
4.1.5
Return values
DecrementOptions

initial()

Sets the value to initialize the counter to if the document does not exist.

public initial(int $initialValue) : DecrementOptions
Parameters
$initialValue : int

the initial value to use if counter does not exist

Tags
since
4.0.0
Return values
DecrementOptions

        

Search results