Overview
extends VuePageAction
in package
Class representing the action handler for rendering the page.
Tags
Table of Contents
- JAVASCRIPT_ENGINE = 'GambioAdmin'
- JAVASCRIPT_ENTRYPOINT = 'statistics_overview'
- Entry point name (for Webpack).
- TRANSLATION_SECTION = 'statistics_overview'
- Language section name.
- TRANSLATIONS = ['language_code', 'overview_cancel', 'overview_configure_widget', 'overview_save', 'overview_erroneous_widget', 'overview_refresh', 'overview_customize', 'overview_widget_without_data', 'overview_error_occurred', 'overview_category_orders', 'overview_category_customers', 'overview_category_system']
- All available translations provided to the user interface.
- $textManager : TextManager
- $url : Url
- $isLargeLayout : bool
- $renderer : GambioAdminRenderer
- $translations : FrontendTranslations
- __invoke() : Response
- This method will be called in order to process the incoming request.
- handle() : Response
- initAbstractAction() : void
- Module action initialization.
- initAdminAction() : void
- Admin action initialization.
- render() : string
- Renders the template.
- replaceRenderer() : void
- Replaces the renderer.
- useFrontendTranslations() : void
- Uses the given frontend translations instance to add new translations.
- addVuePageTranslation() : void
- Adds a new vue page translation.
- enableLargePageLayout() : void
- Enables the large page layout.
- jsEntrypoint() : string
- Returns the name of the js entrypoint.
- translate() : string
- Translates the section phrase.
Constants
JAVASCRIPT_ENGINE
private
mixed
JAVASCRIPT_ENGINE
= 'GambioAdmin'
JAVASCRIPT_ENTRYPOINT
Entry point name (for Webpack).
private
mixed
JAVASCRIPT_ENTRYPOINT
= 'statistics_overview'
TRANSLATION_SECTION
Language section name.
private
mixed
TRANSLATION_SECTION
= 'statistics_overview'
TRANSLATIONS
All available translations provided to the user interface.
private
mixed
TRANSLATIONS
= ['language_code', 'overview_cancel', 'overview_configure_widget', 'overview_save', 'overview_erroneous_widget', 'overview_refresh', 'overview_customize', 'overview_widget_without_data', 'overview_error_occurred', 'overview_category_orders', 'overview_category_customers', 'overview_category_system']
Properties
$textManager
protected
TextManager
$textManager
$url
protected
Url
$url
$isLargeLayout
private
bool
$isLargeLayout
= false
$renderer
private
GambioAdminRenderer
$renderer
$translations
private
FrontendTranslations
$translations
Methods
__invoke()
This method will be called in order to process the incoming request.
public
__invoke(Request $request, Response $response) : Response
Parameters
Return values
Response —handle()
public
handle(Request $request, Response $response) : Response
Parameters
Tags
Return values
Response —initAbstractAction()
Module action initialization.
public
initAbstractAction(Url $url, TextManager $textManager) : void
Parameters
- $url : Url
- $textManager : TextManager
Return values
void —initAdminAction()
Admin action initialization.
public
initAdminAction(GambioAdminRenderer $renderer) : void
Parameters
- $renderer : GambioAdminRenderer
Return values
void —render()
Renders the template.
public
render(string $pageTitle, string $templatePath[, array<string|int, mixed> $data = [] ]) : string
Parameters
- $pageTitle : string
- $templatePath : string
- $data : array<string|int, mixed> = []
Tags
Return values
string —replaceRenderer()
Replaces the renderer.
public
replaceRenderer(GambioAdminRenderer $renderer) : void
This method can be inflected on child classes to provide a differently function renderer.
Parameters
- $renderer : GambioAdminRenderer
Return values
void —useFrontendTranslations()
Uses the given frontend translations instance to add new translations.
public
useFrontendTranslations(FrontendTranslations $translations) : void
Parameters
- $translations : FrontendTranslations
Return values
void —addVuePageTranslation()
Adds a new vue page translation.
protected
addVuePageTranslation(string $key, string $phraseOrSection[, string|null $section = null ]) : void
Parameters
- $key : string
- $phraseOrSection : string
- $section : string|null = null
Return values
void —enableLargePageLayout()
Enables the large page layout.
protected
enableLargePageLayout() : void
Technically, this method sets an internal flag, so the layout hides the message stack and content navigation.
Return values
void —jsEntrypoint()
Returns the name of the js entrypoint.
protected
jsEntrypoint() : string
Tags
Return values
string —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