ScanResult
extends Result
in package
Interface for results created by the scan operation.
Table of Contents
- $cas : string|null
- $error : CouchbaseException|null
- $expiry : int|null
- $flags : int|null
- $id : string
- $idsOnly : bool
- $transcoder : Transcoder
- $value : string|null
- 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)
- expiryTime() : DateTimeInterface|null
- Returns the document expiration time or null if the document does not expire.
- id() : string
- Returns the ID of the document
- idsOnly() : bool
- Returns whether only ids are returned from the scan operation
Properties
$cas
private
string|null
$cas
= null
$error
private
CouchbaseException|null
$error
= null
$expiry
private
int|null
$expiry
= null
$flags
private
int|null
$flags
= null
$id
private
string
$id
$idsOnly
private
bool
$idsOnly
$transcoder
private
Transcoder
$transcoder
$value
private
string|null
$value
= null
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 —expiryTime()
Returns the document expiration time or null if the document does not expire.
public
expiryTime() : DateTimeInterface|null
Tags
Return values
DateTimeInterface|null —id()
Returns the ID of the document
public
id() : string
Tags
Return values
string —idsOnly()
Returns whether only ids are returned from the scan operation
public
idsOnly() : bool