AdminModuleAction
extends AdminAction
in package
Uses
IncludeBootstrap
Class AdminModuleAction
Table of Contents
- $textManager : TextManager
- $url : Url
- $isLargeLayout : bool
- $renderer : GambioAdminRenderer
- __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.
- enableLargePageLayout() : void
- Enables the large page layout.
- translate() : string
- Translates the section phrase.
- includeBootstrapAssets() : void
- Includes the bootstrap 4 frontend asset tags into the dataset.
Properties
$textManager
protected
TextManager
$textManager
$url
protected
Url
$url
$isLargeLayout
private
bool
$isLargeLayout
= false
$renderer
private
GambioAdminRenderer
$renderer
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 —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 —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 —includeBootstrapAssets()
Includes the bootstrap 4 frontend asset tags into the dataset.
private
includeBootstrapAssets(array<string|int, mixed> &$data) : void
Parameters
- $data : array<string|int, mixed>