Class DefaultSortElementInformation

Class DefaultSortElementInformation.

Default implementation of a sort definition on properties.

DcGeneral\DataDefinition\Definition\View\Panel\DefaultSortElementInformation implements DcGeneral\DataDefinition\Definition\View\Panel\SortElementInformationInterface

Namespace: DcGeneral\DataDefinition\Definition\View\Panel
Package: DcGeneral\DataDefinition\Definition\View\Panel
Located at DataDefinition/Definition/View/Panel/DefaultSortElementInformation.php

Methods summary
`public string`	# `getName( )` The name of the element. The name of the element. Returns `string` Implementation of `DcGeneral\DataDefinition\Definition\View\Panel\ElementInformationInterface::getName()`
`public DcGeneral\DataDefinition\Definition\View\Panel\SortElementInformationInterface`	# `setDefaultFlag( integer $flag )` 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 `$flag` `integer` $flag The flag to use. Returns `DcGeneral\DataDefinition\Definition\View\Panel\SortElementInformationInterface` Implementation of `DcGeneral\DataDefinition\Definition\View\Panel\SortElementInformationInterface::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\DataDefinition\Definition\View\Panel\SortElementInformationInterface::getDefaultFlag()`
`public DcGeneral\DataDefinition\Definition\View\Panel\SortElementInformationInterface`	# `addProperty( string $propertyName, integer $flag = 0 )` Add a property for sorting. Add a property for sorting. Parameters `$propertyName` `string` $propertyName The name of the property. `$flag` `integer` $flag If the default of 0 is passed, the default flag will get used. Returns `DcGeneral\DataDefinition\Definition\View\Panel\SortElementInformationInterface` Implementation of `DcGeneral\DataDefinition\Definition\View\Panel\SortElementInformationInterface::addProperty()`
`public DcGeneral\DataDefinition\Definition\View\Panel\SortElementInformationInterface`	# `hasProperty( string $propertyName )` Determine if the given property has been marked for sorting in the element. Determine if the given property has been marked for sorting in the element. Parameters `$propertyName` `string` $propertyName The name of the property. Returns `DcGeneral\DataDefinition\Definition\View\Panel\SortElementInformationInterface` Implementation of `DcGeneral\DataDefinition\Definition\View\Panel\SortElementInformationInterface::hasProperty()`
`public DcGeneral\DataDefinition\Definition\View\Panel\SortElementInformationInterface`	# `removeProperty( string $propertyName )` Determine if the given property has been marked for sorting in the element. Determine if the given property has been marked for sorting in the element. Parameters `$propertyName` `string` $propertyName The name of the property. Returns `DcGeneral\DataDefinition\Definition\View\Panel\SortElementInformationInterface` Implementation of `DcGeneral\DataDefinition\Definition\View\Panel\SortElementInformationInterface::removeProperty()`
`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\DataDefinition\Definition\View\Panel\SortElementInformationInterface::getPropertyNames()`
`public integer`	# `getPropertyFlag( string $propertyName )` Get the flag to use for a property. Get the flag to use for a property. Parameters `$propertyName` `string` $propertyName The name of the property. Returns `integer` Implementation of `DcGeneral\DataDefinition\Definition\View\Panel\SortElementInformationInterface::getPropertyFlag()`

Constants inherited from DcGeneral\DataDefinition\Definition\View\Panel\SortElementInformationInterface
`SORTING_FLAG_ASCENDING, SORTING_FLAG_DATE_DAY_ASCENDING, SORTING_FLAG_DATE_DAY_DESCENDING, SORTING_FLAG_DATE_MONTH_ASCENDING, SORTING_FLAG_DATE_MONTH_DESCENDING, SORTING_FLAG_DATE_YEAR_ASCENDING, SORTING_FLAG_DATE_YEAR_DESCENDING, SORTING_FLAG_DESCENDING, SORTING_FLAG_FIRST_LETTER_ASCENDING, SORTING_FLAG_FIRST_LETTER_DESCENDING, SORTING_FLAG_NONE, SORTING_FLAG_TWO_LETTERS_ASCENDING, SORTING_FLAG_TWO_LETTERS_DESCENDING`

Properties summary
`protected array`	`$properties`	`array()`	# The names of the properties to be sortable. The names of the properties to be sortable.
`protected string`	`$defaultFlag`	`DcGeneral\DataDefinition\Definition\View\Panel\SortElementInformationInterface::SORTING_FLAG_NONE`	# The sorting flag to use by default. The sorting flag to use by default.

Namespaces

Classes

Interfaces

Class DefaultSortElementInformation

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of