Class DefaultSearchElement

Default implementation of a search panel element.

DcGeneral\Panel\AbstractElement implements DcGeneral\Panel\PanelElementInterface

Extended by

DcGeneral\Panel\DefaultSearchElement implements DcGeneral\Panel\SearchElementInterface

Namespace: DcGeneral\Panel
Package: DcGeneral\Panel
Located at Panel/DefaultSearchElement.php

Methods summary
`protected array`	# `getPersistent( )` Retrieve the persistent value from the input provider. Retrieve the persistent value from the input provider. Returns `array`
`protected`	# `setPersistent( string $strProperty, string $strValue )` Store the persistent value in the input provider. Store the persistent value in the input provider. Parameters `$strProperty` `string` $strProperty The property being searched on. `$strValue` `string` $strValue The value being searched for.
`public`	# `initialize( DcGeneral\Data\ConfigInterface $objConfig, DcGeneral\Panel\PanelElementInterface $objElement = null )` Initialize the passed configuration with the values of the element. Initialize the passed configuration with the values of the element. Parameters `$objConfig` `DcGeneral\Data\ConfigInterface` $objConfig The config to which the initialization shall be applied to. `$objElement` `DcGeneral\Panel\PanelElementInterface` $objElement The element to be initialized (if any). Implementation of `DcGeneral\Panel\PanelElementInterface::initialize()`
`public DcGeneral\Panel\PanelElementInterface`	# `render( DcGeneral\View\ViewTemplateInterface $objTemplate )` Render the element using the given Template. Render the element using the given Template. Parameters `$objTemplate` `DcGeneral\View\ViewTemplateInterface` $objTemplate The Template to use. Returns `DcGeneral\Panel\PanelElementInterface` Implementation of `DcGeneral\Panel\PanelElementInterface::render()`
`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 `DcGeneral\Panel\SearchElementInterface` Implementation of `DcGeneral\Panel\SearchElementInterface::addProperty()`
`public string[]`	# `getPropertyNames( )` Retrieve the list of properties to allow search on. Retrieve the list of properties to allow search on. Returns `string[]` Implementation of `DcGeneral\Panel\SearchElementInterface::getPropertyNames()`
`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 `DcGeneral\Panel\SearchElementInterface` Implementation of `DcGeneral\Panel\SearchElementInterface::setSelectedProperty()`
`public string`	# `getSelectedProperty( )` Retrieves the property currently defined to be searched on. Retrieves the property currently defined to be searched on. Returns `string` Implementation of `DcGeneral\Panel\SearchElementInterface::getSelectedProperty()`
`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 `DcGeneral\Panel\SearchElementInterface` Implementation of `DcGeneral\Panel\SearchElementInterface::setValue()`
`public string`	# `getValue( )` Retrieve the value to be searched for. Retrieve the value to be searched for. Returns `string` Implementation of `DcGeneral\Panel\SearchElementInterface::getValue()`

Methods inherited from DcGeneral\Panel\AbstractElement
`getEnvironment(), getInputProvider(), getOtherConfig(), getPanel(), setPanel()`

Properties summary
`protected array`	`$arrProperties`		# The properties to be allowed to be searched on. The properties to be allowed to be searched on.
`protected string`	`$strSelectedProperty`		# The currently active property to be searched on. The currently active property to be searched on.
`protected mixed`	`$mixValue`		# The current value to be searched. The current value to be searched.

Properties inherited from DcGeneral\Panel\AbstractElement
`$objPanel`