Class DefaultSortElement

Default implementation of a sort element.

DcGeneral\Panel\AbstractElement implements DcGeneral\Panel\PanelElementInterface

Extended by

DcGeneral\Panel\DefaultSortElement implements DcGeneral\Panel\SortElementInterface

Namespace: DcGeneral\Panel
Package: DcGeneral\Panel
Located at Panel/DefaultSortElement.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 )` Store the persistent value in the input provider. Store the persistent value in the input provider. Parameters `$strProperty` `string` $strProperty The name of the property to sort by.
`protected integer`	# `lookupFlag( string $strProperty )` Retrieve the sorting flag to use for a property. Retrieve the sorting flag to use for a property. Parameters `$strProperty` `string` $strProperty The property. Returns `integer`
`protected string`	# `flagToDirection( integer $intFlag )` Calculate the direction from a flag. Calculate the direction from a flag. Parameters `$intFlag` `integer` $intFlag The flag. Returns `string`
`protected array`	# `getAdditionalSorting( )` Retrieve the additional sorting properties from the data definition. Retrieve the additional sorting properties from the data definition. Returns `array`
`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`	# `setDefaultFlag( integer $intFlag )` Set the default flag to use when no flag has been defined for a certain property. Set the default flag to use when no flag has been defined for a certain property. Parameters `$intFlag` `integer` $intFlag The flag to use. Returns `DcGeneral\Panel\SearchElementInterface` Implementation of `DcGeneral\Panel\SortElementInterface::setDefaultFlag()`
`public integer`	# `getDefaultFlag( )` Get the default flag to use when no flag has been defined for a certain property. Get the default flag to use when no flag has been defined for a certain property. Returns `integer` Implementation of `DcGeneral\Panel\SortElementInterface::getDefaultFlag()`
`public mixed`	# `addProperty( string $strPropertyName, integer $intFlag )` Add a property for sorting. Add a property for sorting. Parameters `$strPropertyName` `string` $strPropertyName The property name to enable sorting for. `$intFlag` `integer` $intFlag The flag to use for sorting. Returns `mixed` Implementation of `DcGeneral\Panel\SortElementInterface::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\SortElementInterface::getPropertyNames()`
`public mixed`	# `setSelected( string $strPropertyName )` Set the selected property for sorting. Set the selected property for sorting. Parameters `$strPropertyName` `string` $strPropertyName The property name to mark as selected. Returns `mixed` Implementation of `DcGeneral\Panel\SortElementInterface::setSelected()`
`public string`	# `getSelected( )` Return the name of the currently selected property. Return the name of the currently selected property. Returns `string` Implementation of `DcGeneral\Panel\SortElementInterface::getSelected()`
`public integer`	# `getFlag( )` Return the flag of the currently selected property. Return the flag of the currently selected property. Returns `integer` Implementation of `DcGeneral\Panel\SortElementInterface::getFlag()`

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

Properties summary
`public integer`	`$intDefaultFlag`		# The default flag to use. The default flag to use.
`protected array`	`$arrSorting`	`array()`	# The sorting properties including the direction. The sorting properties including the direction.
`protected mixed`	`$strSelected`		# The selected sorting value. The selected sorting value.

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