PHP Класс MetaModels\Filter\Setting\SimpleLookup

Наследование: extends Simple

Открытые методы

Метод	Описание
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 )

Метод	Описание
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.

Determine if this filter setting shall return all matches if no url param has been specified.

public allowEmpty ( ) : boolean
Результат	boolean	true if all matches shall be returned, false otherwise.

Determine if this filter setting shall be available for frontend filter widget generating.

public enableFEFilterWidget ( ) : boolean
Результат	boolean	true if available, false otherwise.

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

Retrieve the attribute we are filtering on.

protected getFilteredAttribute ( ) : MetaModels\Attribute\IAttribute \| null
Результат	MetaModels\Attribute\IAttribute \| null

Return the label to use.

protected getLabel ( ) : string \| null
Результат	string \| null

Retrieve the filter parameter name to react on.

protected getParamName ( ) : string \| null
Результат	string \| null

public getParameterDCA ( )

public getParameterFilterNames ( )

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.
Результат	array

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

public getParameters ( )

public getReferencedAttributes ( )

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