AdminPageHttpControllerResponse
extends HttpControllerResponse
in package
Class AdminPageHttpControllerResponse
Important: This class will load the admin section of the shop, something that cannot be integrated into unit tests. That is why it is not unit tested.
Tags
Table of Contents
- $httpBody : string
- $httpHeadersArray : array<string|int, mixed>
- __construct() : mixed
- Initializes the admin page http controller response.
- getBody() : string
- Returns the response body string.
- getHeaders() : array<string|int, mixed>
- Returns the response headers array.
- _getAdminPageBody() : string
- Returns a predefined markup for gambio admin pages.
Properties
$httpBody
protected
string
$httpBody
$httpHeadersArray
protected
array<string|int, mixed>
$httpHeadersArray
= []
Methods
__construct()
Initializes the admin page http controller response.
public
__construct(string $title, array<string|int, mixed>|null $mainContent[, AssetCollectionInterface $assets = null ][, array<string|int, mixed> $jsLanguageSections = [] ]) : mixed
Parameters
- $title : string
-
Page title of admin page.
- $mainContent : array<string|int, mixed>|null
-
Rendered response body.
- $assets : AssetCollectionInterface = null
-
(Optional) Assets collection to add new assets to the markup.
- $jsLanguageSections : array<string|int, mixed> = []
-
(Optional) Language section for the js engine modules for the rendered admin page.
Return values
mixed —getBody()
Returns the response body string.
public
getBody() : string
Return values
string —getHeaders()
Returns the response headers array.
public
getHeaders() : array<string|int, mixed>
Return values
array<string|int, mixed> —_getAdminPageBody()
Returns a predefined markup for gambio admin pages.
protected
_getAdminPageBody(array<string|int, mixed> $contentArray[, AssetCollectionInterface $assets = null ][, array<string|int, mixed> $jsLanguageSections = [] ]) : string
Parameters
- $contentArray : array<string|int, mixed>
-
Associative array with 'title' and 'main_content' keys.
- $assets : AssetCollectionInterface = null
-
(Optional) Collection with assets for the markup.
- $jsLanguageSections : array<string|int, mixed> = []
-
(Optional) Array with language sections to access them in modules of the gx javascript engine.
Return values
string —Rendered markup for the admin page.