PHP Class Nextras\Datagrid\Datagrid

Inheritance: extends Nette\Application\UI\Control
Show file Open project: nextras/datagrid Class Usage Examples

Public Properties

Property Type Description
$filter
$onRender of callbacks: function(Datagrid)
$orderColumn
$orderType
$page

Protected Properties

Property Type Description
$cellsTemplates array
$columnGetterCallback callable | null
$columns array
$data mixed
$dataSourceCallback callable
$editFormCallback callable | null
$editFormFactory callable | null
$editRowKey mixed
$filterDataSource array
$filterDefaults array
$filterFormFactory callable | null
$paginator Nette\Utils\Paginator
$paginatorItemsCountCallback callable | null
$rowPrimaryKey string
$sendOnlyRowParentSnippet boolean
$translator Nette\Localization\ITranslator

Public Methods

Method Description
addCellsTemplate ( string | Nette\Bridges\ApplicationLatte\Template $path )
addColumn ( $name, $label = null ) : Column Adds column
createComponentForm ( )
getCellsTemplate ( )
getColumnGetterCallback ( )
getDataSourceCallback ( )
getEditFormCallback ( )
getEditFormFactory ( )
getFilterFormFactory ( )
getRowPrimaryKey ( )
getTranslator ( )
getter ( $row, $column, $need = true )
handleEdit ( $primaryValue, $cancelEditPrimaryValue = null )
handlePaginate ( )
handleSort ( )
invalidateRow ( $primaryValue )
loadState ( array $params )
processForm ( Nette\Application\UI\Form $form )
redrawControl ( $snippet = null )
redrawRow ( $primaryValue )
render ( ) ****************************************************************************
setColumnGetterCallback ( callable $getterCallback = null )
setDataSourceCallback ( callable $dataSourceCallback )
setEditFormCallback ( callable $editFormCallback = null )
setEditFormFactory ( callable $editFormFactory = null )
setFilterFormFactory ( callable $filterFormFactory )
setPagination ( $itemsPerPage, callable $itemsCountCallback = null )
setRowPrimaryKey ( $columnName )
setTranslator ( Nette\Localization\ITranslator $translator )
translate ( $s, $count = null )

Protected Methods

Method Description
attached ( $presenter ) ****************************************************************************
createTemplate ( $class = null )
getData ( $key = null )

Private Methods

Method Description
filterFormFilter ( $values )

Method Details

addCellsTemplate() public method

public addCellsTemplate ( string | Nette\Bridges\ApplicationLatte\Template $path )
$path string | Nette\Bridges\ApplicationLatte\Template

addColumn() public method

Adds column
public addColumn ( $name, $label = null ) : Column
return Column

attached() protected method

****************************************************************************
protected attached ( $presenter )

createComponentForm() public method

public createComponentForm ( )

createTemplate() protected method

protected createTemplate ( $class = null )

getCellsTemplate() public method

public getCellsTemplate ( )

getColumnGetterCallback() public method

public getColumnGetterCallback ( )

getData() protected method

protected getData ( $key = null )

getDataSourceCallback() public method

public getDataSourceCallback ( )

getEditFormCallback() public method

public getEditFormCallback ( )

getEditFormFactory() public method

public getEditFormFactory ( )

getFilterFormFactory() public method

public getFilterFormFactory ( )

getRowPrimaryKey() public method

public getRowPrimaryKey ( )

getTranslator() public method

public getTranslator ( )

getter() public method

public getter ( $row, $column, $need = true )

handleEdit() public method

public handleEdit ( $primaryValue, $cancelEditPrimaryValue = null )

handlePaginate() public method

public handlePaginate ( )

handleSort() public method

public handleSort ( )

invalidateRow() public method

Deprecation:
public invalidateRow ( $primaryValue )

loadState() public method

public loadState ( array $params )
$params array

processForm() public method

public processForm ( Nette\Application\UI\Form $form )
$form Nette\Application\UI\Form

redrawControl() public method

public redrawControl ( $snippet = null )

redrawRow() public method

public redrawRow ( $primaryValue )

render() public method

****************************************************************************
public render ( )

setColumnGetterCallback() public method

public setColumnGetterCallback ( callable $getterCallback = null )
$getterCallback callable

setDataSourceCallback() public method

public setDataSourceCallback ( callable $dataSourceCallback )
$dataSourceCallback callable

setEditFormCallback() public method

public setEditFormCallback ( callable $editFormCallback = null )
$editFormCallback callable

setEditFormFactory() public method

public setEditFormFactory ( callable $editFormFactory = null )
$editFormFactory callable

setFilterFormFactory() public method

public setFilterFormFactory ( callable $filterFormFactory )
$filterFormFactory callable

setPagination() public method

public setPagination ( $itemsPerPage, callable $itemsCountCallback = null )
$itemsCountCallback callable

setRowPrimaryKey() public method

public setRowPrimaryKey ( $columnName )

setTranslator() public method

public setTranslator ( Nette\Localization\ITranslator $translator )
$translator Nette\Localization\ITranslator

translate() public method

public translate ( $s, $count = null )

Property Details

$cellsTemplates protected property

protected array $cellsTemplates
return array

$columnGetterCallback protected property

protected callable|null $columnGetterCallback
return callable | null

$columns protected property

protected array $columns
return array

$data protected property

protected mixed $data
return mixed

$dataSourceCallback protected property

protected callable $dataSourceCallback
return callable

$editFormCallback protected property

protected callable|null $editFormCallback
return callable | null

$editFormFactory protected property

protected callable|null $editFormFactory
return callable | null

$editRowKey protected property

protected mixed $editRowKey
return mixed

$filter public property

public $filter

$filterDataSource protected property

protected array $filterDataSource
return array

$filterDefaults protected property

protected array $filterDefaults
return array

$filterFormFactory protected property

protected callable|null $filterFormFactory
return callable | null

$onRender public property

of callbacks: function(Datagrid)
public $onRender

$orderColumn public property

public $orderColumn

$orderType public property

public $orderType

$page public property

public $page

$paginator protected property

protected Paginator,Nette\Utils $paginator
return Nette\Utils\Paginator

$paginatorItemsCountCallback protected property

protected callable|null $paginatorItemsCountCallback
return callable | null

$rowPrimaryKey protected property

protected string $rowPrimaryKey
return string

$sendOnlyRowParentSnippet protected property

protected bool $sendOnlyRowParentSnippet
return boolean

$translator protected property

protected ITranslator,Nette\Localization $translator
return Nette\Localization\ITranslator