phpDocumentor

GeschaeftskundenversandController extends AdminHttpViewController
in package

Class GeschaeftskundenversandController

Tags
extends

AdminHttpViewController

category

System

Table of Contents

$assets  : AssetCollectionInterface
$configuration  : GeschaeftskundenversandConfigurationStorage
$contentView  : ContentViewInterface
$httpContextReader  : HttpContextReaderInterface
$httpResponseProcessor  : HttpResponseProcessorInterface
$languageTextManager  : LanguageTextManager
$logger  : GeschaeftskundenversandLogger
$postDataArray  : array<string|int, mixed>
$queryParametersArray  : array<string|int, mixed>
$serverDataArray  : array<string|int, mixed>
__construct()  : mixed
actionCreateLabel()  : mixed
actionDefault()  : HttpControllerResponseInterface
Default action method.
actionDeleteLabel()  : mixed
actionPrepareLabel()  : mixed
actionResetInputs()  : mixed
addWorkdays()  : mixed
getEasterDate()  : int
This is a drop-in replacement for easter_date() from ext-calendar for years 2010 to 2037.
isWorkDay()  : mixed
proceed()  : mixed
Override "proceed" method of parent and use it for initialization.
validateCurrentAdminStatus()  : mixed
Makes sure that the admin status is currently given in session
_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.
deleteShipment()  : mixed
getCountries()  : mixed
getEuCountries()  : array<string|int, mixed>
getProductsWeights()  : array<string|int, mixed>
getShipments()  : mixed
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.
getTransportConditions()  : mixed
insertBankDataPlaceholders()  : mixed
isValidJson()  : bool
isValidRequestMethod()  : bool
notifyCustomer()  : mixed
notify customer of a change in order status
prepareJsonInput()  : array<string|int, mixed>
prettyXML()  : mixed
setOrderStatus()  : mixed
set order status and (optionally) notify customer by email
splitStreet()  : array<string|int, mixed>
Heuristically splits up a street address into its component street name and house number
storeCreateShipmentResponse()  : mixed

Properties

Methods

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 —

getEasterDate()

This is a drop-in replacement for easter_date() from ext-calendar for years 2010 to 2037.

public static getEasterDate(string $year) : int

N.B.: extending this beyond 2037 can cause problems on 32-bit systems.

Parameters
$year : string
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 —

getProductsWeights()

protected getProductsWeights(mixed $order) : array<string|int, mixed>
Parameters
$order : 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
throws
Exception

if the path or file is not found

Return values
ExistingFile —

containing absolute file path to the given template file

insertBankDataPlaceholders()

protected insertBankDataPlaceholders(mixed $configuredText, mixed $orders_id) : mixed
Parameters
$configuredText : mixed
$orders_id : mixed
Return values
mixed —

isValidRequestMethod()

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

notifyCustomer()

notify customer of a change in order status

protected notifyCustomer(mixed $orders_id, mixed $orders_status_id, mixed $order_status_comment) : mixed

This is mostly copypasted from orders.php and MUST be refactored ASAP! refactored to drop use of order_ORIGIN.

Parameters
$orders_id : mixed
$orders_status_id : mixed
$order_status_comment : mixed
Return values
mixed —

prepareJsonInput()

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

setOrderStatus()

set order status and (optionally) notify customer by email

protected setOrderStatus(mixed $orders_id, mixed $order_status_id[, string $order_status_comment = '' ][, bool $notifyCustomer = false ]) : mixed
Parameters
$orders_id : mixed
$order_status_id : mixed
$order_status_comment : string = ''
$notifyCustomer : bool = false
Return values
mixed —

splitStreet()

Heuristically splits up a street address into its component street name and house number

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

with keys 'street' and 'house_no'

storeCreateShipmentResponse()

protected storeCreateShipmentResponse(mixed $orders_id, mixed $response) : mixed
Parameters
$orders_id : mixed
$response : mixed
Return values
mixed —

Search results