Documentation

Collection
in package

Application

implements CollectionInterface

Interfaces, Classes, Traits and Enums

CollectionInterface

DEFAULT_NAME = "_default"
$bucketName : string
$client : Client
$name : string
$scopeName : string
__construct() : mixed
binary() : BinaryCollectionInterface
bucketName() : string
exists() : ExistsResult
get() : GetResult
getAllReplicas() : array<string|int, mixed>
getAndLock() : GetResult
getAndTouch() : GetResult
getAnyReplica() : GetReplicaResult
insert() : MutationResult
lookupIn() : LookupInResult
mutateIn() : MutateInResult
name() : string
queryIndexes() : CollectionQueryIndexManager
remove() : MutationResult
replace() : MutationResult
scopeName() : string
touch() : MutationResult
unlock() : Result
upsert() : MutationResult

DEFAULT_NAME


    public
        mixed
    DEFAULT_NAME
    = "_default"

$bucketName


    private
        string
    $bucketName

$client


    private
        Client
    $client

$name


    private
        string
    $name

$scopeName


    private
        string
    $scopeName

__construct()


    public
                __construct(Client $client, string $bucketName, string $scopeName, string $name) : mixed

Parameters

$client : Client
$bucketName : string
$scopeName : string
$name : string

Return values

mixed —

binary()


    public
                binary() : BinaryCollectionInterface

Return values

BinaryCollectionInterface —

bucketName()


    public
                bucketName() : string

Return values

string —

exists()


    public
                exists(string $key[, ExistsOptions $options = null ]) : ExistsResult

Parameters

$key : string
$options : ExistsOptions = null

Return values

ExistsResult —

get()


    public
                get(string $key[, GetOptions $options = null ]) : GetResult

Parameters

$key : string
$options : GetOptions = null

Return values

GetResult —

getAllReplicas()


    public
                getAllReplicas(string $key[, GetAllReplicasOptions $options = null ]) : array<string|int, mixed>

Parameters

$key : string
$options : GetAllReplicasOptions = null

Return values

array<string|int, mixed> —

getAndLock()


    public
                getAndLock(string $key, int $lockTimeSeconds[, GetAndLockOptions $options = null ]) : GetResult

Parameters

$key : string
$lockTimeSeconds : int
$options : GetAndLockOptions = null

Return values

GetResult —

getAndTouch()


    public
                getAndTouch(string $key, mixed $expiry[, GetAndTouchOptions $options = null ]) : GetResult

Parameters

$key : string
$expiry : mixed
$options : GetAndTouchOptions = null

Return values

GetResult —

getAnyReplica()


    public
                getAnyReplica(string $key[, GetAnyReplicaOptions $options = null ]) : GetReplicaResult

Parameters

$key : string
$options : GetAnyReplicaOptions = null

Return values

GetReplicaResult —

insert()


    public
                insert(string $key, mixed $document[, InsertOptions $options = null ]) : MutationResult

Parameters

$key : string
$document : mixed
$options : InsertOptions = null

Return values

MutationResult —

lookupIn()


    public
                lookupIn(string $key, array<string|int, mixed> $specs[, LookupInOptions $options = null ]) : LookupInResult

Parameters

$key : string
$specs : array<string|int, mixed>
$options : LookupInOptions = null

Return values

LookupInResult —

mutateIn()


    public
                mutateIn(string $key, array<string|int, mixed> $specs[, MutateInOptions $options = null ]) : MutateInResult

Parameters

$key : string
$specs : array<string|int, mixed>
$options : MutateInOptions = null

Return values

MutateInResult —

name()


    public
                name() : string

Return values

string —

queryIndexes()


    public
                queryIndexes() : CollectionQueryIndexManager

Return values

CollectionQueryIndexManager —

remove()


    public
                remove(string $key[, RemoveOptions $options = null ]) : MutationResult

Parameters

$key : string
$options : RemoveOptions = null

Return values

MutationResult —

replace()


    public
                replace(string $key, mixed $document[, ReplaceOptions $options = null ]) : MutationResult

Parameters

$key : string
$document : mixed
$options : ReplaceOptions = null

Return values

MutationResult —

scopeName()


    public
                scopeName() : string

Return values

string —

touch()


    public
                touch(string $key, mixed $expiry[, TouchOptions $options = null ]) : MutationResult

Parameters

$key : string
$expiry : mixed
$options : TouchOptions = null

Return values

MutationResult —

unlock()


    public
                unlock(string $key, string $cas[, UnlockOptions $options = null ]) : Result

Parameters

$key : string
$cas : string
$options : UnlockOptions = null

Return values

Result —

upsert()


    public
                upsert(string $key, mixed $document[, UpsertOptions $options = null ]) : MutationResult

Parameters

$key : string
$document : mixed
$options : UpsertOptions = null

Return values

MutationResult —

Collection in package Application implements CollectionInterface

Interfaces, Classes, Traits and Enums

Table of Contents

Constants

DEFAULT_NAME

Properties

$bucketName

$client

$name

$scopeName

Methods

__construct()

Parameters

Return values

binary()

Return values

bucketName()

Return values

exists()

Parameters

Return values

get()

Parameters

Return values

getAllReplicas()

Parameters

Tags

Return values

getAndLock()

Parameters

Tags

Return values

getAndTouch()

Parameters

Tags

Return values

getAnyReplica()

Parameters

Tags

Return values

insert()

Parameters

Tags

Return values

lookupIn()

Parameters

Return values

mutateIn()

Parameters

Tags

Return values

name()

Return values

queryIndexes()

Return values

remove()

Parameters

Tags

Return values

replace()

Parameters

Tags

Return values

scopeName()

Return values

touch()

Parameters

Return values

unlock()

Parameters

Tags

Return values

upsert()

Parameters

Tags

Return values

Collection
in package

Application

implements CollectionInterface