Interface SortElementInformationInterface

Interface SortElementInformationInterface.

This interface describes a sort panel element information for sorting by properties.

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

Direct known implementers

DcGeneral\DataDefinition\Definition\View\Panel\DefaultSortElementInformation

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

Methods summary
`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`
`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`
`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`
`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`
`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`
`public string[]`	# `getPropertyNames( )` Retrieve the list of properties to allow search on. Retrieve the list of properties to allow search on. Returns `string[]`
`public integer`	# `getPropertyFlag( string $propertyName )` Get the flag to use for a property. Get the flag to use for a property. When a flag has been defined for a certain property that flag is being used otherwise the the default flag will get returned. Parameters `$propertyName` `string` $propertyName The name of the property. Returns `integer`

Methods inherited from DcGeneral\DataDefinition\Definition\View\Panel\ElementInformationInterface
`getName()`

Constants summary
`integer`	`SORTING_FLAG_NONE`	`0`	# Do not sort. Do not sort.
`integer`	`SORTING_FLAG_FIRST_LETTER_ASCENDING`	`1`	# Sort by initial letter ascending. Sort by initial letter ascending.
`integer`	`SORTING_FLAG_FIRST_LETTER_DESCENDING`	`2`	# Sort by initial letter descending. Sort by initial letter descending.
`integer`	`SORTING_FLAG_TWO_LETTERS_ASCENDING`	`3`	# Sort by initial two letters ascending. Sort by initial two letters ascending.
`integer`	`SORTING_FLAG_TWO_LETTERS_DESCENDING`	`4`	# Sort by initial two letters descending. Sort by initial two letters descending.
`integer`	`SORTING_FLAG_DATE_DAY_ASCENDING`	`5`	# Sort by day ascending. Sort by day ascending.
`integer`	`SORTING_FLAG_DATE_DAY_DESCENDING`	`6`	# Sort by day descending. Sort by day descending.
`integer`	`SORTING_FLAG_DATE_MONTH_ASCENDING`	`7`	# Sort by month ascending. Sort by month ascending.
`integer`	`SORTING_FLAG_DATE_MONTH_DESCENDING`	`8`	# Sort by month descending. Sort by month descending.
`integer`	`SORTING_FLAG_DATE_YEAR_ASCENDING`	`9`	# Sort by year ascending. Sort by year ascending.
`integer`	`SORTING_FLAG_DATE_YEAR_DESCENDING`	`10`	# Sort by year descending. Sort by year descending.
`integer`	`SORTING_FLAG_ASCENDING`	`11`	# Sort ascending. Sort ascending.
`integer`	`SORTING_FLAG_DESCENDING`	`12`	# Sort descending. Sort descending.

Namespaces

Classes

Interfaces

Interface SortElementInformationInterface

Direct known implementers

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns