Overview

Namespaces

  • DSchoenbauer
    • Orm
      • Builder
      • Entity
      • Enum
      • Events
        • Persistence
        • Validate
          • DataType
          • Schema
      • Exception
      • Framework

Classes

  • AbstractEntity

Interfaces

  • EntityInterface
  • HasBoolFieldsInterface
  • HasDateFieldsInterface
  • HasDateWithCustomFormatInterface
  • HasDefaultValuesInterface
  • HasFilterInterface
  • HasNumericFieldsInterface
  • HasRequiredFieldsInterface
  • HasStaticValuesInterface
  • HasStringFieldsInterface
  • IsSortableInterface
  • Overview
  • Namespace
  • Class

Interface IsSortableInterface

provides a way to define whish fields of an entity are sortable

Namespace: DSchoenbauer\Orm\Entity
Author: David Schoenbauer d.schoenbauer@ctimeetingtech.com
Located at Orm/Entity/IsSortableInterface.php
Methods summary
public array
# getSortFields( )

provides a list of fields that can be sorted

provides a list of fields that can be sorted

Returns

array
an array of fields that can be sorted

Since

v1.0.0
public string
# getDefaultSortField( )

provides a the default field to sort on

provides a the default field to sort on

Returns

string

if no field is provided by the user this field will define which field should be sorted on

Since

v1.0.0
public string
# getDefaultSortDirection( )

defines a default sort order

defines a default sort order

Returns

string
returns either IsSortableInterface::SORT_ASCENDING or IsSortableInterface::SORT_DESCENDING

Since

v1.0.0
Constants summary
string SORT_ASCENDING
# "ASC"
string SORT_DESCENDING
# "DESC"
API documentation generated by ApiGen