GambioOrdersList
extends WidgetDefinition
in package
Class representing a widget showing a list of orders.
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.
- ID = 'GambioOrdersList'
- ID.
- TABLE_COLUMN_AMOUNT = 'amount'
- Amount column name.
- TABLE_COLUMN_CUSTOMER = 'customer'
- Customer column name.
- TABLE_COLUMN_DATE = 'date'
- Date column name.
- TABLE_COLUMN_STATUS = 'status'
- Status column name.
- TABLE_COLUMNS = [self::TABLE_COLUMN_CUSTOMER => [self::LANGUAGE_CODE_GERMAN => 'Kunde', self::LANGUAGE_CODE_ENGLISH => 'Customer'], self::TABLE_COLUMN_DATE => [self::LANGUAGE_CODE_GERMAN => 'Zeit', self::LANGUAGE_CODE_ENGLISH => 'Time'], self::TABLE_COLUMN_AMOUNT => [self::LANGUAGE_CODE_GERMAN => 'Summe', self::LANGUAGE_CODE_ENGLISH => 'Amount'], self::TABLE_COLUMN_STATUS => [self::LANGUAGE_CODE_GERMAN => 'Status', self::LANGUAGE_CODE_ENGLISH => 'Status']]
- Multilingual column titles.
- TABLE_DATE_COLUMN_DATE_INPUT_FORMAT = 'Y-m-d H:i:s'
- Date column input format.
- TABLE_DATE_COLUMN_DATE_OUTPUT_FORMAT = 'd.m.Y H:i'
- Date column output format.
- WIDGET_NAME = [self::LANGUAGE_CODE_GERMAN => 'Bestellungen (Liste)', self::LANGUAGE_CODE_ENGLISH => 'Orders (List)']
- Multilingual titles.
- $category : WidgetCategory
- Category.
- $connection : Connection
- Database connection.
- $factory : StatisticsOverviewFactory
- Factory.
- $id : WidgetId
- ID.
- $names : WidgetNames
- Multilingual titles.
- $numberFormatter : NumberFormatter
- Number formatter.
- $options : WidgetOptions
- Options.
- $userPreferences : UserPreferences
- User's preferences.
- $visualization : WidgetVisualization
- Visualization type.
- __construct() : mixed
- Constructor.
- 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.
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
ID
ID.
private
mixed
ID
= 'GambioOrdersList'
TABLE_COLUMN_AMOUNT
Amount column name.
private
mixed
TABLE_COLUMN_AMOUNT
= 'amount'
TABLE_COLUMN_CUSTOMER
Customer column name.
private
mixed
TABLE_COLUMN_CUSTOMER
= 'customer'
TABLE_COLUMN_DATE
Date column name.
private
mixed
TABLE_COLUMN_DATE
= 'date'
TABLE_COLUMN_STATUS
Status column name.
private
mixed
TABLE_COLUMN_STATUS
= 'status'
TABLE_COLUMNS
Multilingual column titles.
private
mixed
TABLE_COLUMNS
= [self::TABLE_COLUMN_CUSTOMER => [self::LANGUAGE_CODE_GERMAN => 'Kunde', self::LANGUAGE_CODE_ENGLISH => 'Customer'], self::TABLE_COLUMN_DATE => [self::LANGUAGE_CODE_GERMAN => 'Zeit', self::LANGUAGE_CODE_ENGLISH => 'Time'], self::TABLE_COLUMN_AMOUNT => [self::LANGUAGE_CODE_GERMAN => 'Summe', self::LANGUAGE_CODE_ENGLISH => 'Amount'], self::TABLE_COLUMN_STATUS => [self::LANGUAGE_CODE_GERMAN => 'Status', self::LANGUAGE_CODE_ENGLISH => 'Status']]
TABLE_DATE_COLUMN_DATE_INPUT_FORMAT
Date column input format.
private
mixed
TABLE_DATE_COLUMN_DATE_INPUT_FORMAT
= 'Y-m-d H:i:s'
TABLE_DATE_COLUMN_DATE_OUTPUT_FORMAT
Date column output format.
private
mixed
TABLE_DATE_COLUMN_DATE_OUTPUT_FORMAT
= 'd.m.Y H:i'
WIDGET_NAME
Multilingual titles.
private
mixed
WIDGET_NAME
= [self::LANGUAGE_CODE_GERMAN => 'Bestellungen (Liste)', self::LANGUAGE_CODE_ENGLISH => 'Orders (List)']
Properties
$category
Category.
private
WidgetCategory
$category
$connection
Database connection.
private
Connection
$connection
$factory
Factory.
private
StatisticsOverviewFactory
$factory
$id
ID.
private
WidgetId
$id
$names
Multilingual titles.
private
WidgetNames
$names
$numberFormatter
Number formatter.
private
NumberFormatter
$numberFormatter
$options
Options.
private
WidgetOptions
$options
$userPreferences
User's preferences.
private
UserPreferences
$userPreferences
$visualization
Visualization type.
private
WidgetVisualization
$visualization
Methods
__construct()
Constructor.
public
__construct(StatisticsOverviewFactory $factory, UserPreferences $userPreferences, Connection $connection, NumberFormatter $numberFormatter) : mixed
Parameters
- $factory : StatisticsOverviewFactory
- $userPreferences : UserPreferences
- $connection : Connection
- $numberFormatter : NumberFormatter
Tags
Return values
mixed —category()
Return category.
public
category() : WidgetCategory
Return values
WidgetCategory —Category.
data()
Return data.
public
data(WidgetOptions $options) : WidgetData
Parameters
- $options : WidgetOptions
-
Widget's options.
Tags
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.