MutateInResult
extends MutationResult
in package
Results created by the mutateIn operation.
Table of Contents
- $cas : string|null
- $deleted : bool
- $error : CouchbaseException|null
- $fields : array<string|int, mixed>
- $id : string
- $mutationToken : MutationToken|null
- cas() : string|null
- Returns the CAS value for the document
- content() : mixed
- Returns any value located at the index specified
- contentByPath() : mixed
- error() : CouchbaseException|null
- Returns the error (populated for multi-operations)
- id() : string
- Returns the ID of the document
- isDeleted() : bool
- mutationToken() : MutationToken|null
- Returns the mutation token generated during the mutation
- path() : string|null
Properties
$cas
private
string|null
$cas
= null
$deleted
private
bool
$deleted
$error
private
CouchbaseException|null
$error
= null
$fields
private
array<string|int, mixed>
$fields
$id
private
string
$id
$mutationToken
private
MutationToken|null
$mutationToken
= null
Methods
cas()
Returns the CAS value for the document
public
cas() : string|null
Tags
Return values
string|null —content()
Returns any value located at the index specified
public
content(int $index) : mixed
Parameters
- $index : int
-
the index to retrieve content from
Tags
Return values
mixed —contentByPath()
public
contentByPath(string $path) : mixed
Parameters
- $path : string
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 —isDeleted()
public
isDeleted() : bool
Tags
Return values
bool —mutationToken()
Returns the mutation token generated during the mutation
public
mutationToken() : MutationToken|null
Tags
Return values
MutationToken|null —path()
public
path(int $index) : string|null
Parameters
- $index : int