PHP Класс ModelSearch

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

Защищенные свойства (Protected)

Свойство Тип Описание
$criteria CDbCriteria
$itemsPerPage integer
$model BaseActiveRecord
$request Request
$searchItems array
$searchTerms array

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

Метод Описание
__construct ( BaseActiveRecord $model )
addActiveFilter ( )
addSearchItem ( $key, string | array $search = '' ) Add a search item.
getCriteria ( ) : CDbCriteria
getItemsPerPage ( ) : integer
getModel ( ) : BaseActiveRecord
getRequest ( ) : mixed
getSearchItems ( ) : array
getSearchTermForAttribute ( $attribute, string $default = '' ) : string Retrieves the search term supplied by the user for a given attribute if there was one.
initPagination ( ) : CPagination Inits pagination for the results and returns it.
initSearch ( $searchInput )
retrieveResults ( ) : CActiveRecord[] Performs the query that has been generated.
setCriteria ( CDbCriteria $criteria )
setItemsPerPage ( integer $itemsPerPage )
setModel ( BaseActiveRecord $model )
setRequest ( mixed $request )
setSearchItems ( array $searchItems )

Защищенные методы

Метод Описание
addCompare ( CDbCriteria $criteria, $attribute, $value, boolean $sensitive = false, string $operator = 'AND', $exactmatch = false ) Adds a comparison between a search term and an attribute.
generateCriteria ( string | array $attr = 'search' ) Generates the required Criteria object for the search.
relationalAttribute ( CDbCriteria $criteria, string $attribute, string $search ) : string Takes an attribute name and makes sure appropriate relationships are included.

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

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

public __construct ( BaseActiveRecord $model )
$model BaseActiveRecord

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

public addActiveFilter ( )

addCompare() защищенный Метод

Adds a comparison between a search term and an attribute.
protected addCompare ( CDbCriteria $criteria, $attribute, $value, boolean $sensitive = false, string $operator = 'AND', $exactmatch = false )
$criteria CDbCriteria
$attribute
$value
$sensitive boolean
$operator string

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

Add a search item.
public addSearchItem ( $key, string | array $search = '' )
$key
$search string | array

generateCriteria() защищенный Метод

Generates the required Criteria object for the search.
protected generateCriteria ( string | array $attr = 'search' )
$attr string | array

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

public getCriteria ( ) : CDbCriteria
Результат CDbCriteria

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

public getItemsPerPage ( ) : integer
Результат integer

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

public getModel ( ) : BaseActiveRecord
Результат BaseActiveRecord

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

public getRequest ( ) : mixed
Результат mixed

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

public getSearchItems ( ) : array
Результат array

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

Retrieves the search term supplied by the user for a given attribute if there was one.
public getSearchTermForAttribute ( $attribute, string $default = '' ) : string
$attribute
$default string
Результат string

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

Inits pagination for the results and returns it.
public initPagination ( ) : CPagination
Результат CPagination

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

public initSearch ( $searchInput )
$searchInput

relationalAttribute() защищенный Метод

This will take an attribute name many layers of relationship deep, make sure that all appropriate tables are included with the result and return a string that is then acceptable to be used in a where clause.
protected relationalAttribute ( CDbCriteria $criteria, string $attribute, string $search ) : string
$criteria CDbCriteria
$attribute string
$search string
Результат string

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

Performs the query that has been generated.
public retrieveResults ( ) : CActiveRecord[]
Результат CActiveRecord[]

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

public setCriteria ( CDbCriteria $criteria )
$criteria CDbCriteria

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

public setItemsPerPage ( integer $itemsPerPage )
$itemsPerPage integer

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

public setModel ( BaseActiveRecord $model )
$model BaseActiveRecord

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

public setRequest ( mixed $request )
$request mixed

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

public setSearchItems ( array $searchItems )
$searchItems array

Описание свойств

$criteria защищенное свойство

protected CDbCriteria $criteria
Результат CDbCriteria

$itemsPerPage защищенное свойство

protected int $itemsPerPage
Результат integer

$model защищенное свойство

protected BaseActiveRecord $model
Результат BaseActiveRecord

$request защищенное свойство

protected Request $request
Результат Request

$searchItems защищенное свойство

protected array $searchItems
Результат array

$searchTerms защищенное свойство

protected array $searchTerms
Результат array