Documentation

LookupInResult extends Result

Interface for results created by the lookupIn operation.

Table of Contents

content() Returns the value located at the index specified object|null
exists() Returns whether or not the path at the index specified exists bool
status() Returns any error code for the path at the index specified int
cas() Returns the CAS value for the document string|null

Methods

content()

Returns the value located at the index specified

public content( $index : int ) : 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( $index : int ) : bool
Parameters
$index : int

the index to check for existence

Return values
bool

status()

Returns any error code for the path at the index specified

public status( $index : int ) : int
Parameters
$index : int

the index to retrieve the error code for

Return values
int

cas()

Returns the CAS value for the document

public cas( ) : string|null
Return values
string|null

Search results