Documentation

Keys
in package
implements ArrayAccess

Class Keys

Tags
date

6/1/20

author

Abdullah Al-Faqeir abdullah@devloops.net

Table of Contents

Interfaces

ArrayAccess

Constants

RESOURCE_PATH  = '/keys'

Properties

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

Methods

__construct()  : mixed
Keys constructor.
create()  : array<string|int, mixed>
generateScopedSearchKey()  : string
offsetExists()  : bool
offsetGet()  : Key
offsetSet()  : void
offsetUnset()  : void
retrieve()  : array<string|int, mixed>

Constants

RESOURCE_PATH

public mixed RESOURCE_PATH = '/keys'

Properties

$keys

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

Methods

__construct()

Keys constructor.

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

create()

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

generateScopedSearchKey()

public generateScopedSearchKey(string $searchKey, array<string|int, mixed> $parameters) : string
Parameters
$searchKey : string
$parameters : array<string|int, mixed>
Tags
throws
JsonException
Return values
string

offsetExists()

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

offsetGet()

public offsetGet(mixed $offset) : Key
Parameters
$offset : mixed
Return values
Key

offsetSet()

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

offsetUnset()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results