Overview
  • Package
  • Class
  • Tree
  • Todo

Packages

  • AddonValue
    • Interfaces
  • AdminHttpViewControllers
  • ApiV2Controllers
  • Category
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • Customer
    • Address
    • Country
    • CountryZone
    • Interfaces
    • Storages
    • Validation
    • ValueObjects
  • Email
    • Collections
    • Entities
    • Exceptions
    • Interfaces
    • Repository
    • ValueObjects
  • Extensions
    • Customers
    • Emails
    • Helpers
    • Orders
    • Serializers
  • Http
    • Collections
    • Exceptions
    • Factories
    • Interfaces
    • ValueObjects
  • HttpViewControllers
  • InfoBox
    • Interfaces
  • Invoice
    • Interfaces
    • ValueObjects
  • Loaders
    • CrossCuttingLoader
    • GXCoreLoader
    • Interfaces
  • Modules
    • Collections
    • Controllers
    • Interfaces
  • Order
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
    • ValueObjects
  • Product
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • ProductModule
    • Collections
    • Deleter
    • Entities
    • Factories
    • Interface
    • Interfaces
    • Reader
    • Repositories
    • Writer
  • Shared
    • ClassFinder
    • Exceptions
    • FileSystem
    • Interfaces
    • Storage
    • Types
  • SharedShoppingCart
    • Interfaces
  • Statistics
    • Interfaces
  • UserConfiguration
    • Interfaces
    • Repository

Classes

  • AdminFavoritesAjaxController
  • AdminInfoBoxAjaxController
  • AfterbuyAjaxController
  • DashboardController
  • DynamicShopMessagesController
  • EmailsController
  • EmbeddedModuleController
  • ImageProcessingController
  • InvoicesController
  • LawsController
  • MaxFileSizeController
  • ModuleCenterController
  • NewAttributesController
  • OrdersModalsAjaxController
  • OrdersOverviewAjaxController
  • OrdersOverviewController
  • OrderTooltipController
  • PackedDownloadController
  • ShopKeyController
  • TemplateConfigurationController
  • UserConfigurationController

Class OrdersOverviewAjaxController

Class OrdersAjaxController

AJAX controller for the orders main page.

HttpViewController implements HttpViewControllerInterface
Extended by AdminHttpViewController implements AdminStatusOnlyInterface
Extended by OrdersOverviewAjaxController
Package: AdminHttpViewControllers
Category: System
Extends: AdminHttpViewController
Located at Controllers/HttpView/AdminAjax/OrdersOverviewAjaxController.inc.php

Methods summary

row data.

Set the

row data.

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

$orderListItem

Returns

array
public
# init( )

Initialize Controller

Initialize Controller

Throws

Exception
InvalidArgumentException
public
# actionDataTable( )

DataTable Instance Callback

DataTable Instance Callback

Provides the data for the DataTables instance of the orders main view.

public JsonHttpControllerResponse
# actionTooltips( )

DataTable Tooltips Rendering

DataTable Tooltips Rendering

This method will use the OrdersOverviewTooltips class to render all the tooltips of the current view.

Returns

JsonHttpControllerResponse
public JsonHttpControllerResponse
# actionFilterOptions( )

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

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

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.

Returns

JsonHttpControllerResponse
protected OrderListItemCollection
# _getOrderListItems( )

Parse the DataTable request and fetch the OrderListItems that need to be displayed.

Parse the DataTable request and fetch the OrderListItems that need to be displayed.

Returns

OrderListItemCollection
Returns the collection with the OrderListItem instances.

Throws

InvalidArgumentException
Exception
protected array
# _getTableData( )

Get the table data.

Get the table data.

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.

Returns

array

Throws

InvalidArgumentException
Exception
protected array
# _getRowData( OrderListItem $orderListItem )

Set the

protected integer
# _getTotalRecordCount( )

Get the total record count of the "orders" table.

Get the total record count of the "orders" table.

Returns

integer
protected integer
# _getFilteredRecordCount( )

Get the filtered record count of the "orders" table.

Get the filtered record count of the "orders" table.

Returns

integer

Throws

BadMethodCallException
InvalidArgumentException

Methods inherited from AdminHttpViewController

validateCurrentAdminStatus()

Methods inherited from HttpViewController

__construct(), _callActionMethod(), _getPostData(), _getPostDataCollection(), _getQueryParameter(), _getQueryParametersCollection(), _render(), _validatePageToken(), actionDefault(), proceed()

Properties summary

protected CI_DB_query_builder $db
#
protected OrderReadService $orderReadService
#
protected DataTableHelper $dataTableHelper
#
protected OrdersOverviewColumns $ordersOverviewColumns
#
protected OrdersOverviewTooltips $ordersOverviewTooltips
#

Properties inherited from HttpViewController

$assets, $contentView, $httpContextReader, $httpResponseProcessor, $postDataArray, $queryParametersArray

API documentation generated by ApiGen