VuePageAction
extends AdminAction
in package
Class VuePageAction
Table of Contents
- JAVASCRIPT_ENGINE = 'GambioAdmin'
- $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
- Executes the business logic of the incoming request.
- 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'
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()
Executes the business logic of the incoming request.
public
abstract handle(Request $request, Response $response) : Response
Parameters
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
abstract jsEntrypoint() : string
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