phpDocumentor

OrdersModalsAjaxController extends AdminHttpViewController
in package

Class OrdersModalsAjaxController

AJAX controller for the orders modals.

Tags
category

System

extends

AdminHttpViewController

Table of Contents

$assets  : AssetCollectionInterface
$contentView  : ContentViewInterface
$httpContextReader  : HttpContextReaderInterface
$httpResponseProcessor  : HttpResponseProcessorInterface
$languageTextManager  : LanguageTextManager
$parcelServiceService  : ParcelServiceReadService
$postDataArray  : array<string|int, mixed>
$queryParametersArray  : array<string|int, mixed>
$serverDataArray  : array<string|int, mixed>
$trackingCodeFactory  : TrackingCodeFactory
$trackingCodeService  : TrackingCodeWriteService
__construct()  : mixed
actionBulkPdfInvoices()  : mixed
Download Bulk Invoices PDF.
actionBulkPdfPackingSlips()  : mixed
Download Bulk Packing Slips PDF.
actionCancelOrder()  : JsonHttpControllerResponse
Cancel Order Callback
actionChangeOrderStatus()  : JsonHttpControllerResponse
Change order status.
actionDefault()  : HttpControllerResponseInterface
Default action method.
actionDeleteOrder()  : JsonHttpControllerResponse
Delete Order Callback
actionGetEmailInvoiceSubject()  : mixed
Get Email-Invoice Subject
actionGetInvoiceCount()  : mixed
Get amount of invoices for an order.
actionStoreTrackingNumber()  : JsonHttpControllerResponse
Stores a tracking number for a specific order.
init()  : mixed
Initialize Controller
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
_buildTrackingUrl()  : string|array<string|int, string>
_callActionMethod()  : HttpControllerResponseInterface
Invokes an action method by the given action name.
_getLanguageCodeByOrderId()  : int
_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.
isValidJson()  : bool
isValidRequestMethod()  : bool
prepareJsonInput()  : array<string|int, mixed>

Properties

Methods

actionBulkPdfInvoices()

Download Bulk Invoices PDF.

public actionBulkPdfInvoices() : mixed

This method will provide a concatenated file of invoice PDFs. Provide a GET parameter "o" that contain the selected order IDs.

Notice: The "o" is used instead of "orderIds" because the final URL must be as small as possible (some browsers do not work with GET URL of 100 orders).

Tags
see
OrderActions
Return values
mixed —

actionBulkPdfPackingSlips()

Download Bulk Packing Slips PDF.

public actionBulkPdfPackingSlips() : mixed

This method will provide a concatenated file of packing slip PDFs. Provide a GET parameter "o" that contain the selected order IDs.

Notice: The "o" is used instead of "orderIds" because the final URL must be as small as possible (some browsers do not work with GET URL of 100 orders).

Tags
see
OrderActions
Return values
mixed —

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 —

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
throws
LogicException

When no action method is found by the http context reader.

see
HttpContextReaderInterface::getActionName
see
HttpResponseProcessorInterface::proceed
Return values
mixed —

_buildTrackingUrl()

protected _buildTrackingUrl(string $p_url, string $p_trackingCode) : string|array<string|int, string>
Parameters
$p_url : string
$p_trackingCode : string
Return values
string|array<string|int, string> —

_getLanguageCodeByOrderId()

protected _getLanguageCodeByOrderId(int $p_orderId) : int
Parameters
$p_orderId : int
Tags
throws
Exception
Return values
int —

_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

isValidRequestMethod()

protected isValidRequestMethod(string $method) : bool
Parameters
$method : string
Return values
bool —

prepareJsonInput()

protected prepareJsonInput(string $json) : array<string|int, mixed>
Parameters
$json : string
Return values
array<string|int, mixed> —

Search results