PHP Class MetaModels\Filter\Setting\SimpleLookup

Inheritance: extends Simple
Show file Open project: metamodels/core

Public Methods

Method Description
allowEmpty ( ) : boolean Determine if this filter setting shall return all matches if no url param has been specified.
enableFEFilterWidget ( ) : boolean Determine if this filter setting shall be available for frontend filter widget generating.
generateFilterUrlFrom ( MetaModels\IItem $objItem, MetaModels\Render\Setting\ICollection $objRenderSetting )
getParameterDCA ( )
getParameterFilterNames ( )
getParameterFilterWidgets ( $arrIds, $arrFilterUrl, $arrJumpTo, MetaModels\FrontendIntegration\FrontendFilterOptions $objFrontendFilterOptions )
getParameters ( )
getReferencedAttributes ( )
prepareRules ( MetaModels\Filter\IFilter $objFilter, $arrFilterUrl )

Protected Methods

Method Description
getFilteredAttribute ( ) : MetaModels\Attribute\IAttribute | null Retrieve the attribute we are filtering on.
getLabel ( ) : string | null Return the label to use.
getParamName ( ) : string | null Retrieve the filter parameter name to react on.
getParameterFilterOptions ( MetaModels\Attribute\IAttribute $objAttribute, string[] | null $arrIds, array &$arrCount = null ) : array Internal helper function for descendant classes to retrieve the options.

Method Details

allowEmpty() public method

Determine if this filter setting shall return all matches if no url param has been specified.
public allowEmpty ( ) : boolean
return boolean true if all matches shall be returned, false otherwise.

enableFEFilterWidget() public method

Determine if this filter setting shall be available for frontend filter widget generating.
public enableFEFilterWidget ( ) : boolean
return boolean true if available, false otherwise.

generateFilterUrlFrom() public method

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

getFilteredAttribute() protected method

Retrieve the attribute we are filtering on.
protected getFilteredAttribute ( ) : MetaModels\Attribute\IAttribute | null
return MetaModels\Attribute\IAttribute | null

getLabel() protected method

Return the label to use.
protected getLabel ( ) : string | null
return string | null

getParamName() protected method

Retrieve the filter parameter name to react on.
protected getParamName ( ) : string | null
return string | null

getParameterDCA() public method

public getParameterDCA ( )

getParameterFilterNames() public method

public getParameterFilterNames ( )

getParameterFilterOptions() protected method

Internal helper function for descendant classes to retrieve the options.
protected getParameterFilterOptions ( MetaModels\Attribute\IAttribute $objAttribute, string[] | null $arrIds, array &$arrCount = null ) : array
$objAttribute MetaModels\Attribute\IAttribute The attribute to search.
$arrIds string[] | null The Id list of items for which to retrieve the options.
$arrCount array If non null, the amount of matches will get returned.
return array

getParameterFilterWidgets() public method

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

getParameters() public method

public getParameters ( )

getReferencedAttributes() public method

public getReferencedAttributes ( )

prepareRules() public method

public prepareRules ( MetaModels\Filter\IFilter $objFilter, $arrFilterUrl )
$objFilter MetaModels\Filter\IFilter