PHP Interface WellCommerce\Component\DataSet\DataSetInterface

Author: Adam Piotrowski ([email protected])
Afficher le fichier Open project: wellcommerce/wellcommerce Interface Usage Examples

Méthodes publiques

Méthode Description
configureOptions ( WellCommerce\Component\DataSet\Configurator\DataSetConfiguratorInterface $configurator ) Configures dataset options
dispatchOnDataSetInitEvent ( ) : void Dispatches the init event using event-dispatcher service
getColumns ( ) : WellCommerce\Component\DataSet\Column\ColumnCollection Returns dataset columns
getResult ( string $contextType, array $requestOptions = [], array $contextOptions = [] ) : array Returns the dataset's result for given context type and options
setCacheOptions ( CacheOptions $options )
setColumns ( WellCommerce\Component\DataSet\Column\ColumnCollection $columns ) Sets dataset columns
setDefaultContextOption ( string $name, mixed $value ) Adds default context's option
setDefaultRequestOption ( string $name, mixed $value ) Adds default request's option

Method Details

configureOptions() public méthode

Configures dataset options
public configureOptions ( WellCommerce\Component\DataSet\Configurator\DataSetConfiguratorInterface $configurator )
$configurator WellCommerce\Component\DataSet\Configurator\DataSetConfiguratorInterface

dispatchOnDataSetInitEvent() public méthode

Dispatches the init event using event-dispatcher service
public dispatchOnDataSetInitEvent ( ) : void
Résultat void

getColumns() public méthode

Returns dataset columns
public getColumns ( ) : WellCommerce\Component\DataSet\Column\ColumnCollection
Résultat WellCommerce\Component\DataSet\Column\ColumnCollection

getResult() public méthode

Returns the dataset's result for given context type and options
public getResult ( string $contextType, array $requestOptions = [], array $contextOptions = [] ) : array
$contextType string
$requestOptions array
$contextOptions array
Résultat array

setCacheOptions() public méthode

public setCacheOptions ( CacheOptions $options )
$options WellCommerce\Component\DataSet\Cache\CacheOptions

setColumns() public méthode

Sets dataset columns
public setColumns ( WellCommerce\Component\DataSet\Column\ColumnCollection $columns )
$columns WellCommerce\Component\DataSet\Column\ColumnCollection

setDefaultContextOption() public méthode

Adds default context's option
public setDefaultContextOption ( string $name, mixed $value )
$name string
$value mixed

setDefaultRequestOption() public méthode

Adds default request's option
public setDefaultRequestOption ( string $name, mixed $value )
$name string
$value mixed