Documentation

GetResult extends Result
in package

Interface for results created by the get operation.

Table of Contents

$cas  : string|null
$error  : CouchbaseException|null
$expiry  : int|null
$flags  : int
$id  : string
$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)
expiryTime()  : DateTimeInterface|null
Returns the document expiration time or null if the document does not expire.
id()  : string
Returns the ID of the document

Properties

$cas

private string|null $cas = null

Methods

cas()

Returns the CAS value for the document

public cas() : string|null
Tags
since
4.0.0
Return values
string|null

content()

Returns the content of the document decoded using associated transcoder

public content() : mixed
Tags
since
4.0.0
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
since
4.0.0
Return values
mixed

expiryTime()

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

public expiryTime() : DateTimeInterface|null

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

Tags
since
4.0.0
Return values
DateTimeInterface|null

id()

Returns the ID of the document

public id() : string
Tags
since
4.0.0
Return values
string

        

Search results