CustomerGroupAjaxController
extends AdminHttpViewController
in package
Class CustomerGroupAjaxController
Tags
Table of Contents
- $assets : AssetCollectionInterface
- $contentView : ContentViewInterface
- $customerGroupReadService : CustomerGroupReadService
- $customerGroupWriteService : CustomerGroupWriteService
- $httpContextReader : HttpContextReaderInterface
- $httpResponseProcessor : HttpResponseProcessorInterface
- $languageProvider : LanguageProvider
- $postDataArray : array<string|int, mixed>
- $queryParametersArray : array<string|int, mixed>
- $serverDataArray : array<string|int, mixed>
- __construct() : mixed
- actionDefault() : HttpControllerResponseInterface
- Default action method.
- actionDelete() : bool
- Deletes a customer group entity in the database.
- actionGetById() : bool
- Returns all data from one customer group by id.
- actionGetData() : bool
- Gets all customer group entity's from the database.
- actionGetNameById() : bool
- Returns a customer group entity name and id by id.
- actionStore() : bool
- Creates an entity in the database.
- actionUpdate() : bool
- Updates a customer entity in the database.
- init() : mixed
- Initialization of customer group 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.
- _createBaseForCustomerGroup() : $this
- Creates a base personal offer table if base is not an admin.
- _getCustomerGroupById() : CustomerGroup
- Returns a customer group entity by post data id.
- _getDecimalType() : DecimalType
- Returns a decimal type from given decimal sting.
- _getOrderOption() : DecimalType|null
- Returns a decimal type, if the string is empty, it returns null.
- _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.
- _getStringArray() : array<string|int, mixed>
- Returns an Array from String, if the string is empty, it returns an empty string.
- _prepareCustomerGroup() : CustomerGroupAjaxController
- Prepares a customer group entity.
- _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 configurations value object.
- _serializeCustomerGroupSettings() : array<string|int, mixed>
- Serializes customer group settings value object.
- _setAsDefault() : $this
- Sets default value to customer group entity.
- _storeCustomerGroup() : array<string|int, mixed>
- Tries to store a customer group entity.
- _storeCustomerGroupConfigurations() : $this
- Stores posted customer group configurations to the customer group entity.
- _storeCustomerGroupNames() : $this
- Stores all names by language id in the given post data.
- _storeCustomerGroupSettings() : $this
- Stores posted customer group settings to the customer group entity.
- _updateCustomerGroup() : array<string|int, mixed>
- Tries to update a customer group entity.
- _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
$customerGroupReadService
protected
CustomerGroupReadService
$customerGroupReadService
$customerGroupWriteService
protected
CustomerGroupWriteService
$customerGroupWriteService
$httpContextReader
protected
HttpContextReaderInterface
$httpContextReader
$httpResponseProcessor
protected
HttpResponseProcessorInterface
$httpResponseProcessor
$languageProvider
protected
LanguageProvider
$languageProvider
$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 —actionDelete()
Deletes a customer group entity in the database.
public
actionDelete() : bool
Return values
bool —actionGetById()
Returns all data from one customer group by id.
public
actionGetById() : bool
Return values
bool —actionGetData()
Gets all customer group entity's from the database.
public
actionGetData() : bool
Return values
bool —actionGetNameById()
Returns a customer group entity name and id by id.
public
actionGetNameById() : bool
Return values
bool —actionStore()
Creates an entity in the database.
public
actionStore() : bool
Return values
bool —actionUpdate()
Updates a customer entity in the database.
public
actionUpdate() : bool
Return values
bool —init()
Initialization of customer group 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.
_createBaseForCustomerGroup()
Creates a base personal offer table if base is not an admin.
protected
_createBaseForCustomerGroup(customerGroupInterface $customerGroup) : $this
Parameters
- $customerGroup : customerGroupInterface
Return values
$this —_getCustomerGroupById()
Returns a customer group entity by post data id.
protected
_getCustomerGroupById([string $type = 'get' ]) : CustomerGroup
Parameters
- $type : string = 'get'
Return values
CustomerGroup —entity.
_getDecimalType()
Returns a decimal type from given decimal sting.
protected
_getDecimalType( $decimalString) : DecimalType
Parameters
Return values
DecimalType —_getOrderOption()
Returns a decimal type, if the string is empty, it returns null.
protected
_getOrderOption( $orderString) : DecimalType|null
Parameters
Return values
DecimalType|null —_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.
_getStringArray()
Returns an Array from String, if the string is empty, it returns an empty string.
protected
_getStringArray( $stringValue) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —_prepareCustomerGroup()
Prepares a customer group entity.
protected
_prepareCustomerGroup(CustomerGroupInterface $customerGroup) : CustomerGroupAjaxController
Parameters
- $customerGroup : CustomerGroupInterface
Return values
CustomerGroupAjaxController —_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
-
to serialize data.
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
-
to be serialized.
Return values
array<string|int, mixed> —serialized customer group collection array
_serializeCustomerGroupConfigurations()
Serializes customer group configurations value object.
protected
_serializeCustomerGroupConfigurations(CustomerGroupConfigurationsInterface $configurations) : array<string|int, mixed>
Parameters
- $configurations : CustomerGroupConfigurationsInterface
-
to serialize data.
Return values
array<string|int, mixed> —serialized customer group configurations array.
_serializeCustomerGroupSettings()
Serializes customer group settings value object.
protected
_serializeCustomerGroupSettings(CustomerGroupSettingsInterface $settings) : array<string|int, mixed>
Parameters
- $settings : CustomerGroupSettingsInterface
-
to serialize data.
Return values
array<string|int, mixed> —serialized customer group settings array.
_setAsDefault()
Sets default value to customer group entity.
protected
_setAsDefault(CustomerGroupInterface $customerGroup, $postData) : $this
Parameters
- $customerGroup : CustomerGroupInterface
- $postData :
Return values
$this —_storeCustomerGroup()
Tries to store a customer group entity.
protected
_storeCustomerGroup(CustomerGroupInterface $customerGroup) : array<string|int, mixed>
Parameters
- $customerGroup : CustomerGroupInterface
-
to store it in the database.
Return values
array<string|int, mixed> —_storeCustomerGroupConfigurations()
Stores posted customer group configurations to the customer group entity.
protected
_storeCustomerGroupConfigurations(CustomerGroupInterface $customerGroup, array<string|int, mixed> $postData) : $this
Parameters
- $customerGroup : CustomerGroupInterface
-
to set configurations on it.
- $postData : array<string|int, mixed>
Return values
$this —_storeCustomerGroupNames()
Stores all names by language id in the given post data.
protected
_storeCustomerGroupNames(CustomerGroupInterface $customerGroup, array<string|int, mixed> $postData) : $this
Parameters
- $customerGroup : CustomerGroupInterface
-
to set name.
- $postData : array<string|int, mixed>
Return values
$this —_storeCustomerGroupSettings()
Stores posted customer group settings to the customer group entity.
protected
_storeCustomerGroupSettings(CustomerGroupInterface $customerGroup, array<string|int, mixed> $postData) : $this
Parameters
- $customerGroup : CustomerGroupInterface
-
to set settings on it.
- $postData : array<string|int, mixed>
Return values
$this —_updateCustomerGroup()
Tries to update a customer group entity.
protected
_updateCustomerGroup(CustomerGroupInterface $customerGroup) : array<string|int, mixed>
Parameters
- $customerGroup : CustomerGroupInterface
-
to update it in the database.
Return values
array<string|int, mixed> —_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