Document
in package
Class Document
Tags
Table of Contents
Properties
- $apiCall : ApiCall
- $collectionName : string
- $documentId : string
Methods
- __construct() : mixed
- Document constructor.
- delete() : array<string|int, mixed>
- retrieve() : array<string|int, mixed>
- update() : array<string|int, mixed>
- endpointPath() : string
Properties
$apiCall
private
ApiCall
$apiCall
$collectionName
private
string
$collectionName
$documentId
private
string
$documentId
Methods
__construct()
Document constructor.
public
__construct(string $collectionName, string $documentId, ApiCall $apiCall) : mixed
Parameters
- $collectionName : string
- $documentId : string
- $apiCall : ApiCall
delete()
public
delete() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>retrieve()
public
retrieve() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>update()
public
update(array<string|int, mixed> $partialDocument[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
- $partialDocument : array<string|int, mixed>
- $options : array<string|int, mixed> = []
Tags
Return values
array<string|int, mixed>endpointPath()
private
endpointPath() : string