LookupInResult
extends
Result
in
Interface for results created by the lookupIn operation.
Table of Contents
- cas() : string|null
- Returns the CAS value for the document
- content() : object|null
- Returns the value located at the index specified
- exists() : bool
- Returns whether or not the path at the index specified exists
- expiryTime() : DateTimeInterface|null
- Returns the document expiration time or null if the document does not expire.
- status() : int
- Returns any error code for the path at the index specified
Methods
cas()
Returns the CAS value for the document
public
cas() : string|null
Return values
string|null —content()
Returns the value located at the index specified
public
content(int $index) : object|null
Parameters
- $index : int
-
the index to retrieve content from
Return values
object|null —exists()
Returns whether or not the path at the index specified exists
public
exists(int $index) : bool
Parameters
- $index : int
-
the index to check for existence
Return values
bool —expiryTime()
Returns the document expiration time or null if the document does not expire.
public
expiryTime() : DateTimeInterface|null
Note, that this function will return expiry only when LookupInOptions had withExpiry set to true.
Return values
DateTimeInterface|null —status()
Returns any error code for the path at the index specified
public
status(int $index) : int
Parameters
- $index : int
-
the index to retrieve the error code for