API Documentation
Back to top  

AdminInfoBoxAjaxController

Extends \AdminHttpViewController

Class AdminInfoBoxAjaxController

This class handles incoming ajax requests for the admin info box.

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.

Checks whether a reset-cache message is necessary.

_checkResetCacheToken()

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.

Checks if the customer is the admin.

_isAdmin() : boolean

Response

boolean

Is the customer the admin?

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.

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.

Adds a new message.

actionAddMessage() : \JsonHttpControllerResponse
Throws
\AuthenticationException

If the customer has no admin privileges.

Response

\JsonHttpControllerResponse

Adds a new success message.

actionAddSuccessMessage() : \JsonHttpControllerResponse
Throws
\AuthenticationException

If the customer has no admin privileges.

Response

\JsonHttpControllerResponse

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

Delete a message by its ID.

actionDeleteById() : \JsonHttpControllerResponse
Throws
\AuthenticationException

If the customer has no admin privileges.

Response

\JsonHttpControllerResponse

Deletes messages by their identifiers.

actionDeleteByIdentifier() : \JsonHttpControllerResponse
Throws
\AuthenticationException

If the customer has no admin privileges.

Response

\JsonHttpControllerResponse

Deletes messages by their sources.

actionDeleteBySource() : \JsonHttpControllerResponse
Throws
\AuthenticationException

If the customer has no admin privileges.

Response

\JsonHttpControllerResponse

Returns all messages.

actionGetAllMessages() : \JsonHttpControllerResponse
Throws
\AuthenticationException

If the customer has no admin privileges.

Response

\JsonHttpControllerResponse

Reactivates the messages.

actionReactivateMessages() : \JsonHttpControllerResponse
Throws
\AuthenticationException

If the customer has no admin privileges.

Response

\JsonHttpControllerResponse

Sets a message status.

actionSetMessageStatus() : \JsonHttpControllerResponse
Throws
\AuthenticationException

If the customer has no admin privileges.

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 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 \HttpContextReaderInterface::getActionName \HttpResponseProcessorInterface::proceed
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

Customer ID.

customerId : integer
var

Type(s)

integer

Language code.

languageCode : \LanguageCode
var

Type(s)

\LanguageCode

Language ID.

languageId : integer
var

Type(s)

integer

Language text manager.

languageTextManager : \LanguageTextManager
var

Type(s)

\LanguageTextManager

Formatting pattern for date time values.

dateTimeFormat : string
var

Type(s)

string

Admin Info Box Service.

service : \InfoBoxService
var

Type(s)

\InfoBoxService

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