Heratio Framework API Reference

SavedSearchContract
in

Table of Contents

Methods

create()  : int
delete()  : bool
findById()  : object|null
findByToken()  : object|null
getSearchesForNotification()  : array<string|int, mixed>
getUserSearches()  : array<string|int, mixed>
incrementRunCount()  : void
update()  : bool

Methods

create()

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

findById()

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

findByToken()

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

getSearchesForNotification()

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

getUserSearches()

public getUserSearches(int $userId[, int $limit = 25 ]) : array<string|int, mixed>
Parameters
$userId : int
$limit : int = 25
Return values
array<string|int, mixed>

update()

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

        
On this page

Search results