PHP Class MetaModels\Filter\Setting\Collection

Inheritance: implements MetaModels\Filter\Setting\ICollection
Show file Open project: metamodels/core Class Usage Examples

Protected Properties

Property Type Description
$arrData array The additional meta data for this filter setting collection.
$arrSettings MetaModels\Filter\Setting\ISimple[] The filter settings contained.
$metaModel MetaModels\IMetaModel The attached MetaModel.

Public Methods

Method Description
__construct ( array $arrData ) Create a new instance.
addRules ( MetaModels\Filter\IFilter $objFilter, $arrFilterUrl, $arrIgnoredFilter = [] )
addSetting ( MetaModels\Filter\Setting\ISimple | MetaModels\Filter\Setting\IWithChildren $setting ) : Collection Add a setting to the collection.
generateFilterUrlFrom ( MetaModels\IItem $objItem, MetaModels\Render\Setting\ICollection $objRenderSetting )
get ( $key )
getMetaModel ( ) : MetaModels\IMetaModel Retrieve the MetaModel this filter belongs to.
getParameterDCA ( )
getParameterFilterNames ( )
getParameterFilterWidgets ( $arrFilterUrl, $arrJumpTo, MetaModels\FrontendIntegration\FrontendFilterOptions $objFrontendFilterOptions )
getParameters ( )
getReferencedAttributes ( )
setMetaModel ( MetaModels\IMetaModel $metaModel ) : Collection Set the MetaModel.

Method Details

__construct() public method

Create a new instance.
public __construct ( array $arrData )
$arrData array The meta data for this filter setting collection.

addRules() public method

public addRules ( MetaModels\Filter\IFilter $objFilter, $arrFilterUrl, $arrIgnoredFilter = [] )
$objFilter MetaModels\Filter\IFilter

addSetting() public method

Add a setting to the collection.
public addSetting ( MetaModels\Filter\Setting\ISimple | MetaModels\Filter\Setting\IWithChildren $setting ) : Collection
$setting MetaModels\Filter\Setting\ISimple | MetaModels\Filter\Setting\IWithChildren The setting to add.
return Collection

generateFilterUrlFrom() public method

public generateFilterUrlFrom ( MetaModels\IItem $objItem, MetaModels\Render\Setting\ICollection $objRenderSetting )
$objItem MetaModels\IItem
$objRenderSetting MetaModels\Render\Setting\ICollection

get() public method

public get ( $key )

getMetaModel() public method

Retrieve the MetaModel this filter belongs to.
public getMetaModel ( ) : MetaModels\IMetaModel
return MetaModels\IMetaModel

getParameterDCA() public method

public getParameterDCA ( )

getParameterFilterNames() public method

public getParameterFilterNames ( )

getParameterFilterWidgets() public method

public getParameterFilterWidgets ( $arrFilterUrl, $arrJumpTo, MetaModels\FrontendIntegration\FrontendFilterOptions $objFrontendFilterOptions )
$objFrontendFilterOptions MetaModels\FrontendIntegration\FrontendFilterOptions

getParameters() public method

public getParameters ( )

getReferencedAttributes() public method

public getReferencedAttributes ( )

setMetaModel() public method

Set the MetaModel.
public setMetaModel ( MetaModels\IMetaModel $metaModel ) : Collection
$metaModel MetaModels\IMetaModel The MetaModel instance.
return Collection

Property Details

$arrData protected property

The additional meta data for this filter setting collection.
protected array $arrData
return array

$arrSettings protected property

The filter settings contained.
protected ISimple[],MetaModels\Filter\Setting $arrSettings
return MetaModels\Filter\Setting\ISimple[]

$metaModel protected property

The attached MetaModel.
protected IMetaModel,MetaModels $metaModel
return MetaModels\IMetaModel