AdminInfoBoxAjaxController
extends AdminHttpViewController
in package
Class AdminInfoBoxAjaxController
This class handles incoming ajax requests for the admin info box.
Tags
Table of Contents
- $assets : AssetCollectionInterface
- $contentView : ContentViewInterface
- $customerId : int
- Customer ID.
- $dateTimeFormat : string
- Formatting pattern for date time values.
- $httpContextReader : HttpContextReaderInterface
- $httpResponseProcessor : HttpResponseProcessorInterface
- $languageCode : LanguageCode
- Language code.
- $languageId : int
- Language ID.
- $languageTextManager : LanguageTextManager
- Language text manager.
- $postDataArray : array<string|int, mixed>
- $queryParametersArray : array<string|int, mixed>
- $serverDataArray : array<string|int, mixed>
- $service : InfoBoxService
- Admin Info Box Service.
- __construct() : mixed
- actionAddMessage() : JsonHttpControllerResponse
- Adds a new message.
- actionAddSuccessMessage() : JsonHttpControllerResponse
- Adds a new success message.
- actionDefault() : JsonHttpControllerResponse
- Callback method for the default action.
- actionDeleteById() : JsonHttpControllerResponse
- Delete a message by its ID.
- actionDeleteByIdentifier() : JsonHttpControllerResponse
- Deletes messages by their identifiers.
- actionDeleteBySource() : JsonHttpControllerResponse
- Deletes messages by their sources.
- actionGetAllMessages() : JsonHttpControllerResponse
- Returns all messages.
- actionReactivateMessages() : JsonHttpControllerResponse
- Reactivates the messages.
- actionSetMessageStatus() : JsonHttpControllerResponse
- Sets a message status.
- init() : mixed
- Initializes the controller.
- proceed() : mixed
- Processes a http response object which is get by invoking an action method.
- validateCurrentAdminStatus() : mixed
- Makes sure that the admin status is currently given in session
- _callActionMethod() : HttpControllerResponseInterface
- Invokes an action method by the given action name.
- _checkResetCacheToken() : mixed
- Checks whether a reset-cache message is necessary.
- _getPostData() : string|null
- Returns the expected $_POST value by the given key name.
- _getPostDataCollection() : KeyValueCollection
- Creates and returns a key value collection which represent the global $_POST array.
- _getQueryParameter() : mixed|null
- Returns the expected $_GET value by the given key name.
- _getQueryParametersCollection() : KeyValueCollection
- Creates and returns a key value collection which represent the global $_GET array.
- _getServerData() : string|null
- Returns the expected $_SERVER value by the given key name.
- _isAdmin() : bool
- Checks if the customer is the admin.
- _render() : string
- Renders and returns a template file.
- _validatePageToken() : mixed
- Check if the $_POST['pageToken'] or $_GET['pageToken'] variable is provided and if it's valid.
- getTemplateFile() : ExistingFile
- Searches the GXModules directory and admin/html directory for a template file, wich can be useed inside the AdminLayoutHttpControllerResponse object for the template parameter.
- isValidJson() : bool
- isValidRequestMethod() : bool
- prepareJsonInput() : array<string|int, mixed>
Properties
$assets
protected
AssetCollectionInterface
$assets
$contentView
protected
ContentViewInterface
$contentView
$customerId
Customer ID.
protected
int
$customerId
$dateTimeFormat
Formatting pattern for date time values.
protected
string
$dateTimeFormat
= 'Y-m-d H:i:s'
$httpContextReader
protected
HttpContextReaderInterface
$httpContextReader
$httpResponseProcessor
protected
HttpResponseProcessorInterface
$httpResponseProcessor
$languageCode
Language code.
protected
LanguageCode
$languageCode
$languageId
Language ID.
protected
int
$languageId
$languageTextManager
Language text manager.
protected
LanguageTextManager
$languageTextManager
$postDataArray
protected
array<string|int, mixed>
$postDataArray
$queryParametersArray
protected
array<string|int, mixed>
$queryParametersArray
$serverDataArray
protected
array<string|int, mixed>
$serverDataArray
$service
Admin Info Box Service.
protected
InfoBoxService
$service
Methods
__construct()
public
__construct(HttpContextReaderInterface $httpContextReader, HttpResponseProcessorInterface $httpResponseProcessor, ContentViewInterface $defaultContentView) : mixed
Parameters
- $httpContextReader : HttpContextReaderInterface
- $httpResponseProcessor : HttpResponseProcessorInterface
- $defaultContentView : ContentViewInterface
Return values
mixed —actionAddMessage()
Adds a new message.
public
actionAddMessage() : JsonHttpControllerResponse
Tags
Return values
JsonHttpControllerResponse —actionAddSuccessMessage()
Adds a new success message.
public
actionAddSuccessMessage() : JsonHttpControllerResponse
Tags
Return values
JsonHttpControllerResponse —actionDefault()
Callback method for the default action.
public
actionDefault() : JsonHttpControllerResponse
Return values
JsonHttpControllerResponse —actionDeleteById()
Delete a message by its ID.
public
actionDeleteById() : JsonHttpControllerResponse
Tags
Return values
JsonHttpControllerResponse —actionDeleteByIdentifier()
Deletes messages by their identifiers.
public
actionDeleteByIdentifier() : JsonHttpControllerResponse
Tags
Return values
JsonHttpControllerResponse —actionDeleteBySource()
Deletes messages by their sources.
public
actionDeleteBySource() : JsonHttpControllerResponse
Tags
Return values
JsonHttpControllerResponse —actionGetAllMessages()
Returns all messages.
public
actionGetAllMessages() : JsonHttpControllerResponse
Tags
Return values
JsonHttpControllerResponse —actionReactivateMessages()
Reactivates the messages.
public
actionReactivateMessages() : JsonHttpControllerResponse
Tags
Return values
JsonHttpControllerResponse —actionSetMessageStatus()
Sets a message status.
public
actionSetMessageStatus() : JsonHttpControllerResponse
Tags
Return values
JsonHttpControllerResponse —init()
Initializes the controller.
public
init() : mixed
Return values
mixed —proceed()
Processes a http response object which is get by invoking an action method.
public
proceed(HttpContextInterface $httpContext) : mixed
The action method is determined by the http context reader instance and the current request context. Re-implement this method in child classes to enable XSS and CSRF protection on demand.
Parameters
- $httpContext : HttpContextInterface
-
Http context object which hold the request variables.
Tags
Return values
mixed —validateCurrentAdminStatus()
Makes sure that the admin status is currently given in session
public
validateCurrentAdminStatus() : mixed
Tags
Return values
mixed —_callActionMethod()
Invokes an action method by the given action name.
protected
_callActionMethod(string $actionName) : HttpControllerResponseInterface
Parameters
- $actionName : string
-
Name of action method to call, without 'action'-Suffix.
Tags
Return values
HttpControllerResponseInterface —Response message.
_checkResetCacheToken()
Checks whether a reset-cache message is necessary.
protected
_checkResetCacheToken() : mixed
Return values
mixed —_getPostData()
Returns the expected $_POST value by the given key name.
protected
_getPostData(string $keyName) : string|null
This method is the object oriented layer for $_POST[$keyName].
Parameters
- $keyName : string
-
Expected key of post parameter.
Return values
string|null —Either the expected value or null, of not found.
_getPostDataCollection()
Creates and returns a key value collection which represent the global $_POST array.
protected
_getPostDataCollection() : KeyValueCollection
Return values
KeyValueCollection —_getQueryParameter()
Returns the expected $_GET value by the given key name.
protected
_getQueryParameter(string $keyName) : mixed|null
This method is the object oriented layer for $_GET[$keyName].
Parameters
- $keyName : string
-
Expected key of query parameter.
Return values
mixed|null —Either the expected value or null, of not found.
_getQueryParametersCollection()
Creates and returns a key value collection which represent the global $_GET array.
protected
_getQueryParametersCollection() : KeyValueCollection
Return values
KeyValueCollection —_getServerData()
Returns the expected $_SERVER value by the given key name.
protected
_getServerData(string $keyName) : string|null
This method is the object oriented layer for $_SERVER[$keyName].
Parameters
- $keyName : string
-
Expected key of server parameter.
Return values
string|null —Either the expected value or null, of not found.
_isAdmin()
Checks if the customer is the admin.
protected
_isAdmin() : bool
Return values
bool —Is the customer the admin?
_render()
Renders and returns a template file.
protected
_render(string $templateFile, array<string|int, mixed> $contentArray) : string
Parameters
- $templateFile : string
-
Template file to render.
- $contentArray : array<string|int, mixed>
-
Content array which represent the variables of the template.
Return values
string —Rendered template.
_validatePageToken()
Check if the $_POST['pageToken'] or $_GET['pageToken'] variable is provided and if it's valid.
protected
_validatePageToken([string $customExceptionMessage = null ]) : mixed
Example: public function proceed(HttpContextInterface $httpContext) { parent::proceed($httpContext); // proceed http context from parent class if($_SERVER['REQUEST_METHOD'] === 'POST') { $this->_validatePageToken(); // CSRF Protection } }
Parameters
- $customExceptionMessage : string = null
-
(optional) You can specify a custom exception message.
Tags
Return values
mixed —getTemplateFile()
Searches the GXModules directory and admin/html directory for a template file, wich can be useed inside the AdminLayoutHttpControllerResponse object for the template parameter.
protected
getTemplateFile(string $templateFile) : ExistingFile
Parameters
- $templateFile : string
-
The relative path and filename to search for
Tags
Return values
ExistingFile —containing absolute file path to the given template file
isValidJson()
protected
isValidJson(string $string) : bool
Parameters
- $string : string
Return values
bool —isValidRequestMethod()
protected
isValidRequestMethod(string $method) : bool
Parameters
- $method : string
Return values
bool —prepareJsonInput()
protected
prepareJsonInput(string $json) : array<string|int, mixed>
Parameters
- $json : string