GetReplicaResult
extends Result
in package
Interface for results created by the getReplica operation.
Table of Contents
- $cas : string|null
- $error : CouchbaseException|null
- $flags : int
- $id : string
- $isReplica : bool
- $transcoder : Transcoder
- $value : string
- cas() : string|null
- Returns the CAS value for the document
- content() : mixed
- Returns the content of the document decoded using associated transcoder
- contentAs() : mixed
- Returns the content of the document decoded using custom transcoder
- error() : CouchbaseException|null
- Returns the error (populated for multi-operations)
- id() : string
- Returns the ID of the document
- isReplica() : bool
- Returns whether the document came from a replica server
Properties
$cas
private
string|null
$cas
= null
$error
private
CouchbaseException|null
$error
= null
$flags
private
int
$flags
$id
private
string
$id
$isReplica
private
bool
$isReplica
$transcoder
private
Transcoder
$transcoder
$value
private
string
$value
Methods
cas()
Returns the CAS value for the document
public
cas() : string|null
Tags
Return values
string|null —content()
Returns the content of the document decoded using associated transcoder
public
content() : mixed
Tags
Return values
mixed —contentAs()
Returns the content of the document decoded using custom transcoder
public
contentAs(Transcoder $transcoder[, int|null $overrideFlags = null ]) : mixed
Parameters
- $transcoder : Transcoder
- $overrideFlags : int|null = null
Tags
Return values
mixed —error()
Returns the error (populated for multi-operations)
public
error() : CouchbaseException|null
Tags
Return values
CouchbaseException|null —id()
Returns the ID of the document
public
id() : string
Tags
Return values
string —isReplica()
Returns whether the document came from a replica server
public
isReplica() : bool