1. interface
  2. Couchbase
  3. \
  4. LookupInResult

LookupInResult

interface LookupInResult implements Result (View source)

Interface for results created by the lookupIn operation.

Methods

string|null
cas()

Returns the CAS value for the document

from  Result
object|null
content(int $index)

Returns the value located at the index specified

bool
exists(int $index)

Returns whether or not the path at the index specified exists

int
status(int $index)

Returns any error code for the path at the index specified

DateTimeInterface|null
expiryTime()

Returns the document expiration time or null if the document does not expire.

Details

in Result at line 247
string|null cas()

Returns the CAS value for the document

Return Value

string|null

at line 342
object|null content(int $index)

Returns the value located at the index specified

Parameters

int $index

the index to retrieve content from

Return Value

object|null

at line 350
bool exists(int $index)

Returns whether or not the path at the index specified exists

Parameters

int $index

the index to check for existence

Return Value

bool

at line 358
int status(int $index)

Returns any error code for the path at the index specified

Parameters

int $index

the index to retrieve the error code for

Return Value

int

at line 367
DateTimeInterface|null expiryTime()

Returns the document expiration time or null if the document does not expire.

Note, that this function will return expiry only when LookupInOptions had withExpiry set to true.

Return Value

DateTimeInterface|null