API Documentation » \InvoicesModalsAjaxController

category	System
package	AdminHttpViewControllers
extends	AdminHttpViewController

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

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.

Download Bulk Invoices PDF.

actionBulkPdfInvoices()

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

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

see	\InvoiceActions

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

Delete Invoices Callback

actionDeleteInvoice() : \JsonHttpControllerResponse

This method expects a "selectedInvoices" POST value which must contain the IDs of the invoices to be deleted.


Throws	\InvalidArgumentException

Response

\JsonHttpControllerResponse

Get Email Invoice Information

actionGetEmailInvoiceInformation() : \JsonHttpControllerResponse

This method will provide the required email-invoice information to the modal JS controller. The subject will have to be parsed in frontend with JavaScript.

Provide a GET "o" parameter with the selected order numbers.

Response

\JsonHttpControllerResponse

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

Initialize Controller

init()



Throws	\Exception

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

invoiceArchiveReadService

invoiceArchiveReadService : \InvoiceArchiveReadService

var

Type(s)

\InvoiceArchiveReadService

invoiceArchiveWriteService

invoiceArchiveWriteService : \InvoiceArchiveWriteService

var

Type(s)

\InvoiceArchiveWriteService

orderReadService

orderReadService : \OrderReadService

var

Type(s)

\OrderReadService

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

InvoicesModalsAjaxController

Methods

__construct

Arguments

$httpContextReader

$httpResponseProcessor

$defaultContentView

Invokes an action method by the given action name.

Arguments

$actionName

Response

Returns the expected $_POST value by the given key name.

Arguments

$keyName

Response

Creates and returns a key value collection which represent the global $_POST array.

Response

Returns the expected $_GET value by the given key name.

Arguments

$keyName

Response

Creates and returns a key value collection which represent the global $_GET array.

Response

Returns the expected $_SERVER value by the given key name.

Arguments

$keyName

Response

Renders and returns a template file.

Arguments

$templateFile

$contentArray

Response

Check if the $_POST['pageToken'] or $_GET['pageToken'] variable is provided and if it's valid.

Arguments

$customExceptionMessage

Download Bulk Invoices PDF.

Default action method.

Response

Delete Invoices Callback

Response

Get Email Invoice Information

Response

Searches the GXModules directory and admin/html directory for a template file, wich can be useed inside the AdminLayoutHttpControllerResponse object for the template parameter.

Arguments

$templateFile

Response

Initialize Controller

Processes a http response object which is get by invoking an action method.

Arguments

$httpContext

Makes sure that the admin status is currently given in session

Properties

invoiceArchiveReadService

Type(s)

invoiceArchiveWriteService

Type(s)

orderReadService

Type(s)

httpContextReader

Type(s)

httpResponseProcessor

Type(s)

contentView

Type(s)

queryParametersArray

Type(s)

postDataArray

Type(s)

Contain the assets needed to be included in the view HTML.

Type(s)

Server data.

Type(s)