PHP 클래스 MetaModels\Filter\Setting\SimpleLookup

상속: extends Simple
파일 보기 프로젝트 열기: metamodels/core

공개 메소드들

메소드 설명
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.

메소드 상세

allowEmpty() 공개 메소드

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.

enableFEFilterWidget() 공개 메소드

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

generateFilterUrlFrom() 공개 메소드

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

getFilteredAttribute() 보호된 메소드

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

getLabel() 보호된 메소드

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

getParamName() 보호된 메소드

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

getParameterDCA() 공개 메소드

public getParameterDCA ( )

getParameterFilterNames() 공개 메소드

getParameterFilterOptions() 보호된 메소드

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

getParameterFilterWidgets() 공개 메소드

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

getParameters() 공개 메소드

public getParameters ( )

getReferencedAttributes() 공개 메소드

prepareRules() 공개 메소드

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