BinaryCollection
in package
BinaryCollection is an object containing functionality for performing KeyValue operations against the server with binary documents.
Table of Contents
- $bucketName : string
- $core : resource
- $name : string
- $scopeName : string
- append() : MutationResult
- Appends a value to a document.
- decrement() : CounterResult
- Decrements a counter document by a value.
- increment() : CounterResult
- Increments a counter document by a value.
- name() : string
- Get the name of the binary collection.
- prepend() : MutationResult
- Prepends a value to a document.
Properties
$bucketName
private
string
$bucketName
$core
private
resource
$core
$name
private
string
$name
$scopeName
private
string
$scopeName
Methods
append()
Appends a value to a document.
public
append(string $id, string $value[, AppendOptions|null $options = null ]) : MutationResult
Parameters
- $id : string
-
the key of the document
- $value : string
-
the value to append
- $options : AppendOptions|null = null
-
the options to use for the operation
Tags
Return values
MutationResult —decrement()
Decrements a counter document by a value.
public
decrement(string $id[, DecrementOptions|null $options = null ]) : CounterResult
Parameters
- $id : string
-
the key of the document
- $options : DecrementOptions|null = null
-
the options to use for the operation
Tags
Return values
CounterResult —increment()
Increments a counter document by a value.
public
increment(string $id[, IncrementOptions|null $options = null ]) : CounterResult
Parameters
- $id : string
-
the key of the document
- $options : IncrementOptions|null = null
-
the options to use for the operation
Tags
Return values
CounterResult —name()
Get the name of the binary collection.
public
name() : string
Tags
Return values
string —prepend()
Prepends a value to a document.
public
prepend(string $id, string $value[, PrependOptions|null $options = null ]) : MutationResult
Parameters
- $id : string
-
the key of the document
- $value : string
-
the value to prepend
- $options : PrependOptions|null = null
-
the options to use for the operation