Documentation

Aliases
in package
implements ArrayAccess

Class Aliases

Tags
date

4/5/20

author

Abdullah Al-Faqeir abdullah@devloops.net

Table of Contents

Interfaces

ArrayAccess

Constants

RESOURCE_PATH  = '/aliases'

Properties

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

Methods

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

Constants

RESOURCE_PATH

public mixed RESOURCE_PATH = '/aliases'

Properties

$aliases

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

Methods

__construct()

Aliases constructor.

public __construct(ApiCall $apiCall) : mixed
Parameters
$apiCall : ApiCall

__get()

public __get(mixed $name) : mixed
Parameters
$name : mixed

endPointPath()

public endPointPath(string $aliasName) : string
Parameters
$aliasName : string
Return values
string

offsetExists()

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

offsetGet()

public offsetGet(mixed $offset) : Alias
Parameters
$offset : mixed
Tags
inheritDoc
Return values
Alias

offsetSet()

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

offsetUnset()

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

upsert()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results