PHP Класс PMA\libraries\SavedSearches

Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
__construct ( array $config ) Public constructor
delete ( ) : boolean Delete the search
getConfig ( ) : array Getter of config
getCriterias ( ) : array Getter for criterias
getDbname ( ) : string Getter for DB name
getId ( ) : integer | null Getter of id
getList ( array $wheres = [] ) : array Get the list of saved searches of a user on a DB
getSearchName ( ) : string Getter of searchName
getUsername ( ) : string Getter for username
load ( ) : boolean Load the current search from an id.
save ( ) : boolean Save the search
setConfig ( array $config ) : static Setter of config
setCriterias ( array | string $criterias, boolean $json = false ) : static Setter for criterias
setDbname ( string $dbname ) : static Setter for DB name
setId ( integer | null $searchId ) : static Setter of id
setSearchName ( string $searchName ) : static Setter of searchName
setUsername ( string $username ) : static Setter for username

Описание методов

__construct() публичный Метод

Public constructor
public __construct ( array $config )
$config array Global configuration

delete() публичный Метод

Delete the search
public delete ( ) : boolean
Результат boolean

getConfig() публичный Метод

Getter of config
public getConfig ( ) : array
Результат array

getCriterias() публичный Метод

Getter for criterias
public getCriterias ( ) : array
Результат array

getDbname() публичный Метод

Getter for DB name
public getDbname ( ) : string
Результат string

getId() публичный Метод

Getter of id
public getId ( ) : integer | null
Результат integer | null

getList() публичный Метод

Get the list of saved searches of a user on a DB
public getList ( array $wheres = [] ) : array
$wheres array List of filters
Результат array List of saved searches or empty array on failure

getSearchName() публичный Метод

Getter of searchName
public getSearchName ( ) : string
Результат string

getUsername() публичный Метод

Getter for username
public getUsername ( ) : string
Результат string

load() публичный Метод

Load the current search from an id.
public load ( ) : boolean
Результат boolean Success

save() публичный Метод

Save the search
public save ( ) : boolean
Результат boolean

setConfig() публичный Метод

Setter of config
public setConfig ( array $config ) : static
$config array Global configuration
Результат static

setCriterias() публичный Метод

Setter for criterias
public setCriterias ( array | string $criterias, boolean $json = false ) : static
$criterias array | string Criterias of saved searches
$json boolean Criterias are in JSON format
Результат static

setDbname() публичный Метод

Setter for DB name
public setDbname ( string $dbname ) : static
$dbname string DB name
Результат static

setId() публичный Метод

Setter of id
public setId ( integer | null $searchId ) : static
$searchId integer | null Id of search
Результат static

setSearchName() публичный Метод

Setter of searchName
public setSearchName ( string $searchName ) : static
$searchName string Saved search name
Результат static

setUsername() публичный Метод

Setter for username
public setUsername ( string $username ) : static
$username string Username
Результат static