WidgetDefinition
in package
Class representing a widget definition.
Table of Contents
- DATA_QUERY_TIMESPAN_FORMAT_END = 'Y-m-d 23:59:59'
- Date and time format for the end of a time range used for database queries.
- DATA_QUERY_TIMESPAN_FORMAT_START = 'Y-m-d 00:00:00'
- Date and time format for the beginning of a time range used for database queries.
- EXCLUDED_ORDER_STATUS_IDS = [99]
- Order status IDs to be excluded from SQL queries.
- LANGUAGE_CODE_ENGLISH = 'en'
- English language code.
- LANGUAGE_CODE_GERMAN = 'de'
- German language code.
- LANGUAGE_ID_GERMAN = 2
- German language ID.
- $category : WidgetCategory
- Category.
- $id : WidgetId
- ID.
- $names : WidgetNames
- Multilingual titles.
- $options : WidgetOptions
- Options.
- $visualization : WidgetVisualization
- Visualization type.
- category() : WidgetCategory
- Return category.
- data() : WidgetData
- Return data.
- id() : WidgetId
- Return ID.
- names() : WidgetNames
- Return multilingual titles.
- options() : WidgetOptions
- Return options.
- visualization() : WidgetVisualization
- Return visualization type.
- __construct() : mixed
- Constructor.
Constants
DATA_QUERY_TIMESPAN_FORMAT_END
Date and time format for the end of a time range used for database queries.
protected
mixed
DATA_QUERY_TIMESPAN_FORMAT_END
= 'Y-m-d 23:59:59'
DATA_QUERY_TIMESPAN_FORMAT_START
Date and time format for the beginning of a time range used for database queries.
protected
mixed
DATA_QUERY_TIMESPAN_FORMAT_START
= 'Y-m-d 00:00:00'
EXCLUDED_ORDER_STATUS_IDS
Order status IDs to be excluded from SQL queries.
protected
mixed
EXCLUDED_ORDER_STATUS_IDS
= [99]
LANGUAGE_CODE_ENGLISH
English language code.
protected
mixed
LANGUAGE_CODE_ENGLISH
= 'en'
LANGUAGE_CODE_GERMAN
German language code.
protected
mixed
LANGUAGE_CODE_GERMAN
= 'de'
LANGUAGE_ID_GERMAN
German language ID.
protected
mixed
LANGUAGE_ID_GERMAN
= 2
Properties
$category
Category.
private
WidgetCategory
$category
$id
ID.
private
WidgetId
$id
$names
Multilingual titles.
private
WidgetNames
$names
$options
Options.
private
WidgetOptions
$options
$visualization
Visualization type.
private
WidgetVisualization
$visualization
Methods
category()
Return category.
public
category() : WidgetCategory
Return values
WidgetCategory —Category.
data()
Return data.
public
abstract data(WidgetOptions $options) : WidgetData
Parameters
- $options : WidgetOptions
-
Widget's options.
Return values
WidgetData —Data.
id()
Return ID.
public
id() : WidgetId
Return values
WidgetId —ID.
names()
Return multilingual titles.
public
names() : WidgetNames
Return values
WidgetNames —Multilingual titles.
options()
Return options.
public
options() : WidgetOptions
Return values
WidgetOptions —Options.
visualization()
Return visualization type.
public
visualization() : WidgetVisualization
Return values
WidgetVisualization —Visualization type.
__construct()
Constructor.
protected
__construct(WidgetId $id, WidgetNames $names, WidgetCategory $category, WidgetVisualization $visualization, WidgetOptions $options) : mixed
Parameters
- $id : WidgetId
-
ID.
- $names : WidgetNames
-
Multilingual titles.
- $category : WidgetCategory
-
Category.
- $visualization : WidgetVisualization
-
Visualization type.
- $options : WidgetOptions
-
Options.