PHP Class WellCommerce\Bundle\CoreBundle\DataGrid\AbstractDataGrid

Author: Adam Piotrowski ([email protected])

Inheritance: extends WellCommerce\Bundle\CoreBundle\DependencyInjection\AbstractContainerAware, implements WellCommerce\Bundle\DataGridBundle\DataGridInterface

Show file Open project: wellcommerce/wellcommerce Class Usage Examples

Protected Properties

Property	Type	Description
$booted	boolean
$columns	WellCommerce\Component\DataGrid\Column\ColumnCollection
$dataset	WellCommerce\Component\DataSet\DataSetInterface
$eventDispatcher
$identifier	string
$options	WellCommerce\Component\DataGrid\Options\OptionsInterface

Public Methods

Method	Description
__construct ( WellCommerce\Component\DataSet\DataSetInterface $dataset, string $identifier, Symfony\Component\EventDispatcher\EventDispatcherInterface $eventDispatcher )	AbstractDataGrid constructor.
getColumns ( ) : WellCommerce\Component\DataGrid\Column\ColumnCollection
getIdentifier ( ) : string
getInstance ( ) : WellCommerce\Component\DataGrid\DataGridInterface	Returns current DataGrid
getOptions ( ) : WellCommerce\Component\DataGrid\Options\OptionsInterface
loadResults ( Request $request ) : array
setColumns ( WellCommerce\Component\DataGrid\Column\ColumnCollection $columns )
setOptions ( WellCommerce\Component\DataGrid\Options\OptionsInterface $options )

Protected Methods

Method	Description
configure ( )	Boots current datagrid
configureColumns ( WellCommerce\Component\DataGrid\Column\ColumnCollection $columns )	Configures DataGrid columns
configureOptions ( WellCommerce\Component\DataGrid\Options\OptionsInterface $options )	Configures DataGrid options
getActionUrl ( string $actionName ) : string	Returns the absolute URL pointing to the controller action
getJavascriptFunctionName ( string $name ) : string	Returns javascript function name

Method Details

__construct() public method

AbstractDataGrid constructor.

public __construct ( WellCommerce\Component\DataSet\DataSetInterface $dataset, string $identifier, Symfony\Component\EventDispatcher\EventDispatcherInterface $eventDispatcher )
$dataset	WellCommerce\Component\DataSet\DataSetInterface
$identifier	string
$eventDispatcher	Symfony\Component\EventDispatcher\EventDispatcherInterface

configure() protected method

Boots current datagrid

protected configure ( )

configureColumns() abstract protected method

Configures DataGrid columns

abstract protected configureColumns ( WellCommerce\Component\DataGrid\Column\ColumnCollection $columns )
$columns	WellCommerce\Component\DataGrid\Column\ColumnCollection

configureOptions() protected method

Configures DataGrid options

protected configureOptions ( WellCommerce\Component\DataGrid\Options\OptionsInterface $options )
$options	WellCommerce\Component\DataGrid\Options\OptionsInterface

getActionUrl() protected method

Returns the absolute URL pointing to the controller action

protected getActionUrl ( string $actionName ) : string
$actionName	string
return	string

getColumns() public method

public getColumns ( ) : WellCommerce\Component\DataGrid\Column\ColumnCollection
return	WellCommerce\Component\DataGrid\Column\ColumnCollection

getIdentifier() public method

public getIdentifier ( ) : string
return	string

getInstance() public method

Returns current DataGrid

public getInstance ( ) : WellCommerce\Component\DataGrid\DataGridInterface
return	WellCommerce\Component\DataGrid\DataGridInterface

getJavascriptFunctionName() protected method

Returns javascript function name

protected getJavascriptFunctionName ( string $name ) : string
$name	string
return	string

getOptions() public method

public getOptions ( ) : WellCommerce\Component\DataGrid\Options\OptionsInterface
return	WellCommerce\Component\DataGrid\Options\OptionsInterface

loadResults() public method

public loadResults ( Request $request ) : array
$request	Symfony\Component\HttpFoundation\Request
return	array

setColumns() public method

public setColumns ( WellCommerce\Component\DataGrid\Column\ColumnCollection $columns )
$columns	WellCommerce\Component\DataGrid\Column\ColumnCollection

setOptions() public method

public setOptions ( WellCommerce\Component\DataGrid\Options\OptionsInterface $options )
$options	WellCommerce\Component\DataGrid\Options\OptionsInterface

Property Details

$booted protected property

protected bool $booted
return	boolean

$columns protected property

protected ColumnCollection,WellCommerce\Component\DataGrid\Column $columns
return	WellCommerce\Component\DataGrid\Column\ColumnCollection

$dataset protected property

protected DataSetInterface,WellCommerce\Component\DataSet $dataset
return	WellCommerce\Component\DataSet\DataSetInterface

$eventDispatcher protected property

protected $eventDispatcher

$identifier protected property

protected string $identifier
return	string

$options protected property

protected OptionsInterface,WellCommerce\Component\DataGrid\Options $options
return	WellCommerce\Component\DataGrid\Options\OptionsInterface