AJAX controller for the orders main page.
|
category
|
System
|
|
package
|
AdminHttpViewControllers
|
|
extends
|
AdminHttpViewController
|
Methods
__construct
__construct(\HttpContextReaderInterface $httpContextReader, \HttpResponseProcessorInterface $httpResponseProcessor, \ContentViewInterface $defaultContentView)
inherited
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
stringName of action method to call, without 'action'-Suffix.
Response
\HttpControllerResponseInterfaceResponse message.
Get the filtered record count of the "orders" table.
_getFilteredRecordCount() : integer
|
|
|
| Throws |
- \BadMethodCallException
- \InvalidArgumentException
|
Response
integer
Parse the DataTable request and fetch the OrderListItems that need to be displayed.
_getOrderListItems() : \OrderListItemCollection
|
|
|
| Throws |
- \InvalidArgumentException
- \Exception
|
Response
\OrderListItemCollectionReturns the collection with the OrderListItem instances.
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
stringExpected key of post parameter.
Response
string|nullEither the expected value or null, of not found.
Creates and returns a key value collection which represent the global $_POST array.
_getPostDataCollection() : \KeyValueCollection
inherited
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
stringExpected key of query parameter.
Response
mixed|nullEither the expected value or null, of not found.
Creates and returns a key value collection which represent the global $_GET array.
_getQueryParametersCollection() : \KeyValueCollection
inherited
Set the <tr> row data.
_getRowData(\OrderListItem $orderListItem, integer $latestInvoiceId, integer $latestInvoiceNumber = null) : array
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.
Arguments
$latestInvoiceNumber
integer
Response
array
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
stringExpected key of server parameter.
Response
string|nullEither the expected value or null, of not found.
Get the table data.
_getTableData() : array
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.
|
|
|
| Throws |
- \InvalidArgumentException
- \Exception
|
Response
array
Get the total record count of the "orders" table.
_getTotalRecordCount() : integer
Renders and returns a template file.
_render(string $templateFile, array $contentArray) : string
inherited
Arguments
$templateFile
stringTemplate file to render.
$contentArray
arrayContent array which represent the variables of the template.
Response
stringRendered 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.
DataTable Instance Callback
actionDataTable()
Provides the data for the DataTables instance of the orders main view.
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
Regenerate the filtering options and send them back to the client.
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 OrdersOverviewColumns class to fetch the
latest state of the filtering options.
Response
\JsonHttpControllerResponse
Returns an array of invoices data for an order.
actionGetInvoices() : \JsonHttpControllerResponse
Get the latest packing slip information.
actionGetLatestPackingSlip() : \JsonHttpControllerResponse
actionGetOrdersWithoutDocuments
actionGetOrdersWithoutDocuments()
getSorters
getSorters(\DataTableColumnCollection $columns) : array
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
stringThe relative path and filename to search for
Response
\ExistingFilecontaining absolute file path to the given template file
Initialize Controller
init()
|
|
|
|
|
|
| Throws |
- \Exception
- \InvalidArgumentException
|
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
Makes sure that the admin status is currently given in session
validateCurrentAdminStatus()
inherited
Properties
db
db : \CI_DB_query_builder
Type(s)
\CI_DB_query_builder
orderReadService
orderReadService : \OrderReadService
dataTableHelper
dataTableHelper : \DataTableHelper
ordersOverviewColumns
ordersOverviewColumns : \OrdersOverviewColumns
httpContextReader
httpContextReader : \HttpContextReaderInterface
inherited
httpResponseProcessor
httpResponseProcessor : \HttpResponseProcessorInterface
inherited
contentView
contentView : \ContentViewInterface
inherited
queryParametersArray
queryParametersArray : array
inherited
postDataArray
postDataArray : array
inherited
Contain the assets needed to be included in the view HTML.
assets : \AssetCollectionInterface
inherited
Server data.
serverDataArray : array
inherited