phpDocumentor

GambioHubController extends HttpViewController
in package

Class GambioHubController

This class contains the Hub Web-API callbacks of shop, for versions that include the HttpService. For legacy versions check the request_port.php and the respective AjaxHandler classes.

Table of Contents

$assets  : AssetCollectionInterface
$contentView  : ContentViewInterface
$httpContextReader  : HttpContextReaderInterface
$httpResponseProcessor  : HttpResponseProcessorInterface
$hubCallbackHandler  : HubCallbackHandlerInterface
Hub callback handler
$postDataArray  : array<string|int, mixed>
$queryParametersArray  : array<string|int, mixed>
$serverDataArray  : array<string|int, mixed>
__construct()  : mixed
actionClientKeyCallback()  : mixed
Stores the client key to the shop configuration.
actionCreateOrderStatusCallback()  : JsonHttpControllerResponse
Inserts a new order status name.
actionDefault()  : HttpControllerResponseInterface
Default action method.
actionGetConfigurationCallback()  : JsonHttpControllerResponse
Reads a configuration value for given configuration key.
actionPaymentPage()  : HttpControllerResponse|RedirectHttpControllerResponse
Performs callback POST-request to Gambio Hub API to send payment data ($_GET and $_POST) to the hub and get page content to be displayed.
actionPaymentRedirection()  : mixed
Performs callback GET-request to Gambio Hub API to get redirection URL of payment provider.
actionSessionKeyCallback()  : mixed
Stores the session key to the shop.
actionUpdateConfigurationCallback()  : JsonHttpControllerResponse
Inserts a new configuration value for given configuration key.
actionUpdateOrderStatusCallback()  : JsonHttpControllerResponse
Updates the status of an existing order.
init()  : mixed
Initializes the controller
proceed()  : mixed
Processes a http response object which is get by invoking an action method.
_callActionMethod()  : HttpControllerResponseInterface
Invokes an action method by the given action name.
_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.
_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.
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.

Properties

Methods

actionClientKeyCallback()

Stores the client key to the shop configuration.

public actionClientKeyCallback() : mixed
Return values
mixed —

actionCreateOrderStatusCallback()

Inserts a new order status name.

public actionCreateOrderStatusCallback() : JsonHttpControllerResponse

This method will set the new order status name.

The language code and language name are provided as an array for the new order status name and the "X-Client-Key" header for the authorization.

Return values
JsonHttpControllerResponse —

Returns a success message or a response error.

actionDefault()

Default action method.

public actionDefault() : HttpControllerResponseInterface

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.

Return values
HttpControllerResponseInterface —

actionPaymentRedirection()

Performs callback GET-request to Gambio Hub API to get redirection URL of payment provider.

public actionPaymentRedirection() : mixed

The redirection will be performed immediately. A moduleCode-GET-parameter is mandatory containing the Gambio Hub Payment Module Code like PayPalHub.

Return values
mixed —

actionSessionKeyCallback()

Stores the session key to the shop.

public actionSessionKeyCallback() : mixed
Return values
mixed —

actionUpdateOrderStatusCallback()

Updates the status of an existing order.

public actionUpdateOrderStatusCallback() : JsonHttpControllerResponse

This method will set the new status for a specific shop order. Order statuses will be changed as the payment is processed.

Provide the "orderId" and "orderStatusId" POST parameters for the status modification and the "X-Client-Key" header for the authorization.

Return values
JsonHttpControllerResponse —

Returns a success message or a response error.

_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.

_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.

_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.

_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
throws
Exception

If the validation fails.

Return values
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
throws
Exception

if the path or file is not found

Return values
ExistingFile —

containing absolute file path to the given template file

Search results