HubConfigurationAjaxController
extends AdminHttpViewController
in package
Class GambioHubConfigurationAjaxController
This controller contains AJAX functionality related to the configuration pages of the Gambio Hub module.
Tags
Table of Contents
- $assets : AssetCollectionInterface
- $colorHexCodeRegex : string
- Regular expression to verify a hexadecimal color value.
- $contentView : ContentViewInterface
- $features : array<string|int, mixed>
- $httpContextReader : HttpContextReaderInterface
- $httpResponseProcessor : HttpResponseProcessorInterface
- $postDataArray : array<string|int, mixed>
- $queryParametersArray : array<string|int, mixed>
- $serverDataArray : array<string|int, mixed>
- __construct() : mixed
- actionCreateSessionKey() : JsonHttpControllerResponse
- Starts the creation of the session key.
- actionDefault() : HttpControllerResponseInterface
- Default action method.
- actionDeleteClientKey() : JsonHttpControllerResponse
- Deletes the Gambio Hub Client Key
- actionGetOrderStatuses() : JsonHttpControllerResponse
- Returns all available order statuses and the default one.
- actionGetShopData() : JsonHttpControllerResponse
- Get the shop data.
- actionGetStyleEditConfiguration() : JsonHttpControllerResponse
- Returns the style edit configuration values.
- actionGetTranslations() : JsonHttpControllerResponse
- Returns the Gambio Hub Translations for the frontend.
- 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.
- _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>
- duplicateSassVariablesWithAlias() : array<string|int, mixed>
- Duplicates entries with the alias name
- resolveSettingValuesByNameRecursively() : array<string|int, mixed>
- Resolves settings from StyleEdit 4 with a certain depth
- resolveUnresolvedSassVariablesToFallback() : array<string|int, mixed>
- Attempt to fallback to sass variables if the sass variable could not be resolved
- sortSassVariablesInResolvedAndUnresolved() : array<string|int, mixed>
- Sort the sass variables in resolved and unresolved variables
Properties
$assets
protected
AssetCollectionInterface
$assets
$colorHexCodeRegex
Regular expression to verify a hexadecimal color value.
protected
string
$colorHexCodeRegex
= '/^#[a-f0-9]{6}$/i'
$contentView
protected
ContentViewInterface
$contentView
$features
protected
array<string|int, mixed>
$features
= ['redirected_installation']
$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 —actionCreateSessionKey()
Starts the creation of the session key.
public
actionCreateSessionKey() : JsonHttpControllerResponse
Return values
JsonHttpControllerResponse —Returns the session key data.
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 —actionDeleteClientKey()
Deletes the Gambio Hub Client Key
public
actionDeleteClientKey() : JsonHttpControllerResponse
Return values
JsonHttpControllerResponse —actionGetOrderStatuses()
Returns all available order statuses and the default one.
public
actionGetOrderStatuses() : JsonHttpControllerResponse
Return values
JsonHttpControllerResponse —Returns the order statuses data.
actionGetShopData()
Get the shop data.
public
actionGetShopData() : JsonHttpControllerResponse
If a Hub Client Key exists it will be returned instead of the shop data so that the merchant data can be loaded from the customer portal.
Return values
JsonHttpControllerResponse —Returns the shop data.
actionGetStyleEditConfiguration()
Returns the style edit configuration values.
public
actionGetStyleEditConfiguration() : JsonHttpControllerResponse
Return values
JsonHttpControllerResponse —Style edit configuration values.
actionGetTranslations()
Returns the Gambio Hub Translations for the frontend.
public
actionGetTranslations() : JsonHttpControllerResponse
Return values
JsonHttpControllerResponse —Returns the translation data.
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.
_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
Return values
array<string|int, mixed> —duplicateSassVariablesWithAlias()
Duplicates entries with the alias name
private
duplicateSassVariablesWithAlias(array<string|int, mixed> $entries, array<string|int, mixed> $aliases) : array<string|int, mixed>
Parameters
- $entries : array<string|int, mixed>
- $aliases : array<string|int, mixed>
Return values
array<string|int, mixed> —resolveSettingValuesByNameRecursively()
Resolves settings from StyleEdit 4 with a certain depth
private
resolveSettingValuesByNameRecursively(array<string|int, mixed> $variables[, int $depth = 5 ][, array<string|int, mixed> $resolvedEntries = [] ][, array<string|int, mixed> $unresolvedEntries = [] ]) : array<string|int, mixed>
Parameters
- $variables : array<string|int, mixed>
- $depth : int = 5
- $resolvedEntries : array<string|int, mixed> = []
- $unresolvedEntries : array<string|int, mixed> = []
Return values
array<string|int, mixed> —resolveUnresolvedSassVariablesToFallback()
Attempt to fallback to sass variables if the sass variable could not be resolved
private
resolveUnresolvedSassVariablesToFallback(array<string|int, mixed> $entries, array<string|int, mixed> $fallbacks) : array<string|int, mixed>
Parameters
- $entries : array<string|int, mixed>
- $fallbacks : array<string|int, mixed>
Return values
array<string|int, mixed> —sortSassVariablesInResolvedAndUnresolved()
Sort the sass variables in resolved and unresolved variables
private
sortSassVariablesInResolvedAndUnresolved(array<string|int, mixed> $configurations) : array<string|int, mixed>
Parameters
- $configurations : array<string|int, mixed>