PHP Interface WellCommerce\Component\DataGrid\DataGridInterface

Author: Adam Piotrowski ([email protected])

Show file Open project: wellcommerce/wellcommerce Interface Usage Examples

Public Methods

Method	Description
getColumns ( ) : WellCommerce\Component\DataGrid\Column\ColumnCollection	Returns columns collection
getIdentifier ( ) : string	Returns an identifier
getInstance ( ) : WellCommerce\Component\DataGrid\DataGridInterface	Returns current DataGrid instance
getOptions ( ) : WellCommerce\Component\DataGrid\Options\OptionsInterface	Returns DataGrid options
loadResults ( Request $request ) : array	Forwards request to dataset and returns results
setColumns ( WellCommerce\Component\DataGrid\Column\ColumnCollection $columns ) : void	Sets DataGrid columns
setOptions ( WellCommerce\Component\DataGrid\Options\OptionsInterface $options ) : void	Sets DataGrid options

Method Details

getColumns() public method

Returns columns collection

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

getIdentifier() public method

Returns an identifier

public getIdentifier ( ) : string
return	string

getInstance() public method

Returns current DataGrid instance

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

getOptions() public method

Returns DataGrid options

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

loadResults() public method

Forwards request to dataset and returns results

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

setColumns() public method

Sets DataGrid columns

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

setOptions() public method

Sets DataGrid options

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