PHP Класс Grido\Grid

Автор: Petr Bugyík
Наследование: extends Grido\Components\Container
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$filter array @persistent
$onFetchData event for modifying data
$onRegistered event on all grid's components registered
$onRender event on render
$page integer @persistent
$perPage integer @persistent
$sort array @persistent

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

Свойство Тип Описание
$count total count of items
$customization grido\Customization
$data mixed
$defaultFilter array
$defaultPerPage integer
$defaultSort array
$filterRenderType string
$model Grido\DataSources\IDataSource
$options array
$paginator Grido\Components\Paginator
$perPageList array
$primaryKey string
$propertyAccessor Symfony\Component\PropertyAccess\PropertyAccessor
$rememberState boolean
$rememberStateSectionName string
$rowCallback returns tr html element; function($row, Html $tr)
$strictMode boolean
$tablePrototype Nette\Utils\Html
$translator Nette\Localization\ITranslator

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

Метод Описание
__getConditions ( array $filter ) : array
__triggerUserNotice ( string $message )
createTemplate ( ) : Nette\Templating\FileTemplate
getActualFilter ( string $key = NULL ) : mixed Returns actual filter values.
getClientSideOptions ( ) : array Returns client-side options.
getCount ( ) : integer Returns total count of data.
getCustomization ( ) : grido\Customization
getData ( boolean $applyPaging = TRUE, boolean $useCache = TRUE, boolean $fetch = TRUE ) : array | Grido\DataSources\IDataSource | Selection Returns fetched data.
getDefaultFilter ( ) : array Returns default filter.
getDefaultPerPage ( ) : integer Returns default per page.
getDefaultSort ( ) : array Returns default sort.
getFilterRenderType ( ) : string
getModel ( ) : Grido\DataSources\IDataSource
getPaginator ( ) : Grido\Components\Paginator
getPerPage ( ) : integer Returns items per page.
getPerPageList ( ) : array Returns list of possible items per page.
getPrimaryKey ( ) : string Returns primary key.
getProperty ( array | object $object, string $name ) : mixed A simple wrapper around symfony/property-access with Nette Database dot notation support.
getPropertyAccessor ( ) : PropertyAccessor
getRememberSession ( boolean $forceStart = FALSE ) : SessionSection | null Returns remember session for set expiration, etc.
getRememberState ( ) : boolean Returns remember state.
getRowCallback ( ) : callback Returns row callback.
getRowPrototype ( mixed $row ) : Nette\Utils\Html
getTablePrototype ( ) : Nette\Utils\Html Returns table html element of grid.
getTranslator ( ) : Grido\Translations\FileTranslator Returns translator.
handleFilter ( Nette\Forms\Controls\SubmitButton $button )
handlePage ( integer $page )
handlePerPage ( Nette\Forms\Controls\SubmitButton $button )
handleRefresh ( ) Ajax method.
handleReset ( Nette\Forms\Controls\SubmitButton $button )
handleSort ( array $sort )
isStrictMode ( ) : boolean
loadState ( array $params ) Loads state informations.
reload ( ) : void Refresh wrapper.
render ( )
saveState ( array &$params, Nette\Application\UI\PresenterComponentReflection $reflection = NULL ) Saves state informations for next request.
setClientSideOptions ( array $options ) : Grid Sets client-side options.
setCustomization ( grido\Customization $customization )
setDefaultFilter ( array $filter ) : Grid Sets default filtering.
setDefaultPerPage ( integer $perPage ) : Grid Sets the default number of items per page.
setDefaultSort ( array $sort ) : Grid Sets default sorting.
setFilterRenderType ( string $type ) : Grid Sets type of filter rendering.
setModel ( mixed $model, boolean $forceWrapper = FALSE ) : Grid Sets a model that implements the interface Grido\DataSources\IDataSource or data-source object.
setPaginator ( Grido\Components\Paginator $paginator ) : Grid Sets custom paginator.
setPerPageList ( array $perPageList ) : Grid Sets items to per-page select.
setPrimaryKey ( string $key ) : Grid Sets grid primary key.
setRememberState ( boolean $state = TRUE, string $sectionName = NULL ) : Grid Sets saving state to session.
setRowCallback ( $callback ) : Grid Sets callback for customizing tr html object.
setStrictMode ( boolean $mode ) : Grid Determines whether any user error will cause a notice.
setTemplateFile ( string $file ) : Grid Sets file name of custom template.
setTranslator ( Nette\Localization\ITranslator $translator ) : Grid Sets translator.

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

Метод Описание
applyFiltering ( )
applyPaging ( )
applySorting ( )
createComponentForm ( $name )
getItemsForCountSelect ( ) : array
saveRememberState ( )

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

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

public __getConditions ( array $filter ) : array
$filter array
Результат array

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

public __triggerUserNotice ( string $message )
$message string

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

protected applyFiltering ( )

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

protected applyPaging ( )

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

protected applySorting ( )

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

protected createComponentForm ( $name )

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

public createTemplate ( ) : Nette\Templating\FileTemplate
Результат Nette\Templating\FileTemplate

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

Returns actual filter values.
public getActualFilter ( string $key = NULL ) : mixed
$key string
Результат mixed

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

Returns client-side options.
public getClientSideOptions ( ) : array
Результат array

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

Returns total count of data.
public getCount ( ) : integer
Результат integer

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

public getCustomization ( ) : grido\Customization
Результат grido\Customization

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

Returns fetched data.
public getData ( boolean $applyPaging = TRUE, boolean $useCache = TRUE, boolean $fetch = TRUE ) : array | Grido\DataSources\IDataSource | Selection
$applyPaging boolean
$useCache boolean
$fetch boolean
Результат array | Grido\DataSources\IDataSource | Nette\Database\Table\Selection

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

Returns default filter.
public getDefaultFilter ( ) : array
Результат array

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

Returns default per page.
public getDefaultPerPage ( ) : integer
Результат integer

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

Returns default sort.
public getDefaultSort ( ) : array
Результат array

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

public getFilterRenderType ( ) : string
Результат string

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

protected getItemsForCountSelect ( ) : array
Результат array

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

public getModel ( ) : Grido\DataSources\IDataSource
Результат Grido\DataSources\IDataSource

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

public getPaginator ( ) : Grido\Components\Paginator
Результат Grido\Components\Paginator

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

Returns items per page.
public getPerPage ( ) : integer
Результат integer

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

Returns list of possible items per page.
public getPerPageList ( ) : array
Результат array

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

Returns primary key.
public getPrimaryKey ( ) : string
Результат string

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

A simple wrapper around symfony/property-access with Nette Database dot notation support.
public getProperty ( array | object $object, string $name ) : mixed
$object array | object
$name string
Результат mixed

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

public getPropertyAccessor ( ) : PropertyAccessor
Результат Symfony\Component\PropertyAccess\PropertyAccessor

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

Returns remember session for set expiration, etc.
public getRememberSession ( boolean $forceStart = FALSE ) : SessionSection | null
$forceStart boolean - if TRUE, session will be started if not
Результат Nette\Http\SessionSection | null

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

Returns remember state.
public getRememberState ( ) : boolean
Результат boolean

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

Returns row callback.
public getRowCallback ( ) : callback
Результат callback

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

public getRowPrototype ( mixed $row ) : Nette\Utils\Html
$row mixed item from db
Результат Nette\Utils\Html

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

Returns table html element of grid.
public getTablePrototype ( ) : Nette\Utils\Html
Результат Nette\Utils\Html

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

Returns translator.
public getTranslator ( ) : Grido\Translations\FileTranslator
Результат Grido\Translations\FileTranslator

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

public handleFilter ( Nette\Forms\Controls\SubmitButton $button )
$button Nette\Forms\Controls\SubmitButton

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

public handlePage ( integer $page )
$page integer

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

public handlePerPage ( Nette\Forms\Controls\SubmitButton $button )
$button Nette\Forms\Controls\SubmitButton

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

Ajax method.
public handleRefresh ( )

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

public handleReset ( Nette\Forms\Controls\SubmitButton $button )
$button Nette\Forms\Controls\SubmitButton

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

public handleSort ( array $sort )
$sort array

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

public isStrictMode ( ) : boolean
Результат boolean

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

Loads state informations.
public loadState ( array $params )
$params array

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

Refresh wrapper.
public reload ( ) : void
Результат void

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

public render ( )

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

protected saveRememberState ( )

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

Saves state informations for next request.
public saveState ( array &$params, Nette\Application\UI\PresenterComponentReflection $reflection = NULL )
$params array
$reflection Nette\Application\UI\PresenterComponentReflection (internal, used by Presenter)

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

Sets client-side options.
public setClientSideOptions ( array $options ) : Grid
$options array
Результат Grid

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

public setCustomization ( grido\Customization $customization )
$customization grido\Customization

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

Sets default filtering.
public setDefaultFilter ( array $filter ) : Grid
$filter array
Результат Grid

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

Sets the default number of items per page.
public setDefaultPerPage ( integer $perPage ) : Grid
$perPage integer
Результат Grid

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

Sets default sorting.
public setDefaultSort ( array $sort ) : Grid
$sort array
Результат Grid

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

Defaults inner (Filter::RENDER_INNER) if column does not exist then outer filter (Filter::RENDER_OUTER).
public setFilterRenderType ( string $type ) : Grid
$type string
Результат Grid

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

Sets a model that implements the interface Grido\DataSources\IDataSource or data-source object.
public setModel ( mixed $model, boolean $forceWrapper = FALSE ) : Grid
$model mixed
$forceWrapper boolean
Результат Grid

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

Sets custom paginator.
public setPaginator ( Grido\Components\Paginator $paginator ) : Grid
$paginator Grido\Components\Paginator
Результат Grid

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

Sets items to per-page select.
public setPerPageList ( array $perPageList ) : Grid
$perPageList array
Результат Grid

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

Defaults is "id".
public setPrimaryKey ( string $key ) : Grid
$key string
Результат Grid

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

Sets saving state to session.
public setRememberState ( boolean $state = TRUE, string $sectionName = NULL ) : Grid
$state boolean
$sectionName string
Результат Grid

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

Callback returns tr html element; function($row, Html $tr).
public setRowCallback ( $callback ) : Grid
$callback
Результат Grid

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

Determines whether any user error will cause a notice.
public setStrictMode ( boolean $mode ) : Grid
$mode boolean
Результат Grid

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

Sets file name of custom template.
public setTemplateFile ( string $file ) : Grid
$file string
Результат Grid

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

Sets translator.
public setTranslator ( Nette\Localization\ITranslator $translator ) : Grid
$translator Nette\Localization\ITranslator
Результат Grid

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

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

total count of items
protected $count

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

protected Customization,grido $customization
Результат grido\Customization

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

protected mixed $data
Результат mixed

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

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

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

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

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

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

$filter публичное свойство

@persistent
public array $filter
Результат array

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

protected string $filterRenderType
Результат string

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

protected IDataSource,Grido\DataSources $model
Результат Grido\DataSources\IDataSource

$onFetchData публичное свойство

event for modifying data
public $onFetchData

$onRegistered публичное свойство

event on all grid's components registered
public $onRegistered

$onRender публичное свойство

event on render
public $onRender

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

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

$page публичное свойство

@persistent
public int $page
Результат integer

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

protected Paginator,Grido\Components $paginator
Результат Grido\Components\Paginator

$perPage публичное свойство

@persistent
public int $perPage
Результат integer

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

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

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

protected string $primaryKey
Результат string

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

protected PropertyAccessor,Symfony\Component\PropertyAccess $propertyAccessor
Результат Symfony\Component\PropertyAccess\PropertyAccessor

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

protected bool $rememberState
Результат boolean

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

protected string $rememberStateSectionName
Результат string

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

returns tr html element; function($row, Html $tr)
protected $rowCallback

$sort публичное свойство

@persistent
public array $sort
Результат array

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

protected bool $strictMode
Результат boolean

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

protected Html,Nette\Utils $tablePrototype
Результат Nette\Utils\Html

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

protected ITranslator,Nette\Localization $translator
Результат Nette\Localization\ITranslator