Documentation

Presets
in package

Class Document

Tags
date

4/5/20

author

Abdullah Al-Faqeir abdullah@devloops.net

Table of Contents

Constants

MULTI_SEARCH_PATH  = '/multi_search'
PRESETS_PATH  = '/presets'

Properties

$apiCall  : ApiCall

Methods

__construct()  : mixed
Document constructor.
delete()  : array<string|int, mixed>
get()  : array<string|int, mixed>|string
put()  : array<string|int, mixed>
searchWithPreset()  : array<string|int, mixed>|string
endpointPath()  : string
multiSearchEndpointPath()  : string

Constants

MULTI_SEARCH_PATH

public mixed MULTI_SEARCH_PATH = '/multi_search'

PRESETS_PATH

public mixed PRESETS_PATH = '/presets'

Properties

Methods

__construct()

Document constructor.

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

delete()

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

put()

public put([array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$options : array<string|int, mixed> = []
Tags
throws
Exception
throws
TypesenseClientError
Return values
array<string|int, mixed>

searchWithPreset()

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

endpointPath()

private endpointPath(mixed $presetsName) : string
Parameters
$presetsName : mixed
Return values
string

multiSearchEndpointPath()

private multiSearchEndpointPath() : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results