Heratio Framework API Reference

AdvancedSearchService
in package

Table of Contents

Methods

__construct()  : mixed
clearHistory()  : bool
createTemplate()  : int
deleteSavedSearch()  : bool
deleteTemplate()  : bool
getFeaturedTemplates()  : array<string|int, mixed>
getPopularSearches()  : array<string|int, mixed>
getSavedSearch()  : object|null
getSavedSearchByToken()  : object|null
getSavedSearches()  : array<string|int, mixed>
getSetting()  : string|null
getSuggestions()  : array<string|int, mixed>
getTemplate()  : object|null
getTemplateBySlug()  : object|null
getTemplates()  : array<string|int, mixed>
getUserHistory()  : array<string|int, mixed>
recordSearch()  : void
runSavedSearch()  : void
saveSearch()  : int
setSetting()  : void
updateSavedSearch()  : bool
updateTemplate()  : bool

Methods

clearHistory()

public clearHistory(int|null $userId, string|null $sessionId) : bool
Parameters
$userId : int|null
$sessionId : string|null
Return values
bool

createTemplate()

public createTemplate(array<string|int, mixed> $data) : int
Parameters
$data : array<string|int, mixed>
Return values
int

deleteSavedSearch()

public deleteSavedSearch(int $id) : bool
Parameters
$id : int
Return values
bool

deleteTemplate()

public deleteTemplate(int $id) : bool
Parameters
$id : int
Return values
bool

getFeaturedTemplates()

public getFeaturedTemplates() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPopularSearches()

public getPopularSearches([int $limit = 10 ][, string|null $entityType = null ]) : array<string|int, mixed>
Parameters
$limit : int = 10
$entityType : string|null = null
Return values
array<string|int, mixed>

getSavedSearch()

public getSavedSearch(int $id) : object|null
Parameters
$id : int
Return values
object|null

getSavedSearchByToken()

public getSavedSearchByToken(string $token) : object|null
Parameters
$token : string
Return values
object|null

getSavedSearches()

public getSavedSearches(int $userId) : array<string|int, mixed>
Parameters
$userId : int
Return values
array<string|int, mixed>

getSetting()

public getSetting(string $key[, string|null $default = null ]) : string|null
Parameters
$key : string
$default : string|null = null
Return values
string|null

getSuggestions()

public getSuggestions(string $term[, int $limit = 8 ]) : array<string|int, mixed>
Parameters
$term : string
$limit : int = 8
Return values
array<string|int, mixed>

getTemplate()

public getTemplate(int $id) : object|null
Parameters
$id : int
Return values
object|null

getTemplateBySlug()

public getTemplateBySlug(string $slug) : object|null
Parameters
$slug : string
Return values
object|null

getTemplates()

public getTemplates([string|null $category = null ]) : array<string|int, mixed>
Parameters
$category : string|null = null
Return values
array<string|int, mixed>

getUserHistory()

public getUserHistory(int|null $userId, string|null $sessionId[, int $limit = 10 ]) : array<string|int, mixed>
Parameters
$userId : int|null
$sessionId : string|null
$limit : int = 10
Return values
array<string|int, mixed>

recordSearch()

public recordSearch(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>

saveSearch()

public saveSearch(array<string|int, mixed> $data) : int
Parameters
$data : array<string|int, mixed>
Return values
int

setSetting()

public setSetting(string $key, string $value) : void
Parameters
$key : string
$value : string

updateSavedSearch()

public updateSavedSearch(int $id, array<string|int, mixed> $data) : bool
Parameters
$id : int
$data : array<string|int, mixed>
Return values
bool

updateTemplate()

public updateTemplate(int $id, array<string|int, mixed> $data) : bool
Parameters
$id : int
$data : array<string|int, mixed>
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results