phpDocumentor

InvoicesOverviewAjaxController extends AdminHttpViewController
in package

Class InvoicesAjaxController

AJAX controller for the invoices main page.

Tags
category

System

extends

AdminHttpViewController

Table of Contents

$assets  : AssetCollectionInterface
$contentView  : ContentViewInterface
$dataTableHelper  : DataTableHelper
$db  : CI_DB_query_builder
$httpContextReader  : HttpContextReaderInterface
$httpResponseProcessor  : HttpResponseProcessorInterface
$invoiceArchiveReadService  : InvoiceArchiveReadService
$invoicesOverviewColumns  : InvoicesOverviewColumns
$invoicesOverviewTooltips  : InvoicesOverviewTooltips
$postDataArray  : array<string|int, mixed>
$queryParametersArray  : array<string|int, mixed>
$serverDataArray  : array<string|int, mixed>
__construct()  : mixed
actionDataTable()  : mixed
DataTable Instance Callback
actionDefault()  : HttpControllerResponseInterface
Default action method.
actionFilterOptions()  : JsonHttpControllerResponse
Regenerate the filtering options and send them back to the client.
actionTooltips()  : JsonHttpControllerResponse
DataTable Tooltips Rendering
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
_callActionMethod()  : HttpControllerResponseInterface
Invokes an action method by the given action name.
_getCurrencies()  : array<string|int, mixed>
Get the currencies with all settings like decimal point.
_getFilteredRecordCount()  : int
Get the filtered record count of the "orders" table.
_getInvoiceListItems()  : InvoiceListItemCollection
Parse the DataTable request and fetch the InvoiceListItems that need to be displayed.
_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.
_getRowData()  : array<string|int, mixed>
Set the <tr> row data.
_getServerData()  : string|null
Returns the expected $_SERVER value by the given key name.
_getTableData()  : array<string|int, mixed>
Get the table data.
_getTotalRecordCount()  : int
Get the total record count of the "orders" table.
_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

actionDataTable()

DataTable Instance Callback

public actionDataTable() : mixed

Provides the data for the DataTables instance of the invoices overview.

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 —

actionFilterOptions()

Regenerate the filtering options and send them back to the client.

public actionFilterOptions() : JsonHttpControllerResponse

After some specific changes the table filtering options will need to be updated because they do not contain the required values from the table row. This method will use the InvoicesOverviewColumns class to fetch the latest state of the filtering options.

Return values
JsonHttpControllerResponse —

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 —

_getCurrencies()

Get the currencies with all settings like decimal point.

protected _getCurrencies() : array<string|int, 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.

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

_getRowData()

Set the <tr> row data.

protected _getRowData(InvoiceListItem $invoiceListItem) : array<string|int, mixed>

This method will return an array which will contain the data attributes of each row. These data are used in JS as follows: "$('tr').data('propertyName')".

Overload this method to provide your own data to the rows.

Parameters
$invoiceListItem : InvoiceListItem
Return values
array<string|int, mixed> —

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

_getTableData()

Get the table data.

protected _getTableData() : array<string|int, mixed>

This method will generate the data of the datatable instance. It can be overloaded in order to contain extra data e.g. for a new column. The filtering of custom columns must be also done manually.

Return values
array<string|int, 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
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