Interface SearchElementInterface
This interface describes a search panel element.
-
DcGeneral\Panel\SearchElementInterface
implements
DcGeneral\Panel\PanelElementInterface
Methods summary
public
DcGeneral\Panel\SearchElementInterface
|
#
addProperty( string $strProperty )
Add a property that can be searched.
Add a property that can be searched.
Parameters
- $strProperty
string $strProperty The property to allow to search on.
Returns
|
public
string[]
|
#
getPropertyNames( )
Retrieve the list of properties to allow search on.
Retrieve the list of properties to allow search on.
Returns
string[]
|
public
DcGeneral\Panel\SearchElementInterface
|
#
setSelectedProperty( string $strProperty = '' )
This activates a property for search.
This activates a property for search.
Parameters
- $strProperty
string $strProperty The property to activate search on.
Returns
|
public
string
|
#
getSelectedProperty( )
Retrieves the property currently defined to be searched on.
Retrieves the property currently defined to be searched on.
Returns
string
|
public
DcGeneral\Panel\SearchElementInterface
|
#
setValue( string $mixValue = null )
Set the value to search for.
Set the value to search for.
Parameters
- $mixValue
string $mixValue The value to search for.
Returns
|
public
string
|
#
getValue( )
Retrieve the value to be searched for.
Retrieve the value to be searched for.
Returns
string
|