Collection
in package
Class Collection
Tags
Table of Contents
Properties
- $documents : Documents
- $overrides : Overrides
- $synonyms : Synonyms
- $apiCall : ApiCall
- $exists : bool|null
- $name : string
Methods
- __construct() : mixed
- Collection constructor.
- delete() : array<string|int, mixed>
- endPointPath() : string
- exists() : bool|null
- getDocuments() : Documents
- getOverrides() : Overrides
- getSynonyms() : Synonyms
- retrieve() : array<string|int, mixed>
- setExists() : void
- Set collection exists flag.
- update() : array<string|int, mixed>
Properties
$documents
public
Documents
$documents
$overrides
public
Overrides
$overrides
$synonyms
public
Synonyms
$synonyms
$apiCall
private
ApiCall
$apiCall
$exists
private
bool|null
$exists
= null
$name
private
string
$name
Methods
__construct()
Collection constructor.
public
__construct(string $name, ApiCall $apiCall) : mixed
Parameters
- $name : string
- $apiCall : ApiCall
delete()
public
delete() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>endPointPath()
public
endPointPath() : string
Return values
stringexists()
public
exists() : bool|null
Return values
bool|nullgetDocuments()
public
getDocuments() : Documents
Return values
DocumentsgetOverrides()
public
getOverrides() : Overrides
Return values
OverridesgetSynonyms()
public
getSynonyms() : Synonyms
Return values
Synonymsretrieve()
public
retrieve() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>setExists()
Set collection exists flag.
public
setExists(bool $exists) : void
Parameters
- $exists : bool
update()
public
update(array<string|int, mixed> $schema) : array<string|int, mixed>
Parameters
- $schema : array<string|int, mixed>