phpDocumentor

GetWidgets extends AbstractAction
in package

Class representing the handler for the action of getting all widgets.

Tags
codeCoverageIgnore

Table of Contents

FALLBACK_LANGUAGE_CODE  = "de"
Fallback language code.
$textManager  : TextManager
$url  : Url
$languageCode  : LanguageCode
Current language code.
$languageService  : LanguageService
Language service.
$service  : StatisticsOverviewService
Service.
$userPreferences  : UserPreferences
Current user's preferences.
__construct()  : mixed
Constructor.
__invoke()  : Response
This method will be called in order to process the incoming request.
handle()  : Response
Executes the business logic of the incoming request.
initAbstractAction()  : void
Module action initialization.
mapDataToArray()  : array<string|int, mixed>
Return data as array.
mapMapDataToArray()  : array<string|int, mixed>
Return array containing map data.
mapNumberDataToArray()  : array<string|int, mixed>
Return array containing number data.
mapOptionsToArray()  : array<string|int, mixed>
Return options as array.
mapSerialDataToArray()  : array<string|int, mixed>
Return array containing serial data.
mapTableDataToArray()  : array<string|int, mixed>
Return array containing table data.
mapTextDataToArray()  : array<string|int, mixed>
Return array containing text data.
serializeOverviewWidget()  : array<string|int, mixed>
Return serialized widget.
translate()  : string
Translates the section phrase.

Constants

FALLBACK_LANGUAGE_CODE

Fallback language code.

private mixed FALLBACK_LANGUAGE_CODE = "de"

Properties

Methods

mapDataToArray()

Return data as array.

protected mapDataToArray(WidgetData $data) : array<string|int, mixed>
Parameters
$data : WidgetData

Widget's data.

Return values
array<string|int, mixed> —

Widget's data as array.

mapMapDataToArray()

Return array containing map data.

protected mapMapDataToArray(MapData $data) : array<string|int, mixed>
Parameters
$data : MapData

Widget's map data.

Return values
array<string|int, mixed> —

Widget's map data as array.

mapNumberDataToArray()

Return array containing number data.

protected mapNumberDataToArray(NumberData $data) : array<string|int, mixed>
Parameters
$data : NumberData

Widget's number data.

Return values
array<string|int, mixed> —

Widget's number data as array.

mapOptionsToArray()

Return options as array.

protected mapOptionsToArray(WidgetOptions $options) : array<string|int, mixed>
Parameters
$options : WidgetOptions

Widget's options.

Return values
array<string|int, mixed> —

Widget's options as array.

mapSerialDataToArray()

Return array containing serial data.

protected mapSerialDataToArray(SerialData $data) : array<string|int, mixed>
Parameters
$data : SerialData

Widget's serial data.

Return values
array<string|int, mixed> —

Widget's serial data as array.

mapTableDataToArray()

Return array containing table data.

protected mapTableDataToArray(TableData $data) : array<string|int, mixed>
Parameters
$data : TableData

Widget's table data.

Return values
array<string|int, mixed> —

Widget's table data as array.

mapTextDataToArray()

Return array containing text data.

protected mapTextDataToArray(TextData $data) : array<string|int, mixed>
Parameters
$data : TextData

Widget's text data.

Return values
array<string|int, mixed> —

Widget's text data as array.

serializeOverviewWidget()

Return serialized widget.

protected serializeOverviewWidget(OverviewWidget $widget) : array<string|int, mixed>
Parameters
$widget : OverviewWidget

Widget.

Return values
array<string|int, mixed> —

Serialized widget.

translate()

Translates the section phrase.

protected translate(string $phrase, string $section[, int|null $languageId = null ]) : string
Parameters
$phrase : string
$section : string
$languageId : int|null = null
Return values
string —

Search results