Свойство | Тип | Описание | |
---|---|---|---|
$adapter | instance of Source | ||
$aliases | array | List of aliases for columns in DB | |
$allowFilters | array | Example ['id', 'status' => ['active', 'disable']] | |
$allowOrders | list of allow orders | ||
$controller | location of Grid | ||
$data | instance of Data | ||
$defaultLimit | default value of page limit | ||
$defaultOrder | default order | ||
$filters | list of filters | ||
$limit | limit per page | ||
$module | location of Grid | ||
$orders | array | Example 'first' => 'ASC', 'last' => 'ASC' | |
$page | start from first page | ||
$params | custom array params | ||
$prefix | unique prefix of grid | ||
$uid | unique identification of grid |
Метод | Описание | |
---|---|---|
__construct ( array $options = null ) | Grid constructor | |
addAlias ( string $key, string $value ) : void | Add alias | |
addFilter ( string $column, string $filter, string $value ) : void | Add filter | |
addOrder ( string $column, string $order = Grid::ORDER_ASC ) : void | Add order rule | |
addOrders ( array $orders ) : void | Add order rules | |
checkFilter ( string $filter ) : boolean | Check filter | |
getAdapter ( ) : Bluz\Grid\Source\AbstractSource | Get source adapter | |
getAllowFilters ( ) : array | Get allow filters | |
getAllowOrders ( ) : array | Get allow orders | |
getController ( ) : string | Get controller | |
getData ( ) : Bluz\Grid\Data | Get data | |
getDefaultLimit ( ) : integer | Get default limit | |
getDefaultOrder ( ) : array | Get default order | |
getFilter ( string $column, string $filter = null ) : mixed | Get filter | |
getFilters ( ) : array | Get filters | |
getLimit ( ) : integer | Get limit per page | |
getModule ( ) : string | Get module | |
getOrders ( ) : array | Get orders | |
getPage ( ) : integer | Get page | |
getParams ( array $rewrite = [] ) : array | Return params prepared for url builder | |
getPrefix ( ) : string | Get prefix | |
getSettings ( ) : array | Get settings | |
getUid ( ) : string | Get unique Grid Id | |
getUrl ( array $params ) : string | Get Url | |
init ( ) : |
Initialize Grid | |
processRequest ( ) : |
Process request | |
processSource ( ) : self | Process source | |
setAdapter ( Bluz\Grid\Source\AbstractSource $adapter ) : void | Set source adapter | |
setAliases ( array $aliases ) : void | Set aliases | |
setAllowFilters ( array $filters = [] ) : void | Set allowed filters | |
setAllowOrders ( array $orders = [] ) : void | Set allow orders | |
setController ( string $controller ) : void | Set controller | |
setDefaultLimit ( integer $limit ) : void | Set default limit | |
setDefaultOrder ( string $column, string $order = Grid::ORDER_ASC ) : void | Set default order | |
setLimit ( integer $limit ) : void | Set limit per page | |
setModule ( string $module ) : void | Set module | |
setOrder ( string $column, string $order = Grid::ORDER_ASC ) : void | Set order | |
setOrders ( array $orders ) : void | Set orders | |
setPage ( integer $page = 1 ) : void | Set page | |
setParams ( $params ) : void | Setup params |
Метод | Описание | |
---|---|---|
applyAlias ( string $key ) : string | Apply Alias |
public __construct ( array $options = null ) | ||
$options | array |
protected applyAlias ( string $key ) : string | ||
$key | string | |
Результат | string |
public checkFilter ( string $filter ) : boolean | ||
$filter | string | |
Результат | boolean |
public getAdapter ( ) : Bluz\Grid\Source\AbstractSource | ||
Результат | Bluz\Grid\Source\AbstractSource |
public getAllowFilters ( ) : array | ||
Результат | array |
public getDefaultLimit ( ) : integer | ||
Результат | integer |
public getDefaultOrder ( ) : array | ||
Результат | array |
public processRequest ( ) : |
||
Результат |
public setAdapter ( Bluz\Grid\Source\AbstractSource $adapter ) : void | ||
$adapter | Bluz\Grid\Source\AbstractSource | |
Результат | void |
public setAliases ( array $aliases ) : void | ||
$aliases | array | |
Результат | void |
public setAllowFilters ( array $filters = [] ) : void | ||
$filters | array | |
Результат | void |
public setAllowOrders ( array $orders = [] ) : void | ||
$orders | array | |
Результат | void |
public setController ( string $controller ) : void | ||
$controller | string | |
Результат | void |
public setDefaultLimit ( integer $limit ) : void | ||
$limit | integer | |
Результат | void |
protected array $aliases | ||
Результат | array |
protected array $allowFilters | ||
Результат | array |
protected array $orders | ||
Результат | array |