JSWidgetsAjaxController
extends AdminHttpViewController
in package
Class JSWidgetsAjaxController
Tags
Table of Contents
- $assets : AssetCollectionInterface
- $contentView : ContentViewInterface
- $httpContextReader : HttpContextReaderInterface
- $httpResponseProcessor : HttpResponseProcessorInterface
- $postDataArray : array<string|int, mixed>
- $queryParametersArray : array<string|int, mixed>
- $serverDataArray : array<string|int, mixed>
- __construct() : mixed
- actionDefault() : HttpControllerResponseInterface
- Default action method.
- actionIconInput() : mixed
- actionIsGroupCheckEnabled() : JsonHttpControllerResponse
- Checks if the group check is enabled.
- actionResponsiveFileManagerExists() : JsonHttpControllerResponse
- Detects if the file manager is installed or not.
- 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.
- _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.
- _render() : string
- Renders and returns a template file.
- _serializeCustomerGroup() : array<string|int, mixed>
- Serializes customer group entities.
- _serializeCustomerGroupCollection() : array<string|int, mixed>
- Serializes customer group collections.
- _serializeCustomerGroupConfigurations() : array<string|int, mixed>
- Serializes customer group configuration value objects.
- _serializeCustomerGroupNames() : array<string|int, mixed>
- Serializes customer group names array.
- _serializeCustomerGroupSettings() : array<string|int, mixed>
- Serializes customer group settings value objects.
- _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
$httpContextReader
protected
HttpContextReaderInterface
$httpContextReader
$httpResponseProcessor
protected
HttpResponseProcessorInterface
$httpResponseProcessor
$postDataArray
protected
array<string|int, mixed>
$postDataArray
$queryParametersArray
protected
array<string|int, mixed>
$queryParametersArray
$serverDataArray
protected
array<string|int, mixed>
$serverDataArray
Methods
__construct()
public
__construct(HttpContextReaderInterface $httpContextReader, HttpResponseProcessorInterface $httpResponseProcessor, ContentViewInterface $defaultContentView) : mixed
Parameters
- $httpContextReader : HttpContextReaderInterface
- $httpResponseProcessor : HttpResponseProcessorInterface
- $defaultContentView : ContentViewInterface
Return values
mixed —actionDefault()
Default action method.
public
actionDefault() : HttpControllerResponseInterface
Every controller child class requires at least the default action method, which is invoked when the ::_getQueryParameterData('do') value is not separated by a trailing slash.
Every action method have to return an instance which implements the http controller response interface.
Return values
HttpControllerResponseInterface —actionIconInput()
public
actionIconInput() : mixed
Return values
mixed —actionIsGroupCheckEnabled()
Checks if the group check is enabled.
public
actionIsGroupCheckEnabled() : JsonHttpControllerResponse
If true, the response provide information about the existing customer groups.
Return values
JsonHttpControllerResponse —actionResponsiveFileManagerExists()
Detects if the file manager is installed or not.
public
actionResponsiveFileManagerExists() : JsonHttpControllerResponse
Return values
JsonHttpControllerResponse —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.
_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.
_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.
_serializeCustomerGroup()
Serializes customer group entities.
protected
_serializeCustomerGroup(CustomerGroupInterface $customerGroup) : array<string|int, mixed>
Parameters
- $customerGroup : CustomerGroupInterface
-
Customer group entity to be serialized.
Tags
Return values
array<string|int, mixed> —Serialized customer group array.
_serializeCustomerGroupCollection()
Serializes customer group collections.
protected
_serializeCustomerGroupCollection(CustomerGroupCollection $customerGroupCollection) : array<string|int, mixed>
Parameters
- $customerGroupCollection : CustomerGroupCollection
-
Customer group collection to be serialized.
Tags
Return values
array<string|int, mixed> —Serialized customer group collection array.
_serializeCustomerGroupConfigurations()
Serializes customer group configuration value objects.
protected
_serializeCustomerGroupConfigurations(CustomerGroupConfigurationsInterface $configurations) : array<string|int, mixed>
Parameters
- $configurations : CustomerGroupConfigurationsInterface
-
Customer group configuration object to be serialized.
Tags
Return values
array<string|int, mixed> —Serialized customer group configuration array.
_serializeCustomerGroupNames()
Serializes customer group names array.
protected
_serializeCustomerGroupNames(array<string|int, mixed> $customerGroupNames) : array<string|int, mixed>
Parameters
- $customerGroupNames : array<string|int, mixed>
-
Customer group names array to be serialized.
Tags
Return values
array<string|int, mixed> —Serialized customer group names array.
_serializeCustomerGroupSettings()
Serializes customer group settings value objects.
protected
_serializeCustomerGroupSettings(CustomerGroupSettingsInterface $settings) : array<string|int, mixed>
Parameters
- $settings : CustomerGroupSettingsInterface
-
Customer group settings object to be serialized.
Tags
Return values
array<string|int, mixed> —Serialized customer group settings array.
_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