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 ) |
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. |
public allowEmpty ( ) : boolean | ||
return | boolean | true if all matches shall be returned, false otherwise. |
public enableFEFilterWidget ( ) : boolean | ||
return | boolean | true if available, false otherwise. |
public generateFilterUrlFrom ( MetaModels\IItem $objItem, MetaModels\Render\Setting\ICollection $objRenderSetting ) | ||
$objItem | MetaModels\IItem | |
$objRenderSetting | MetaModels\Render\Setting\ICollection |
protected getFilteredAttribute ( ) : MetaModels\Attribute\IAttribute | null | ||
return | MetaModels\Attribute\IAttribute | null |
protected getParamName ( ) : string | null | ||
return | string | null |
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 |
public getParameterFilterWidgets ( $arrIds, $arrFilterUrl, $arrJumpTo, MetaModels\FrontendIntegration\FrontendFilterOptions $objFrontendFilterOptions ) | ||
$objFrontendFilterOptions | MetaModels\FrontendIntegration\FrontendFilterOptions |
public prepareRules ( MetaModels\Filter\IFilter $objFilter, $arrFilterUrl ) | ||
$objFilter | MetaModels\Filter\IFilter |