ViewOptionSortItem
extends ViewOption
in package
Uses
ElementTrait
This is the 'ViewOptionSortItem' class, a DTO class for the theme configuration data.
The items stored in this class will remain immutable (only get methods are available).
This class extends SDK\Core\Dtos\Element, see this class.
Tags
Table of Contents
| ASC | = 'asc' | |
|---|---|---|
| DESC | = 'desc' | |
| ENABLED | = 'enabled' | |
| SHOW_LABEL | = 'showLabel' | |
| SORTS | = 'sorts' | |
| VIEW_PRIORITY | = 'viewPriority' | |
| $enabled | : bool | |
| $showLabel | : bool | |
| $viewPriority | : int | |
| getAsc() | This method returns if ascending is enabled. | : bool |
| getDesc() | This method returns if descending is enabled. | : bool |
| getEnabled() | This method returns if the view option is enabled. | : bool |
| getShowLabel() | This method returns if the head label is enabled. | : bool |
| getSorts() | This method returns the applicable sorts. | : array<string|int, mixed> |
| getViewPriority() | This method returns the item view priority. | : int |
Constants
ASC
public
mixed
ASC
= 'asc'
DESC
public
mixed
DESC
= 'desc'
ENABLED
public
mixed
ENABLED
= 'enabled'
SHOW_LABEL
public
mixed
SHOW_LABEL
= 'showLabel'
SORTS
public
mixed
SORTS
= 'sorts'
VIEW_PRIORITY
public
mixed
VIEW_PRIORITY
= 'viewPriority'
Properties
$enabled
protected
bool
$enabled
= false
$showLabel
protected
bool
$showLabel
= false
$viewPriority
protected
int
$viewPriority
= 0
Methods
getAsc()
This method returns if ascending is enabled.
public
getAsc() : bool
Return values
bool —getDesc()
This method returns if descending is enabled.
public
getDesc() : bool
Return values
bool —getEnabled()
This method returns if the view option is enabled.
public
getEnabled() : bool
Return values
bool —getShowLabel()
This method returns if the head label is enabled.
public
getShowLabel() : bool
Return values
bool —getSorts()
This method returns the applicable sorts.
public
getSorts() : array<string|int, mixed>
Return values
array<string|int, mixed> —getViewPriority()
This method returns the item view priority.
public
getViewPriority() : int