API Documentation
Back to top  

CustomerGroupAjaxController

Extends \AdminHttpViewController

Class CustomerGroupAjaxController

This class contains some helper methods for handling view requests. Be careful always when outputting raw user data to HTML or when handling POST requests because insufficient protection will lead to XSS and CSRF vulnerabilities.

category

System
package

AdminHttpViewControllers
extends

AdminHttpViewController
extends

AdminHttpViewController

Methods

__construct

__construct(\HttpContextReaderInterface $httpContextReader, \HttpResponseProcessorInterface $httpResponseProcessor, \ContentViewInterface $defaultContentView)
inherited

Arguments

$httpContextReader

\HttpContextReaderInterface

$httpResponseProcessor

\HttpResponseProcessorInterface

$defaultContentView

\ContentViewInterface

Invokes an action method by the given action name.

_callActionMethod(string $actionName) : \HttpControllerResponseInterface
inherited
Throws
\LogicException

If no action method of the given name exists.

Arguments

$actionName

string

Name of action method to call, without 'action'-Suffix.

Response

\HttpControllerResponseInterface

Response message.

Creates a base personal offer table if base is not an admin.

_createBaseForCustomerGroup(\customerGroupInterface $customerGroup) : $this

Arguments

$customerGroup

\customerGroupInterface

Response

$this

Returns a customer group entity by post data id.

_getCustomerGroupById(string $type = 'get') : \CustomerGroup

Arguments

$type

string

Response

\CustomerGroup

entity.

Returns a decimal type from given decimal sting.

_getDecimalType( $decimalString) : \DecimalType

Arguments

$decimalString

Response

\DecimalType

Returns a decimal type, if the string is empty, it returns null.

_getOrderOption( $orderString) : \DecimalType|null

Arguments

$orderString

Response

\DecimalType|null

Returns the expected $_POST value by the given key name.

_getPostData(string $keyName) : string|null
inherited

This method is the object oriented layer for $_POST[$keyName].

Arguments

$keyName

string

Expected key of post parameter.

Response

string|null

Either the expected value or null, of not found.

Creates and returns a key value collection which represent the global $_POST array.

_getPostDataCollection() : \KeyValueCollection
inherited

Response

\KeyValueCollection

Returns the expected $_GET value by the given key name.

_getQueryParameter(string $keyName) : mixed|null
inherited

This method is the object oriented layer for $_GET[$keyName].

Arguments

$keyName

string

Expected key of query parameter.

Response

mixed|null

Either the expected value or null, of not found.

Creates and returns a key value collection which represent the global $_GET array.

_getQueryParametersCollection() : \KeyValueCollection
inherited

Response

\KeyValueCollection

Returns the expected $_SERVER value by the given key name.

_getServerData(string $keyName) : string|null
inherited

This method is the object oriented layer for $_SERVER[$keyName].

Arguments

$keyName

string

Expected key of server parameter.

Response

string|null

Either the expected value or null, of not found.

Returns an Array from String, if the string is empty, it returns an empty string.

_getStringArray( $stringValue) : array

Arguments

$stringValue

Response

array

Prepares a customer group entity.

_prepareCustomerGroup(\CustomerGroupInterface $customerGroup) : \CustomerGroupAjaxController

Arguments

$customerGroup

\CustomerGroupInterface

Response

\CustomerGroupAjaxController

Renders and returns a template file.

_render(string $templateFile, array $contentArray) : string
inherited

Arguments

$templateFile

string

Template file to render.

$contentArray

array

Content array which represent the variables of the template.

Response

string

Rendered template.

Serializes customer group entities.

_serializeCustomerGroup(\CustomerGroupInterface $customerGroup) : array

Arguments

$customerGroup

\CustomerGroupInterface

to serialize data.

Response

array

serialized customer group array.

Serializes customer group collections.

_serializeCustomerGroupCollection(\CustomerGroupCollection $customerGroupCollection) : array

Arguments

$customerGroupCollection

\CustomerGroupCollection

to be serialized.

Response

array

serialized customer group collection array

Serializes customer group configurations value object.

_serializeCustomerGroupConfigurations(\CustomerGroupConfigurationsInterface $configurations) : array

Arguments

$configurations

\CustomerGroupConfigurationsInterface

to serialize data.

Response

array

serialized customer group configurations array.

Serializes customer group settings value object.

_serializeCustomerGroupSettings(\CustomerGroupSettingsInterface $settings) : array

Arguments

$settings

\CustomerGroupSettingsInterface

to serialize data.

Response

array

serialized customer group settings array.

Sets default value to customer group entity.

_setAsDefault(\CustomerGroupInterface $customerGroup,  $postData) : $this

Arguments

$customerGroup

\CustomerGroupInterface

$postData

Response

$this

Tries to store a customer group entity.

_storeCustomerGroup(\CustomerGroupInterface $customerGroup) : array

Arguments

$customerGroup

\CustomerGroupInterface

to store it in the database.

Response

array

Stores posted customer group configurations to the customer group entity.

_storeCustomerGroupConfigurations(\CustomerGroupInterface $customerGroup, array $postData) : $this

Arguments

$customerGroup

\CustomerGroupInterface

to set configurations on it.

$postData

array

Response

$this

Stores all names by language id in the given post data.

_storeCustomerGroupNames(\CustomerGroupInterface $customerGroup, array $postData) : $this

Arguments

$customerGroup

\CustomerGroupInterface

to set name.

$postData

array

Response

$this

Stores posted customer group settings to the customer group entity.

_storeCustomerGroupSettings(\CustomerGroupInterface $customerGroup, array $postData) : $this

Arguments

$customerGroup

\CustomerGroupInterface

to set settings on it.

$postData

array

Response

$this

Tries to update a customer group entity.

_updateCustomerGroup(\CustomerGroupInterface $customerGroup) : array

Arguments

$customerGroup

\CustomerGroupInterface

to update it in the database.

Response

array

Check if the $_POST['pageToken'] or $_GET['pageToken'] variable is provided and if it's valid.

_validatePageToken(string $customExceptionMessage = null)
inherited

Example: public function proceed(HttpContextInterface $httpContext) { parent::proceed($httpContext); // proceed http context from parent class if($_SERVER['REQUEST_METHOD'] === 'POST') { $this->_validatePageToken(); // CSRF Protection } }

Throws
\Exception

If the validation fails.

Arguments

$customExceptionMessage

string

(optional) You can specify a custom exception message.

Default action method.

actionDefault() : \HttpControllerResponseInterface
inherited

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.

Response

\HttpControllerResponseInterface

Deletes a customer group entity in the database.

actionDelete() : boolean

Response

boolean

Returns all data from one customer group by id.

actionGetById() : boolean

Response

boolean

Gets all customer group entity's from the database.

actionGetData() : boolean

Response

boolean

Returns a customer group entity name and id by id.

actionGetNameById() : boolean

Response

boolean

Creates an entity in the database.

actionStore() : boolean

Response

boolean

Updates a customer entity in the database.

actionUpdate() : boolean

Response

boolean

Searches the GXModules directory and admin/html directory for a template file, wich can be useed inside the AdminLayoutHttpControllerResponse object for the template parameter.

getTemplateFile(string $templateFile) : \ExistingFile
inherited
Throws
\Exception

if the path or file is not found

Arguments

$templateFile

string

The relative path and filename to search for

Response

\ExistingFile

containing absolute file path to the given template file

Initialization of customer group controller

init()

Processes a http response object which is get by invoking an action method.

proceed(\HttpContextInterface $httpContext)
inherited

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.

see \HttpResponseProcessorInterface::proceed \HttpContextReaderInterface::getActionName
Throws
\LogicException

When no action method is found by the http context reader.

Arguments

$httpContext

\HttpContextInterface

Http context object which hold the request variables.

Makes sure that the admin status is currently given in session

validateCurrentAdminStatus()
inherited
Throws
\LogicException

Properties

customerGroupReadService

customerGroupReadService : \CustomerGroupReadService
var

Type(s)

\CustomerGroupReadService

customerGroupWriteService

customerGroupWriteService : \CustomerGroupWriteService
var

Type(s)

\CustomerGroupWriteService

languageProvider

languageProvider : \LanguageProvider
var

Type(s)

\LanguageProvider

httpContextReader

httpContextReader : \HttpContextReaderInterface
inherited
var

Type(s)

\HttpContextReaderInterface

httpResponseProcessor

httpResponseProcessor : \HttpResponseProcessorInterface
inherited
var

Type(s)

\HttpResponseProcessorInterface

contentView

contentView : \ContentViewInterface
inherited
var

Type(s)

\ContentViewInterface

queryParametersArray

queryParametersArray : array
inherited
var

Type(s)

array

postDataArray

postDataArray : array
inherited
var

Type(s)

array

Contain the assets needed to be included in the view HTML.

assets : \AssetCollectionInterface
inherited
var

Contain the assets needed to be included in the view HTML.

Type(s)

\AssetCollectionInterface

Server data.

serverDataArray : array
inherited
var

Server data.

Type(s)

array