ItemList
extends Element
in package
Uses
ElementTrait
This is the 'ItemList' 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
| APPLICABLE_FILTERS | = 'applicableFilters' | |
|---|---|---|
| DEFAULT_PARAMETERS_VALUES | = 'defaultParametersValues' | |
| PAGINATION | = 'pagination' | |
| REQUEST_PARAMETERS | = 'requestParameters' | |
| VIEW_OPTIONS | = 'viewOptions' | |
| getApplicableFilters() | This method returns the applicable filters | : ApplicableFilters|null |
| getDefaultParametersValues() | This method returns the default values to apply in the list request. | : array<string|int, mixed> |
| getPagination() | This method returns the pagination configuration. | : Pagination|null |
| getRequestParameters() | This method returns the parameters to be applied in the request. | : array<string|int, mixed> |
| getViewOptions() | This method returns the view options to apply in the views section. | : ViewOptions|null |
Constants
APPLICABLE_FILTERS
public
mixed
APPLICABLE_FILTERS
= 'applicableFilters'
DEFAULT_PARAMETERS_VALUES
public
mixed
DEFAULT_PARAMETERS_VALUES
= 'defaultParametersValues'
PAGINATION
public
mixed
PAGINATION
= 'pagination'
REQUEST_PARAMETERS
public
mixed
REQUEST_PARAMETERS
= 'requestParameters'
VIEW_OPTIONS
public
mixed
VIEW_OPTIONS
= 'viewOptions'
Methods
getApplicableFilters()
This method returns the applicable filters
public
getApplicableFilters() : ApplicableFilters|null
Return values
ApplicableFilters|null —getDefaultParametersValues()
This method returns the default values to apply in the list request.
public
getDefaultParametersValues() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPagination()
This method returns the pagination configuration.
public
getPagination() : Pagination|null
Return values
Pagination|null —getRequestParameters()
This method returns the parameters to be applied in the request.
public
getRequestParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getViewOptions()
This method returns the view options to apply in the views section.
public
getViewOptions() : ViewOptions|null