ShipcloudModuleCenterModuleController

Extends \AbstractModuleCenterModuleController

Controller for shipcloud configuration

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.

extends	AbstractModuleCenterModuleController
category	System
package	Modules
subpackage	Controllers

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 HTML for package template ConfigurationBox

_getConfigurationBox() : string

Response

string

Returns template configuration

_getPackageTemplateData( $templateId) : array

Arguments

$templateId

Response

array

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.

Initialize the module e.g. set title, description, sort order etc.

_init()

inherited abstract

Function will be called in the constructor

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.

actionConfiguration

actionConfiguration()

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 package template as identified by the templateId GET parameter and redirects back to package template configuration

actionDeletePackageTemplate() : \RedirectHttpControllerResponse

Response

\RedirectHttpControllerResponse

Deletes a webhook

actionDeleteWebhook() : boolean|\RedirectHttpControllerResponse


Throws	\Exception

Response

boolean|\RedirectHttpControllerResponse

Returns configuration of a package template as identified by the templateId GET parameter

actionGetPackageTemplate() : \JsonHttpControllerResponse

Response

\JsonHttpControllerResponse

actionInfo

actionInfo()

Creates default set of order statuses for webhook notifications

actionOrderstatusAutoconfiguration() : boolean|\RedirectHttpControllerResponse

Response

boolean|\RedirectHttpControllerResponse

Displays package templates configuration

actionPackageTemplates() : \AdminPageHttpControllerResponse

Response

\AdminPageHttpControllerResponse

Registers a webhook with Shipcloud

actionRegisterWebhook() : boolean|\RedirectHttpControllerResponse


Throws	\Exception

Response

boolean|\RedirectHttpControllerResponse

saves configuration values

actionSaveConfiguration() : \RedirectHttpControllerResponse


Throws	\Exception

Response

\RedirectHttpControllerResponse

saves package template configuration

actionSavePackageTemplates() : \RedirectHttpControllerResponse


Throws	\Exception

Response

\RedirectHttpControllerResponse

Retrieves a array of order statuses (ids and names as per current session language)

getOrdersStatuses() : array

Response

array

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

makeDefaultOrderStatusConfiguration

makeDefaultOrderStatusConfiguration()

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

db

db : \CI_DB_query_builder

var

Type(s)

\CI_DB_query_builder

shipcloudText

shipcloudText : \ShipcloudText

var

Type(s)

\ShipcloudText

shipcloudConfigurationStorage

shipcloudConfigurationStorage : \ShipcloudConfigurationStorage

var

Type(s)

\ShipcloudConfigurationStorage

pageTitle

pageTitle : string

inherited

var

Type(s)

string

buttons

buttons : array

inherited

var

Type(s)

array

redirectUrl

redirectUrl : string

inherited

var

Type(s)

string

languageTextManager

languageTextManager : \LanguageTextManager

inherited

var

Type(s)

\LanguageTextManager

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