API Documentation
Back to top  

QuantityUnitAjaxController

Extends \AdminHttpViewController

Class QuantityUnitAjaxController

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

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.

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.

Converts an array with language codes to an array with codes as key and the language id as value.

_langIdsByLangCode(array $languageCodes) : array

Arguments

$languageCodes

array

Array that contains the language codes.

Response

array

Format: [$languageCode => $languageId, (…)].

Returns a quantity unit entity.

_quantityUnitById(string $type = 'get') : \QuantityUnitInterface

Arguments

$type

string

Determine if the quantity unit entity id should be accessed through GET or POST data.

Response

\QuantityUnitInterface

Expected quantity unit entity.

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 a quantity unit entity.

_serializeQuantityUnit(\QuantityUnitInterface $quantityUnit) : array

Arguments

$quantityUnit

\QuantityUnitInterface

Quantity unit entity to be serialized.

Response

array

Array that contains the quantity unit entity information.

Serializes a quantity unit collection.

_serializeQuantityUnitCollection(\QuantityUnitCollection $collection) : array

Arguments

$collection

\QuantityUnitCollection

Response

array

Array that contains information about all quantity unit entities.

Stores a quantity unit entity.

_storeQuantityUnit(\QuantityUnitInterface $quantityUnit) : $this|\QuantityUnitAjaxController

Names from $_POST parameter are set by this method.

Arguments

$quantityUnit

\QuantityUnitInterface

Quantity unit entity to be stored.

Response

$this|\QuantityUnitAjaxController

Same instance for chained method calls.

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

Updates a quantity unit entity in the database.

actionEdit() : \JsonHttpControllerResponse

Response

\JsonHttpControllerResponse

Provides a single quantity unit entity in json format.

actionGetById() : \JsonHttpControllerResponse

Response

\JsonHttpControllerResponse

Provides all quantity unit entities in json format for the listing.

actionGetData() : \JsonHttpControllerResponse

Response

\JsonHttpControllerResponse

Removes a quantity unit entity from the database.

actionRemove() : \JsonHttpControllerResponse

Response

\JsonHttpControllerResponse

Stores a new quantity unit entity in the database.

actionStore() : \JsonHttpControllerResponse

Response

\JsonHttpControllerResponse

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

Initializes the quantity unit ajax controller.

init()

Loads and sets the required dependencies as properties. (QuantityUnitReadService, QuantityUnitWriteService and LanguageProvider)

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

readService

readService : \QuantityUnitReadServiceInterface
var

Type(s)

\QuantityUnitReadServiceInterface

writeService

writeService : \QuantityUnitWriteServiceInterface
var

Type(s)

\QuantityUnitWriteServiceInterface

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