Documentation

Overrides
in package
implements ArrayAccess

Class Overrides

Tags
date

4/5/20

author

Abdullah Al-Faqeir abdullah@devloops.net

Table of Contents

Interfaces

ArrayAccess

Constants

RESOURCE_PATH  = 'overrides'

Properties

$apiCall  : ApiCall
$collectionName  : string
$overrides  : array<string|int, mixed>

Methods

__construct()  : mixed
Overrides constructor.
endPointPath()  : string
offsetExists()  : bool
offsetGet()  : Override
offsetSet()  : void
offsetUnset()  : void
retrieve()  : array<string|int, mixed>
upsert()  : array<string|int, mixed>

Constants

RESOURCE_PATH

public mixed RESOURCE_PATH = 'overrides'

Properties

$collectionName

private string $collectionName

$overrides

private array<string|int, mixed> $overrides = []

Methods

__construct()

Overrides constructor.

public __construct(string $collectionName, ApiCall $apiCall) : mixed
Parameters
$collectionName : string
$apiCall : ApiCall

endPointPath()

public endPointPath([string $overrideId = '' ]) : string
Parameters
$overrideId : string = ''
Return values
string

offsetExists()

public offsetExists(mixed $overrideId) : bool
Parameters
$overrideId : mixed
Tags
inheritDoc
Return values
bool

offsetGet()

public offsetGet(mixed $overrideId) : Override
Parameters
$overrideId : mixed
Tags
inheritDoc
Return values
Override

offsetSet()

public offsetSet(mixed $overrideId, mixed $value) : void
Parameters
$overrideId : mixed
$value : mixed
Tags
inheritDoc

offsetUnset()

public offsetUnset(mixed $overrideId) : void
Parameters
$overrideId : mixed
Tags
inheritDoc

upsert()

public upsert(string $overrideId, array<string|int, mixed> $config) : array<string|int, mixed>
Parameters
$overrideId : string
$config : array<string|int, mixed>
Tags
throws
TypesenseClientError|Exception
Return values
array<string|int, mixed>

        
On this page

Search results