Documentation

DecrementOptions

Table of Contents

delta()  : DecrementOptions
Sets the value to decrement 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.

Methods

durabilityLevel()

Sets the durability level to enforce when writing the document.

public durabilityLevel(int $arg) : DecrementOptions
Parameters
$arg : int

the durability level to enforce

Return values
DecrementOptions

expiry()

Sets the expiry time for the document.

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

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

Return values
DecrementOptions

initial()

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

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

the initial value to use if counter does not exist

Return values
DecrementOptions

Search results