ShipcloudModuleCenterModuleController
extends AbstractModuleCenterModuleController
in package
Controller for shipcloud configuration
Tags
Table of Contents
- $assets : AssetCollectionInterface
- $buttons : array<string|int, mixed>
- $contentView : ContentViewInterface
- $db : CI_DB_query_builder
- $httpContextReader : HttpContextReaderInterface
- $httpResponseProcessor : HttpResponseProcessorInterface
- $languageTextManager : LanguageTextManager
- $pageTitle : string
- $postDataArray : array<string|int, mixed>
- $queryParametersArray : array<string|int, mixed>
- $redirectUrl : string
- $serverDataArray : array<string|int, mixed>
- $shipcloudConfigurationStorage : ShipcloudConfigurationStorage
- $shipcloudText : ShipcloudText
- __construct() : mixed
- actionConfiguration() : mixed
- actionDefault() : AdminLayoutHttpControllerResponse|RedirectHttpControllerResponse
- Returns an AdminLayoutHttpControllerResponse with buttons if buttons are specified or returns a RedirectHttpControllerResponse with specified redirect url.
- actionDeletePackageTemplate() : RedirectHttpControllerResponse
- Deletes a package template as identified by the templateId GET parameter and redirects back to package template configuration
- actionDeleteWebhook() : bool|RedirectHttpControllerResponse
- Deletes a webhook
- actionGetPackageTemplate() : JsonHttpControllerResponse
- Returns configuration of a package template as identified by the templateId GET parameter
- actionInfo() : mixed
- actionOrderstatusAutoconfiguration() : bool|RedirectHttpControllerResponse
- Creates default set of order statuses for webhook notifications
- actionPackageTemplates() : AdminLayoutHttpControllerResponse
- Displays package templates configuration
- actionRegisterWebhook() : bool|RedirectHttpControllerResponse
- Registers a webhook with Shipcloud
- actionSaveConfiguration() : RedirectHttpControllerResponse
- saves configuration values
- actionSavePackageTemplates() : RedirectHttpControllerResponse
- saves package template configuration
- actionSetDefaultPackageTemplate() : mixed|RedirectHttpControllerResponse
- Sets default package template
- 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.
- _getConfigurationBox() : string
- Returns HTML for package template ConfigurationBox
- _getPackageTemplateData() : array<string|int, mixed>
- Returns template configuration
- _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.
- _init() : mixed
- Initialize the module e.g. set title, description, sort order etc.
- _render() : string
- Renders and returns a template file.
- _validatePageToken() : mixed
- Check if the $_POST['pageToken'] or $_GET['pageToken'] variable is provided and if it's valid.
- getOrdersStatuses() : array<string|int, mixed>
- Retrieves a array of order statuses (ids and names as per current session language)
- 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
- makeDefaultOrderStatusConfiguration() : mixed
- prepareJsonInput() : array<string|int, mixed>
Properties
$assets
protected
AssetCollectionInterface
$assets
$buttons
protected
array<string|int, mixed>
$buttons
= []
$contentView
protected
ContentViewInterface
$contentView
$db
protected
CI_DB_query_builder
$db
$httpContextReader
protected
HttpContextReaderInterface
$httpContextReader
$httpResponseProcessor
protected
HttpResponseProcessorInterface
$httpResponseProcessor
$languageTextManager
protected
LanguageTextManager
$languageTextManager
$pageTitle
protected
string
$pageTitle
= ''
$postDataArray
protected
array<string|int, mixed>
$postDataArray
$queryParametersArray
protected
array<string|int, mixed>
$queryParametersArray
$redirectUrl
protected
string
$redirectUrl
= ''
$serverDataArray
protected
array<string|int, mixed>
$serverDataArray
$shipcloudConfigurationStorage
protected
ShipcloudConfigurationStorage
$shipcloudConfigurationStorage
$shipcloudText
protected
ShipcloudText
$shipcloudText
Methods
__construct()
public
__construct(HttpContextReaderInterface $httpContextReader, HttpResponseProcessorInterface $httpResponseProcessor, ContentViewInterface $defaultContentView) : mixed
Parameters
- $httpContextReader : HttpContextReaderInterface
- $httpResponseProcessor : HttpResponseProcessorInterface
- $defaultContentView : ContentViewInterface
Return values
mixed —actionConfiguration()
public
actionConfiguration() : mixed
Return values
mixed —actionDefault()
Returns an AdminLayoutHttpControllerResponse with buttons if buttons are specified or returns a RedirectHttpControllerResponse with specified redirect url.
public
actionDefault() : AdminLayoutHttpControllerResponse|RedirectHttpControllerResponse
Return values
AdminLayoutHttpControllerResponse|RedirectHttpControllerResponse —actionDeletePackageTemplate()
Deletes a package template as identified by the templateId GET parameter and redirects back to package template configuration
public
actionDeletePackageTemplate() : RedirectHttpControllerResponse
Return values
RedirectHttpControllerResponse —actionDeleteWebhook()
Deletes a webhook
public
actionDeleteWebhook() : bool|RedirectHttpControllerResponse
Tags
Return values
bool|RedirectHttpControllerResponse —actionGetPackageTemplate()
Returns configuration of a package template as identified by the templateId GET parameter
public
actionGetPackageTemplate() : JsonHttpControllerResponse
Return values
JsonHttpControllerResponse —actionInfo()
public
actionInfo() : mixed
Return values
mixed —actionOrderstatusAutoconfiguration()
Creates default set of order statuses for webhook notifications
public
actionOrderstatusAutoconfiguration() : bool|RedirectHttpControllerResponse
Return values
bool|RedirectHttpControllerResponse —actionPackageTemplates()
Displays package templates configuration
public
actionPackageTemplates() : AdminLayoutHttpControllerResponse
Return values
AdminLayoutHttpControllerResponse —actionRegisterWebhook()
Registers a webhook with Shipcloud
public
actionRegisterWebhook() : bool|RedirectHttpControllerResponse
Tags
Return values
bool|RedirectHttpControllerResponse —actionSaveConfiguration()
saves configuration values
public
actionSaveConfiguration() : RedirectHttpControllerResponse
Tags
Return values
RedirectHttpControllerResponse —actionSavePackageTemplates()
saves package template configuration
public
actionSavePackageTemplates() : RedirectHttpControllerResponse
Tags
Return values
RedirectHttpControllerResponse —actionSetDefaultPackageTemplate()
Sets default package template
public
actionSetDefaultPackageTemplate() : mixed|RedirectHttpControllerResponse
Tags
Return values
mixed|RedirectHttpControllerResponse —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.
_getConfigurationBox()
Returns HTML for package template ConfigurationBox
protected
_getConfigurationBox() : string
Return values
string —_getPackageTemplateData()
Returns template configuration
protected
_getPackageTemplateData(mixed $templateId) : array<string|int, mixed>
Parameters
- $templateId : mixed
Return values
array<string|int, mixed> —_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.
_init()
Initialize the module e.g. set title, description, sort order etc.
protected
_init() : mixed
Function will be called in the constructor
Return values
mixed —_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.
_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 —getOrdersStatuses()
Retrieves a array of order statuses (ids and names as per current session language)
protected
getOrdersStatuses() : array<string|int, mixed>
Return values
array<string|int, 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 —makeDefaultOrderStatusConfiguration()
protected
makeDefaultOrderStatusConfiguration() : mixed
Return values
mixed —prepareJsonInput()
protected
prepareJsonInput(string $json) : array<string|int, mixed>
Parameters
- $json : string