Overview

Namespaces

  • DcGeneral
    • Clipboard
    • Contao
      • Callback
      • Compatibility
      • DataDefinition
        • Definition
      • Dca
        • Builder
          • Legacy
        • Definition
        • Palette
        • Populator
      • Event
      • View
        • Contao2BackendView
          • Event
    • Controller
    • Data
    • DataDefinition
      • Builder
      • Definition
        • Properties
        • View
          • Panel
      • ModelRelationship
      • Palette
        • Builder
          • Event
        • Condition
          • Palette
          • Property
    • EnvironmentPopulator
    • Event
    • Exception
    • Factory
      • Event
    • Panel
    • View
      • Event

Classes

  • AbstractElement
  • DefaultFilterElement
  • DefaultLimitElement
  • DefaultPanel
  • DefaultPanelContainer
  • DefaultSearchElement
  • DefaultSortElement
  • DefaultSubmitElement

Interfaces

  • FilterElementInterface
  • LimitElementInterface
  • PanelContainerInterface
  • PanelElementInterface
  • PanelInterface
  • SearchElementInterface
  • SortElementInterface
  • SubmitElementInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Interface SortElementInterface

This interface describes a sort panel element.

DcGeneral\Panel\SortElementInterface implements DcGeneral\Panel\PanelElementInterface

Direct known implementers

DcGeneral\Panel\DefaultSortElement
Namespace: DcGeneral\Panel
Package: DcGeneral\Panel
Located at Panel/SortElementInterface.php
Methods summary
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
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 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
public string[]
# getPropertyNames( )

Retrieve the list of properties to allow search on.

Retrieve the list of properties to allow search on.

Returns

string[]
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
public string
# getSelected( )

Return the name of the currently selected property.

Return the name of the currently selected property.

Returns

string
public integer
# getFlag( )

Return the flag of the currently selected property.

Return the flag of the currently selected property.

Returns

integer
Methods inherited from DcGeneral\Panel\PanelElementInterface
getPanel(), initialize(), render(), setPanel()
contao-community-alliance/dc-general API documentation generated by ApiGen 2.8.0