phpDocumentor

GambioOrdersRegionsOverview extends WidgetDefinition
in package

Class representing a widget showing orders grouped by regions.

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  = 'GambioOrdersRegionsOverview'
ID.
REGION_DROPDOWN_CITY_ITEM  = "city"
City as item for region dropdown.
REGION_DROPDOWN_COUNTRY_ITEM  = "country_code"
Country as item for region dropdown.
REGION_DROPDOWN_DEFAULT_VALUE  = self::REGION_DROPDOWN_COUNTRY_ITEM
Region dropdown default value.
REGION_DROPDOWN_ID  = "region"
Region dropdown ID.
REGION_DROPDOWN_ITEMS  = [self::REGION_DROPDOWN_COUNTRY_ITEM => [self::LANGUAGE_CODE_GERMAN => "Land", self::LANGUAGE_CODE_ENGLISH => "Country"], self::REGION_DROPDOWN_CITY_ITEM => [self::LANGUAGE_CODE_GERMAN => "Stadt", self::LANGUAGE_CODE_ENGLISH => "City"]]
Multilingual item titles for region dropdown.
REGION_DROPDOWN_TITLES  = [self::LANGUAGE_CODE_GERMAN => "Region", self::LANGUAGE_CODE_ENGLISH => "Region"]
Region dropdown multilingual titles.
SOURCE_DROPDOWN_BILLING_ITEM  = "billing"
Billing as item for source dropdown.
SOURCE_DROPDOWN_DEFAULT_VALUE  = self::SOURCE_DROPDOWN_BILLING_ITEM
Source dropdown default value.
SOURCE_DROPDOWN_DELIVERY_ITEM  = "delivery"
Delivery as item for source dropdown.
SOURCE_DROPDOWN_ID  = "source"
Source dropdown ID.
SOURCE_DROPDOWN_ITEMS  = [self::SOURCE_DROPDOWN_BILLING_ITEM => [self::LANGUAGE_CODE_GERMAN => "Rechnung", self::LANGUAGE_CODE_ENGLISH => "Billing"], self::SOURCE_DROPDOWN_DELIVERY_ITEM => [self::LANGUAGE_CODE_GERMAN => "Lieferung", self::LANGUAGE_CODE_ENGLISH => "Delivery"]]
Multilingual item titles for source dropdown.
SOURCE_DROPDOWN_TITLES  = [self::LANGUAGE_CODE_GERMAN => "Quelle", self::LANGUAGE_CODE_ENGLISH => "Source"]
Source dropdown multilingual titles.
WIDGET_NAME  = [self::LANGUAGE_CODE_GERMAN => 'Bestellungen per Regionen (Übersicht)', self::LANGUAGE_CODE_ENGLISH => 'Orders By Regions Overview']
Multilingual titles.
$category  : WidgetCategory
Category.
$connection  : Connection
Database connection.
$factory  : StatisticsOverviewFactory
Factory.
$id  : WidgetId
ID.
$names  : WidgetNames
Multilingual titles.
$options  : WidgetOptions
Options.
$textManager  : TextManager
Text manager.
$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.
createDropdownItems()  : OptionItems
Return dropdown items.
createDropdownTitles()  : OptionTitles
Return dropdown titles.
regionDropdown()  : DropdownOption
Return region dropdown option.
sourceDropdown()  : DropdownOption
Return source dropdown option.

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

REGION_DROPDOWN_COUNTRY_ITEM

Country as item for region dropdown.

private mixed REGION_DROPDOWN_COUNTRY_ITEM = "country_code"

REGION_DROPDOWN_DEFAULT_VALUE

Region dropdown default value.

private mixed REGION_DROPDOWN_DEFAULT_VALUE = self::REGION_DROPDOWN_COUNTRY_ITEM

REGION_DROPDOWN_ITEMS

Multilingual item titles for region dropdown.

private mixed REGION_DROPDOWN_ITEMS = [self::REGION_DROPDOWN_COUNTRY_ITEM => [self::LANGUAGE_CODE_GERMAN => "Land", self::LANGUAGE_CODE_ENGLISH => "Country"], self::REGION_DROPDOWN_CITY_ITEM => [self::LANGUAGE_CODE_GERMAN => "Stadt", self::LANGUAGE_CODE_ENGLISH => "City"]]

REGION_DROPDOWN_TITLES

Region dropdown multilingual titles.

private mixed REGION_DROPDOWN_TITLES = [self::LANGUAGE_CODE_GERMAN => "Region", self::LANGUAGE_CODE_ENGLISH => "Region"]

SOURCE_DROPDOWN_BILLING_ITEM

Billing as item for source dropdown.

private mixed SOURCE_DROPDOWN_BILLING_ITEM = "billing"

SOURCE_DROPDOWN_DEFAULT_VALUE

Source dropdown default value.

private mixed SOURCE_DROPDOWN_DEFAULT_VALUE = self::SOURCE_DROPDOWN_BILLING_ITEM

SOURCE_DROPDOWN_DELIVERY_ITEM

Delivery as item for source dropdown.

private mixed SOURCE_DROPDOWN_DELIVERY_ITEM = "delivery"

SOURCE_DROPDOWN_ITEMS

Multilingual item titles for source dropdown.

private mixed SOURCE_DROPDOWN_ITEMS = [self::SOURCE_DROPDOWN_BILLING_ITEM => [self::LANGUAGE_CODE_GERMAN => "Rechnung", self::LANGUAGE_CODE_ENGLISH => "Billing"], self::SOURCE_DROPDOWN_DELIVERY_ITEM => [self::LANGUAGE_CODE_GERMAN => "Lieferung", self::LANGUAGE_CODE_ENGLISH => "Delivery"]]

SOURCE_DROPDOWN_TITLES

Source dropdown multilingual titles.

private mixed SOURCE_DROPDOWN_TITLES = [self::LANGUAGE_CODE_GERMAN => "Quelle", self::LANGUAGE_CODE_ENGLISH => "Source"]

WIDGET_NAME

Multilingual titles.

private mixed WIDGET_NAME = [self::LANGUAGE_CODE_GERMAN => 'Bestellungen per Regionen (Übersicht)', self::LANGUAGE_CODE_ENGLISH => 'Orders By Regions Overview']

Properties

Methods

Search results