PHP Class Grido\Components\Container

Author: Petr Bugyík
Inheritance: extends Nette\Application\UI\Control
Show file Open project: o5/grido Class Usage Examples

Protected Properties

Property Type Description
$hasActions boolean
$hasButtons boolean
$hasColumns boolean
$hasExport boolean
$hasFilters boolean
$hasOperation boolean

Public Methods

Method Description
addActionEvent ( string $name, string $label, callback $onClick = NULL ) : Grido\Components\Actions\Event
addActionHref ( string $name, string $label, string $destination = NULL, array $arguments = [] ) : Href
addButton ( string $name, string $label = NULL, string $destination = NULL, array $arguments = [] ) : Button
addColumnDate ( string $name, string $label, string $dateFormat = NULL ) : Grido\Components\Columns\Date
addColumnEmail ( string $name, string $label ) : Grido\Components\Columns\Email
addColumnLink ( string $name, string $label ) : Grido\Components\Columns\Link
addColumnNumber ( string $name, string $label, integer $decimals = NULL, string $decPoint = NULL, string $thousandsSep = NULL ) : Grido\Components\Columns\Number
addColumnText ( string $name, string $label ) : Grido\Components\Columns\Text
addFilterCheck ( string $name, string $label ) : Grido\Components\Filters\Check
addFilterCustom ( string $name, Nette\Forms\IControl $formControl ) : Custom
addFilterDate ( string $name, string $label ) : Grido\Components\Filters\Date
addFilterDateRange ( string $name, string $label ) : Grido\Components\Filters\DateRange
addFilterNumber ( string $name, string $label ) : Grido\Components\Filters\Number
addFilterSelect ( string $name, string $label, array $items = NULL ) : Grido\Components\Filters\Select
addFilterText ( string $name, string $label ) : Text
getAction ( string $name, boolean $need = TRUE ) : Action Returns action component.
getButton ( $name, boolean $need = TRUE ) : Button Returns toolbar button component.
getColumn ( string $name, boolean $need = TRUE ) : Editable Returns column component.
getExport ( boolean $need = TRUE ) : Grido\Components\Export Returns export component.
getFilter ( string $name, boolean $need = TRUE ) : Filter Returns filter component.
getOperation ( boolean $need = TRUE ) : Operation Returns operations component.
hasActions ( boolean $useCache = TRUE ) : boolean
hasButtons ( boolean $useCache = TRUE ) : boolean
hasColumns ( boolean $useCache = TRUE ) : boolean
hasExport ( boolean $useCache = TRUE ) : boolean
hasFilters ( boolean $useCache = TRUE ) : boolean
hasOperation ( boolean $useCache = TRUE ) : boolean
setEditableColumns ( callback $callback = NULL ) : Grid Sets all columns as editable.
setExport ( string $label = NULL ) : Grido\Components\Export
setOperation ( array $operations, callback $onSubmit ) : Operation

Method Details

addActionEvent() public method

public addActionEvent ( string $name, string $label, callback $onClick = NULL ) : Grido\Components\Actions\Event
$name string
$label string
$onClick callback
return Grido\Components\Actions\Event

addActionHref() public method

public addActionHref ( string $name, string $label, string $destination = NULL, array $arguments = [] ) : Href
$name string
$label string
$destination string
$arguments array
return Grido\Components\Actions\Href

addButton() public method

public addButton ( string $name, string $label = NULL, string $destination = NULL, array $arguments = [] ) : Button
$name string
$label string
$destination string - first param for method $presenter->link()
$arguments array - second param for method $presenter->link()
return Button

addColumnDate() public method

public addColumnDate ( string $name, string $label, string $dateFormat = NULL ) : Grido\Components\Columns\Date
$name string
$label string
$dateFormat string
return Grido\Components\Columns\Date

addColumnEmail() public method

public addColumnEmail ( string $name, string $label ) : Grido\Components\Columns\Email
$name string
$label string
return Grido\Components\Columns\Email

addColumnNumber() public method

public addColumnNumber ( string $name, string $label, integer $decimals = NULL, string $decPoint = NULL, string $thousandsSep = NULL ) : Grido\Components\Columns\Number
$name string
$label string
$decimals integer number of decimal points
$decPoint string separator for the decimal point
$thousandsSep string thousands separator
return Grido\Components\Columns\Number

addColumnText() public method

public addColumnText ( string $name, string $label ) : Grido\Components\Columns\Text
$name string
$label string
return Grido\Components\Columns\Text

addFilterCheck() public method

public addFilterCheck ( string $name, string $label ) : Grido\Components\Filters\Check
$name string
$label string
return Grido\Components\Filters\Check

addFilterCustom() public method

public addFilterCustom ( string $name, Nette\Forms\IControl $formControl ) : Custom
$name string
$formControl Nette\Forms\IControl
return Grido\Components\Filters\Custom

addFilterDate() public method

public addFilterDate ( string $name, string $label ) : Grido\Components\Filters\Date
$name string
$label string
return Grido\Components\Filters\Date

addFilterDateRange() public method

public addFilterDateRange ( string $name, string $label ) : Grido\Components\Filters\DateRange
$name string
$label string
return Grido\Components\Filters\DateRange

addFilterNumber() public method

public addFilterNumber ( string $name, string $label ) : Grido\Components\Filters\Number
$name string
$label string
return Grido\Components\Filters\Number

addFilterSelect() public method

public addFilterSelect ( string $name, string $label, array $items = NULL ) : Grido\Components\Filters\Select
$name string
$label string
$items array
return Grido\Components\Filters\Select

addFilterText() public method

public addFilterText ( string $name, string $label ) : Text
$name string
$label string
return Grido\Components\Filters\Text

getAction() public method

Returns action component.
public getAction ( string $name, boolean $need = TRUE ) : Action
$name string
$need boolean
return Grido\Components\Actions\Action

getButton() public method

Returns toolbar button component.
public getButton ( $name, boolean $need = TRUE ) : Button
$need boolean
return Button

getColumn() public method

Returns column component.
public getColumn ( string $name, boolean $need = TRUE ) : Editable
$name string
$need boolean
return Grido\Components\Columns\Editable

getExport() public method

Returns export component.
public getExport ( boolean $need = TRUE ) : Grido\Components\Export
$need boolean
return Grido\Components\Export

getFilter() public method

Returns filter component.
public getFilter ( string $name, boolean $need = TRUE ) : Filter
$name string
$need boolean
return Grido\Components\Filters\Filter

getOperation() public method

Returns operations component.
public getOperation ( boolean $need = TRUE ) : Operation
$need boolean
return Operation

hasActions() public method

public hasActions ( boolean $useCache = TRUE ) : boolean
$useCache boolean
return boolean

hasButtons() public method

public hasButtons ( boolean $useCache = TRUE ) : boolean
$useCache boolean
return boolean

hasColumns() public method

public hasColumns ( boolean $useCache = TRUE ) : boolean
$useCache boolean
return boolean

hasExport() public method

public hasExport ( boolean $useCache = TRUE ) : boolean
$useCache boolean
return boolean

hasFilters() public method

public hasFilters ( boolean $useCache = TRUE ) : boolean
$useCache boolean
return boolean

hasOperation() public method

public hasOperation ( boolean $useCache = TRUE ) : boolean
$useCache boolean
return boolean

setEditableColumns() public method

First parameter is optional and is for implementation of method for saving modified data.
public setEditableColumns ( callback $callback = NULL ) : Grid
$callback callback function($id, $newValue, $oldValue, Editable $column) }
return Grido\Grid

setExport() public method

public setExport ( string $label = NULL ) : Grido\Components\Export
$label string of exporting file
return Grido\Components\Export

setOperation() public method

public setOperation ( array $operations, callback $onSubmit ) : Operation
$operations array
$onSubmit callback - callback after operation submit
return Operation

Property Details

$hasActions protected property

protected bool $hasActions
return boolean

$hasButtons protected property

protected bool $hasButtons
return boolean

$hasColumns protected property

protected bool $hasColumns
return boolean

$hasExport protected property

protected bool $hasExport
return boolean

$hasFilters protected property

protected bool $hasFilters
return boolean

$hasOperation protected property

protected bool $hasOperation
return boolean