Interfaces, Classes, Traits and Enums
- CollectionInterface
Table of Contents
-
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|null $options = null ]) : ExistsResult
Parameters
-
$key
: string
-
-
$options
: ExistsOptions|null
= null
-
Return values
ExistsResult
—
get()
public
get(string $key[, GetOptions|null $options = null ]) : GetResult
Parameters
-
$key
: string
-
-
$options
: GetOptions|null
= null
-
Return values
GetResult
—
getAllReplicas()
public
getAllReplicas(string $key[, GetAllReplicasOptions|null $options = null ]) : array<string|int, mixed>
Parameters
-
$key
: string
-
-
$options
: GetAllReplicasOptions|null
= null
-
-
throws
-
DocumentNotFoundException
Return values
array<string|int, mixed>
—
getAndLock()
public
getAndLock(string $key, int $lockTimeSeconds[, GetAndLockOptions|null $options = null ]) : GetResult
Parameters
-
$key
: string
-
-
$lockTimeSeconds
: int
-
-
$options
: GetAndLockOptions|null
= null
-
-
throws
-
ProtocolException
-
throws
-
InvalidArgumentException
Return values
GetResult
—
getAndTouch()
public
getAndTouch(string $key, mixed $expiry[, GetAndTouchOptions|null $options = null ]) : GetResult
Parameters
-
$key
: string
-
-
$expiry
: mixed
-
-
$options
: GetAndTouchOptions|null
= null
-
-
throws
-
ProtocolException
-
throws
-
InvalidArgumentException
Return values
GetResult
—
getAnyReplica()
public
getAnyReplica(string $key[, GetAnyReplicaOptions|null $options = null ]) : GetReplicaResult
Parameters
-
$key
: string
-
-
$options
: GetAnyReplicaOptions|null
= null
-
-
throws
-
DocumentIrretrievableException
Return values
GetReplicaResult
—
insert()
public
insert(string $key, mixed $document[, InsertOptions|null $options = null ]) : MutationResult
Parameters
-
$key
: string
-
-
$document
: mixed
-
-
$options
: InsertOptions|null
= null
-
-
throws
-
InvalidArgumentException|DecodingFailureException
Return values
MutationResult
—
lookupIn()
public
lookupIn(string $key, array<string|int, mixed> $specs[, LookupInOptions|null $options = null ]) : LookupInResult
Parameters
-
$key
: string
-
-
$specs
: array<string|int, mixed>
-
-
$options
: LookupInOptions|null
= null
-
Return values
LookupInResult
—
mutateIn()
public
mutateIn(string $key, array<string|int, mixed> $specs[, MutateInOptions|null $options = null ]) : MutateInResult
Parameters
-
$key
: string
-
-
$specs
: array<string|int, mixed>
-
-
$options
: MutateInOptions|null
= null
-
-
throws
-
InvalidArgumentException
Return values
MutateInResult
—
name()
public
name() : string
Return values
string
—
queryIndexes()
public
queryIndexes() : CollectionQueryIndexManager
Return values
CollectionQueryIndexManager
—
remove()
public
remove(string $key[, RemoveOptions|null $options = null ]) : MutationResult
Parameters
-
$key
: string
-
-
$options
: RemoveOptions|null
= null
-
-
throws
-
InvalidArgumentException
Return values
MutationResult
—
replace()
public
replace(string $key, mixed $document[, ReplaceOptions|null $options = null ]) : MutationResult
Parameters
-
$key
: string
-
-
$document
: mixed
-
-
$options
: ReplaceOptions|null
= null
-
-
throws
-
InvalidArgumentException
Return values
MutationResult
—
scopeName()
public
scopeName() : string
Return values
string
—
touch()
public
touch(string $key, mixed $expiry[, TouchOptions|null $options = null ]) : MutationResult
Parameters
-
$key
: string
-
-
$expiry
: mixed
-
-
$options
: TouchOptions|null
= null
-
Return values
MutationResult
—
unlock()
public
unlock(string $key, string $cas[, UnlockOptions|null $options = null ]) : Result
Parameters
-
$key
: string
-
-
$cas
: string
-
-
$options
: UnlockOptions|null
= null
-
-
throws
-
ProtocolException
Return values
Result
—
upsert()
public
upsert(string $key, mixed $document[, UpsertOptions|null $options = null ]) : MutationResult
Parameters
-
$key
: string
-
-
$document
: mixed
-
-
$options
: UpsertOptions|null
= null
-
-
throws
-
InvalidArgumentException
Return values
MutationResult
—