Synonyms
in package
implements
ArrayAccess
Class Synonyms
Table of Contents
Interfaces
- ArrayAccess
Constants
- RESOURCE_PATH = 'synonyms'
Properties
- $apiCall : ApiCall
- $collectionName : string
- $synonyms : array<string|int, mixed>
Methods
- __construct() : mixed
- Synonyms constructor.
- endPointPath() : string
- offsetExists() : bool
- offsetGet() : Synonym
- offsetSet() : void
- offsetUnset() : void
- retrieve() : array<string|int, mixed>
- upsert() : array<string|int, mixed>
Constants
RESOURCE_PATH
public
mixed
RESOURCE_PATH
= 'synonyms'
Properties
$apiCall
private
ApiCall
$apiCall
$collectionName
private
string
$collectionName
$synonyms
private
array<string|int, mixed>
$synonyms
= []
Methods
__construct()
Synonyms constructor.
public
__construct(string $collectionName, ApiCall $apiCall) : mixed
Parameters
- $collectionName : string
- $apiCall : ApiCall
endPointPath()
public
endPointPath([string $synonymId = '' ]) : string
Parameters
- $synonymId : string = ''
Return values
stringoffsetExists()
public
offsetExists(mixed $synonymId) : bool
Parameters
- $synonymId : mixed
Tags
Return values
booloffsetGet()
public
offsetGet(mixed $synonymId) : Synonym
Parameters
- $synonymId : mixed
Tags
Return values
SynonymoffsetSet()
public
offsetSet(mixed $synonymId, mixed $value) : void
Parameters
- $synonymId : mixed
- $value : mixed
Tags
offsetUnset()
public
offsetUnset(mixed $synonymId) : void
Parameters
- $synonymId : mixed
Tags
retrieve()
public
retrieve() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>upsert()
public
upsert(string $synonymId, array<string|int, mixed> $config) : array<string|int, mixed>
Parameters
- $synonymId : string
- $config : array<string|int, mixed>