contao-community-alliance/dc-general
Back to top  

This interface describes a search panel element.

 Methods

Add a property that can be searched.

addProperty(string $strProperty) : \ContaoCommunityAlliance\DcGeneral\Panel\SearchElementInterface

Parameters

$strProperty

string

The property to allow to search on.

Returns

\ContaoCommunityAlliance\DcGeneral\Panel\SearchElementInterface

Retrieve the list of properties to allow search on.

getPropertyNames() : string[]

Returns

string[]

Retrieves the property currently defined to be searched on.

getSelectedProperty() : string

Returns

string

Retrieve the value to be searched for.

getValue() : string

Returns

string

This activates a property for search.

setSelectedProperty(string $strProperty) : \ContaoCommunityAlliance\DcGeneral\Panel\SearchElementInterface

Parameters

$strProperty

string

The property to activate search on.

Returns

\ContaoCommunityAlliance\DcGeneral\Panel\SearchElementInterface

Set the value to search for.

setValue(string $mixValue) : \ContaoCommunityAlliance\DcGeneral\Panel\SearchElementInterface

Parameters

$mixValue

string

The value to search for.

Returns

\ContaoCommunityAlliance\DcGeneral\Panel\SearchElementInterface