ViewOptionSort
extends ViewOption
in package
Uses
ElementTrait
This is the 'ViewOptionSort' 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
| ENABLED | = 'enabled' | |
|---|---|---|
| ITEMS | = 'items' | |
| SHOW_LABEL | = 'showLabel' | |
| VIEW_PRIORITY | = 'viewPriority' | |
| $enabled | : bool | |
| $showLabel | : bool | |
| $viewPriority | : int | |
| getEnabled() | This method returns if the view option is enabled. | : bool |
| getItems() | This method returns the available items to show. | : ViewOptionSortItems|null |
| getShowLabel() | This method returns if the head label is enabled. | : bool |
| getViewPriority() | This method returns the item view priority. | : int |
Constants
ENABLED
public
mixed
ENABLED
= 'enabled'
ITEMS
public
mixed
ITEMS
= 'items'
SHOW_LABEL
public
mixed
SHOW_LABEL
= 'showLabel'
VIEW_PRIORITY
public
mixed
VIEW_PRIORITY
= 'viewPriority'
Properties
$enabled
protected
bool
$enabled
= false
$showLabel
protected
bool
$showLabel
= false
$viewPriority
protected
int
$viewPriority
= 0
Methods
getEnabled()
This method returns if the view option is enabled.
public
getEnabled() : bool
Return values
bool —getItems()
This method returns the available items to show.
public
getItems() : ViewOptionSortItems|null
Return values
ViewOptionSortItems|null —getShowLabel()
This method returns if the head label is enabled.
public
getShowLabel() : bool
Return values
bool —getViewPriority()
This method returns the item view priority.
public
getViewPriority() : int