PHP Class WellCommerce\Bundle\CoreBundle\DataSet\AbstractDataSet

Author: Adam Piotrowski ([email protected])

Inheritance: implements WellCommerce\Component\DataSet\DataSetInterface

Mostra file Open project: wellcommerce/wellcommerce Class Usage Examples

Protected Properties

Property	Type	Description
$cacheOptions	WellCommerce\Component\DataSet\Cache\CacheOptions
$columnTransformers	WellCommerce\Component\DataSet\Transformer\ColumnTransformerCollection
$columns	WellCommerce\Component\DataSet\Column\ColumnCollection
$defaultContextOptions	array
$defaultRequestOptions	array

Public Methods

Method	Description
__construct ( WellCommerce\Component\DataSet\Repository\DataSetAwareRepositoryInterface $repository, WellCommerce\Component\DataSet\Manager\DataSetManagerInterface $manager, Symfony\Component\EventDispatcher\EventDispatcherInterface $eventDispatcher )	AbstractDataSet constructor.
addColumn ( WellCommerce\Component\DataSet\Column\ColumnInterface $column )
configureOptions ( WellCommerce\Component\DataSet\Configurator\DataSetConfiguratorInterface $configurator )
dispatchOnDataSetInitEvent ( )
getColumns ( ) : WellCommerce\Component\DataSet\Column\ColumnCollection
getResult ( string $contextType, array $requestOptions = [], array $contextOptions = [] ) : array
setCacheOptions ( CacheOptions $options )
setColumns ( WellCommerce\Component\DataSet\Column\ColumnCollection $columns )
setDefaultContextOption ( string $name, $value )
setDefaultRequestOption ( string $name, $value )

Protected Methods

Method	Description
getDataSetRequest ( array $requestOptions = [] ) : WellCommerce\Component\DataSet\Request\DataSetRequestInterface
getDataSetTransformer ( string $type, array $options = [] ) : WellCommerce\Component\DataSet\Transformer\DataSetTransformerInterface
getQueryBuilder ( WellCommerce\Component\DataSet\Request\DataSetRequestInterface $request ) : Doctrine\ORM\QueryBuilder

Private Methods

Method	Description
dispatchDataSetRequestEvent ( WellCommerce\Component\DataSet\Request\DataSetRequestInterface $request )
getContextOptions ( array $contextOptions = [] ) : array
getEventName ( string $eventSuffix ) : string
getRequestOptions ( array $requestOptions = [] ) : array

Method Details

__construct() public method

AbstractDataSet constructor.

public __construct ( WellCommerce\Component\DataSet\Repository\DataSetAwareRepositoryInterface $repository, WellCommerce\Component\DataSet\Manager\DataSetManagerInterface $manager, Symfony\Component\EventDispatcher\EventDispatcherInterface $eventDispatcher )
$repository	WellCommerce\Component\DataSet\Repository\DataSetAwareRepositoryInterface
$manager	WellCommerce\Component\DataSet\Manager\DataSetManagerInterface
$eventDispatcher	Symfony\Component\EventDispatcher\EventDispatcherInterface

addColumn() public method

public addColumn ( WellCommerce\Component\DataSet\Column\ColumnInterface $column )
$column	WellCommerce\Component\DataSet\Column\ColumnInterface

configureOptions() abstract public method

abstract public configureOptions ( WellCommerce\Component\DataSet\Configurator\DataSetConfiguratorInterface $configurator )
$configurator	WellCommerce\Component\DataSet\Configurator\DataSetConfiguratorInterface

dispatchOnDataSetInitEvent() public method

public dispatchOnDataSetInitEvent ( )

getColumns() public method

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

getDataSetRequest() protected method

protected getDataSetRequest ( array $requestOptions = [] ) : WellCommerce\Component\DataSet\Request\DataSetRequestInterface
$requestOptions	array
return	WellCommerce\Component\DataSet\Request\DataSetRequestInterface

getDataSetTransformer() protected method

protected getDataSetTransformer ( string $type, array $options = [] ) : WellCommerce\Component\DataSet\Transformer\DataSetTransformerInterface
$type	string
$options	array
return	WellCommerce\Component\DataSet\Transformer\DataSetTransformerInterface

getQueryBuilder() protected method

protected getQueryBuilder ( WellCommerce\Component\DataSet\Request\DataSetRequestInterface $request ) : Doctrine\ORM\QueryBuilder
$request	WellCommerce\Component\DataSet\Request\DataSetRequestInterface
return	Doctrine\ORM\QueryBuilder

getResult() public method

public getResult ( string $contextType, array $requestOptions = [], array $contextOptions = [] ) : array
$contextType	string
$requestOptions	array
$contextOptions	array
return	array

setCacheOptions() public method

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

setColumns() public method

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

setDefaultContextOption() public method

public setDefaultContextOption ( string $name, $value )
$name	string

setDefaultRequestOption() public method

public setDefaultRequestOption ( string $name, $value )
$name	string

Property Details

$cacheOptions protected_oe property

protected CacheOptions,WellCommerce\Component\DataSet\Cache $cacheOptions
return	WellCommerce\Component\DataSet\Cache\CacheOptions

$columnTransformers protected_oe property

protected ColumnTransformerCollection,WellCommerce\Component\DataSet\Transformer $columnTransformers
return	WellCommerce\Component\DataSet\Transformer\ColumnTransformerCollection

$columns protected_oe property

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

$defaultContextOptions protected_oe property

protected array $defaultContextOptions
return	array

$defaultRequestOptions protected_oe property

protected array $defaultRequestOptions
return	array