• Home
• Ublaboo
• DataGrid
• DataGrid

PHP Class Ublaboo\DataGrid\DataGrid

ファイルを表示 Open project: ublaboo/datagrid Class Usage Examples

Public Properties

Property	Type	Description
$default_filter	array
$default_filter_use_on_reset	boolean
$default_sort	array
$default_sort_use_on_reset	boolean
$filter	array
$form_method	string	Default form method
$icon_prefix	string
$onColumnAdd	callable[]
$onExport	callable[]
$onFiltersAssabled	callable[]
$onRedraw	callable[]
$onRender	callable[]
$page	integer
$per_page	integer | string
$sort	array
$strict_entity_property	boolean	When set to TRUE, datagrid throws an exception when tring to get related entity within join and entity does not exist
$strict_session_filter_values	boolean	When set to TRUE, datagrid throws an exception when tring to set filter value, that does not exist (select, multiselect, etc)

Protected Properties

Property	Type	Description
$actions	Ublaboo\DataGrid\Column\Action[]
$auto_submit	boolean
$can_hide_columns	boolean
$collapsible_outer_filters	boolean
$column_callbacks	array
$columns	Column\IColumn[]
$columnsSummary	ColumnsSummary
$columns_export_order	array
$columns_visibility	array
$csv_export	boolean
$csv_export_filtered	boolean
$dataFilter	DataFilter
$dataModel	DataModel
$default_per_page	integer
$do_paginate	boolean
$exports	Ublaboo\DataGrid\Export\Export[]
$filter_submit_button	Ublaboo\DataGrid\Filter\SubmitButton | null
$filters	Ublaboo\DataGrid\Filter\Filter[]
$force_filter_active	boolean
$grid_session	Nette\Http\SessionSection
$group_action_collection	Ublaboo\DataGrid\GroupAction\GroupActionCollection
$has_column_reset	boolean
$inlineAdd	Ublaboo\DataGrid\InlineEdit\InlineEdit
$inlineEdit	Ublaboo\DataGrid\InlineEdit\InlineEdit
$items_detail	Ublaboo\DataGrid\Column\ItemDetail
$items_per_page_list	array
$multiSort	boolean
$original_template	string
$outer_filter_rendering	boolean
$primary_key	string
$redraw_item	array
$refresh_url	boolean
$remember_state	boolean
$rowCallback	callable
$row_conditions	array
$snippets_set	boolean
$some_column_default_hide	boolean
$sort_callback	callable | null
$sortable	boolean
$sortable_handler	string
$template_file	string
$toolbar_buttons	Ublaboo\DataGrid\Toolbar\ToolbarButton[]
$translator	mixed
$tree_view_children_callback	callable
$tree_view_has_children_callback	callable
$tree_view_has_children_column	string
$use_happy_components	boolean

Public Methods

Method	Description
__construct ( Nette\ComponentModel\IContainer $parent = NULL, string $name = NULL )
addAction ( string $key, string $name, string $href = NULL, array $params = NULL ) : Action	Create action
addActionCallback ( string $key, string $name, $callback = NULL ) : Action	Create action callback
addColumnCallback ( string $key, callable $callback ) : void
addColumnDateTime ( string $key, string $name, string | null $column = NULL ) : ColumnDateTime	Add column with date formating
addColumnLink ( string $key, string $name, $href = NULL, string | null $column = NULL, array $params = NULL ) : ColumnLink	Add column with link
addColumnNumber ( string $key, string $name, string | null $column = NULL ) : ColumnNumber	Add column with possible number formating
addColumnStatus ( string $key, string $name, string | null $column = NULL ) : ColumnStatus	Add column status
addColumnText ( string $key, string $name, string | null $column = NULL ) : Column\ColumnText	Add text column with no other formating
addExportCallback ( string $text, callable $callback, boolean $filtered = FALSE ) : Export	Add export of type callback
addExportCsv ( string $text, string $csv_file_name, string | null $output_encoding = NULL, string | null $delimiter = NULL, boolean $include_bom = FALSE ) : Export	Add already implemented csv export
addExportCsvFiltered ( string $text, string $csv_file_name, string | null $output_encoding = NULL, string | null $delimiter = NULL, boolean $include_bom = FALSE ) : Export	Add already implemented csv export, but for filtered data
addFilterDate ( string $key, string $name, string $column = NULL ) : FilterDate	Add datepicker filter
addFilterDateRange ( string $key, string $name, string $column = NULL, $name_second = '-' ) : FilterDateRange	Add datepicker filter (from - to)
addFilterMultiSelect ( string $key, string $name, array $options, string $column = NULL ) : FilterSelect	Add multi select box filter
addFilterRange ( string $key, string $name, string $column = NULL, $name_second = '-' ) : FilterRange	Add range filter (from - to)
addFilterSelect ( string $key, string $name, array $options, string $column = NULL ) : FilterSelect	Add select box filter
addFilterText ( string $key, string $name, array | string $columns = NULL ) : FilterText	Add filter fot text search
addGroupAction ( string $title, array $options = [] ) : GroupAction	Alias for add group select action
addGroupSelectAction ( string $title, array $options = [] ) : GroupAction	Add group action (select box)
addGroupTextAction ( string $title ) : GroupAction	Add group action (text input)
addGroupTextareaAction ( string $title ) : GroupAction	Add group action (textarea)
addInlineAdd ( ) : InlineEdit
addInlineEdit ( $primary_where_column = NULL ) : InlineEdit
addMultiAction ( string $key, $name )
addToolbarButton ( string $href, string $text = '', array $params = [] ) : ToolbarButton	Add toolbar button
allowRowsAction ( string $key, callable $condition ) : void
allowRowsGroupAction ( callable $condition ) : void
allowRowsInlineEdit ( callable $condition ) : void
assableFilters ( ) : Filter[]	Fill array of Filter\Filter[] with values from $this->filter persistent parameter Fill array of Column\Column[] with values from $this->sort persistent parameter
attached ( $presenter ) : void	{inheritDoc}
canHideColumns ( ) : boolean	Can datagrid hide colums?
createComponentFilter ( ) : Nette\Application\UI\Form	FilterAndGroupAction form factory
createComponentPaginator ( ) : DataGridPaginator	Paginator factory
deleteSessionData ( $key ) : void	Delete session data
deleteSesssionData ( $key ) : void	Delete session data
filterSucceeded ( Nette\Application\UI\Form $form ) : void	Set $this->filter values after filter form submitted
findDefaultFilter ( ) : void	User may set default filter, find it
findDefaultPerPage ( ) : void	User may set default "items per page" value, apply it
findDefaultSort ( ) : void	User may set default sorting, apply it
findSessionValues ( ) : void	Try to restore session stuff
getAction ( string $key ) : Action	Get existing action
getColumn ( string $key ) : Column	Return existing column
getColumnCallback ( string $key ) : callable | null
getColumns ( ) : Column\IColumn[]	Get set of set columns
getColumnsCount ( ) : integer	Get count of columns
getColumnsSummary ( ) : ColumnsSummary | null
getColumnsVisibility ( )
getDataSource ( ) : Ublaboo\DataGrid\DataSource\IDataSource | null
getFilter ( string $key ) : Filter	Get defined filter
getFilterSubmitButton ( ) : SubmitButton	Submit button when no auto-submitting is used
getGroupActionCollection ( ) : GroupActionCollection	Get collection of all group actions
getInlineAdd ( ) : InlineEdit | null
getInlineEdit ( ) : InlineEdit | null
getItemDetailForm ( ) : Container | null
getItemsDetail ( ) : array	Get items detail parameters
getItemsPerPageList ( ) : array	Get associative array of items_per_page_list
getOriginalTemplateFile ( ) : string	Get DataGrid original template file
getPaginator ( ) : null | DataGridPaginator	Return current paginator class
getParent ( ) : Nette\Application\UI\PresenterComponent
getPerPage ( ) : integer	Get parameter per_page
getPrimaryKey ( ) : string	Get primary key of datagrid data source
getRowCondition ( string $name, string | null $key = NULL ) : boolean | callable
getSessionData ( string $key = NULL, $default_value = NULL ) : mixed	Get session data if functionality is enabled
getSessionSectionName ( ) : string	Find some unique session key name
getSortNext ( Column $column ) : array
getSortableHandler ( ) : string	Return sortable handle name
getSortableParentPath ( ) : strign
getTemplateFile ( ) : static	Get DataGrid template file
getTranslator ( ) : Nette\Localization\ITranslator	Get translator for datagrid
handleActionCallback ( $__key, $__id )
handleChangeStatus ( string $id, string $key, string $value ) : void	Handler for column status
handleEdit ( mixed $id, mixed $key ) : void	Handler for inline editing
handleExport ( integer $id ) : void	Handler for export
handleGetChildren ( integer $parent ) : void	Handler for getting children of parent item (e.g. category)
handleGetItemDetail ( mixed $id ) : void	Handler for getting item detail
handleHideColumn ( string $column ) : void	Notice datagrid to not display particular columns
handleInlineEdit ( mixed $id ) : void
handlePage ( integer $page ) : void	Handler for changind page (just refresh site with page as persistent paramter set)
handleRefreshState ( ) : void	Simply refresh url
handleResetColumnFilter ( string $key ) : void
handleResetFilter ( ) : void	Handler for reseting the filter
handleShowAllColumns ( ) : void	Tell datagrid to display all columns
handleShowColumn ( string $column ) : void	Reveal particular column
handleShowDefaultColumns ( ) : void	Tell datagrid to display default columns
handleSort ( array $sort ) : void	Handler for sorting
hasAutoSubmit ( ) : boolean
hasCollapsibleOuterFilters ( ) : boolean
hasColumnReset ( ) : boolean
hasColumnsSummary ( ) : boolean	Will datagrid show summary in the end?
hasGroupActions ( ) : boolean	Has datagrid some group actions?
hasOuterFilterRendering ( ) : boolean	Are datagrid filters rendered separately?
hasSomeColumnDefaultHide ( )	Are some of columns hidden bydefault?
hasTreeViewChildrenCallback ( ) : boolean	Is tree view children callback set?
isFilterActive ( ) : boolean	Is filter active?
isMultiSortEnabled ( ) : boolean	Tell wether DataGrid can be sorted by multiple columns
isPaginated ( ) : boolean	Tell whether Grid is paginated
isSortable ( ) : boolean	Tell whether DataGrid is sortable
isTreeView ( ) : boolean	Is tree view set?
redrawItem ( integer $id, mixed $primary_where_column = NULL ) : void	Redraw just one row via ajax
reload ( $snippets = [] ) : void	Redraw $this
removeAction ( string $key ) : void	Remove action
removeColumn ( string $key ) : void	Remove column
removeFilter ( string $key ) : void	Remove filter
render ( ) : void	Render template
resetExportsLinks ( )
saveSessionData ( string $key, mixed $value ) : void	Save session data - just if it is enabled
sendNonEmptyFiltersInPayload ( Filter[] $filters ) : void
setAutoSubmit ( boolean $auto = TRUE )	Tell grid filters to by submitted automatically
setCollapsibleOuterFilters ( boolean $collapsible_outer_filters = TRUE )
setColumnReset ( boolean $reset = TRUE ) : static
setColumnsExportOrder ( array $order )	Columns order may be different for export and normal grid
setColumnsHideable ( ) : static	Order Grid to set columns hideable.
setColumnsOrder ( array $order ) : static	Set order of datagrid columns
setColumnsSummary ( array $columns, callable $rowCallback = NULL ) : ColumnsSummary	Set columns to be summarized in the end.
setDataSource ( Ublaboo\DataGrid\DataSource\IDataSource | array | DibiFluent | Selection | Doctrine\ORM\QueryBuilder $source ) : static	Set Grid data source
setDefaultFilter ( array $default_filter, boolean $use_on_reset = TRUE ) : static	If we want to sent some initial filter
setDefaultPerPage ( $count ) : static	Set default "items per page" value in pagination select
setDefaultSort ( array $sort ) : static	Set default sorting
setDefaultSort ( array $sort, boolean $use_on_reset = TRUE ) : static	Set default sorting
setFilter ( array $filter ) : static	Set filter values (force - overwrite user data)
setFilterActive ( )	Tell that filter is active from whatever reasons return static
setFilterContainerDefaults ( Container $container, array $values )
setFilterContainerDefaults ( Container $container, array | Iterator $values ) : void
setItemsDetail ( mixed $detail = TRUE, boolean | null $primary_where_column = NULL ) : ItemDetail	Items can have thair detail - toggled
setItemsDetailForm ( callable $callable_set_container ) : static
setItemsPerPageList ( array $items_per_page_list, $include_all = TRUE ) : static	Set options of select "items_per_page"
setMultiSortEnabled ( boolean $multiSort = TRUE ) : void	Enable multi-sorting capability
setOuterFilterRendering ( boolean $out = TRUE ) : static	Should be datagrid filters rendered separately?
setPagination ( boolean $do ) : static	Order Grid to "be paginated"
setPrimaryKey ( string $primary_key ) : static	By default ID, you can change that
setRefreshUrl ( boolean $refresh = TRUE ) : static	Should datagrid refresh url using history API?
setRememberState ( boolean $remember = TRUE ) : static	Should datagrid remember its filters/pagination/etc using session?
setRowCallback ( callable $callback ) : static	Each row can be modified with user callback
setSomeColumnDefaultHide ( boolean $default_hide )	Some of datagrid columns is hidden by default
setSortable ( boolean $sortable = TRUE ) : static	Set grido to be sortable
setSortableHandler ( string $handler = 'sort!' ) : static	Set sortable handle
setStrictSessionFilterValues ( boolean $strict = TRUE )
setTemplateFile ( string $template_file ) : static	Set custom template file to render
setTranslator ( Nette\Localization\ITranslator $translator ) : static	Set datagrid translator
setTreeView ( callable $get_children_callback, string | callable $tree_view_has_children_column = 'has_children' ) : static	Setting tree view
treeViewChildrenCallback ( mixed $item ) : boolean
useHappyComponents ( boolean | null $use = NULL ) : void | boolean	Tell datagrid wheteher to use or not happy components

Protected Methods

Method	Description
addActionCheck ( string $key )	Check whether given key already exists in $this->filters
addColumn ( string $key, Column $column ) : Column
addColumnCheck ( string $key )	Check whether given key already exists in $this->columns
addFilterCheck ( string $key )	Check whether given key already exists in $this->filters
addToExports ( Export $export ) : Export	Add export to array
createSorting ( array $sort, callable $sort_callback = NULL ) : void
createSorting ( array $sort, callable | null $sort_callback ) : void

Method Details

Property Details