API Documentation
Back to top  

QuickEditOverviewAjaxController

Extends \AdminHttpViewController

Class QuickEditOverviewAjaxController

This class contains some helper methods for handling view requests. Be careful always when outputting raw user data to HTML or when handling POST requests because insufficient protection will lead to XSS and CSRF vulnerabilities.

category

System
package

AdminHttpViewControllers

Methods

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

Taking into account the filters, the number of products is supplied.

_getFilteredProductsCount() : array

Response

array

Returns the number of products.

Provides the configuration for the manufacturer.

_getManufacturerConfiguration() : array

Response

array

Returns the query result as a pure array, or an empty array when no result is produced.

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 special prices for the existing products.

_getProductGraduatedPrices() : array

Response

array

Returns the special prices for the existing products.

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 number of existing products.

_getRecordsTotal() : integer

Response

integer

Returns the number of existing products.

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.

Provides the configuration for the shipping.

_getShipmentConfiguration() : array

Response

array

Returns the query result as a pure array, or an empty array when no result is produced.

Returns the QuickEdit overview table data.

_getTableData() : array

Response

array

Returns the QuickEdit overview table data.

Returns the various data needed to display one row of the table.

_getTableRowData(\QuickEditProductListItem $product) : array

Arguments

$product

\QuickEditProductListItem

Contains product information.

Response

array

Returns the various data needed to display one row of the table as an array.

Returns the configuration for the tax rates.

_getTaxConfiguration() : array

Response

array

Returns the query result as a pure array, or an empty array when no result is produced.

Returns the tax rate for the specified product.

_getTaxRate(integer $productsId) : mixed

Arguments

$productsId

integer

Requested product ID connected to tax rate.

Response

mixed

Returns an object that contains the tax rate of a product.

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.

Creates inventory list PDF.

actionCreateInventoryFile() : boolean|\JsonHttpControllerResponse

Response

boolean|\JsonHttpControllerResponse

Returns PDF creation status.

Returns all the data for the DataTables instance of the QuickEdit main view.

actionDataTable() : boolean|\JsonHttpControllerResponse

Response

boolean|\JsonHttpControllerResponse

Returns QuickEdit overview table data.

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

actionDownloadInventoryFile

actionDownloadInventoryFile()

Returns the filter options for the overview page in JSON format.

actionFilterOptions() : boolean|\JsonHttpControllerResponse

Response

boolean|\JsonHttpControllerResponse

Returns filter options in JSON format.

Returns the graduted prices for the overview page in JSON format.

actionProductGraduatedPrices() : boolean|\JsonHttpControllerResponse

Response

boolean|\JsonHttpControllerResponse

Returns the graduated prices information in JSON format.

Saves graduated prices of product.

actionSaveGraduatedPrices() : boolean|\JsonHttpControllerResponse
Throws
\Exception

If request does not have "customerStatuses" parameter.

Response

boolean|\JsonHttpControllerResponse

Returns the operation status.

Returns the tooltips for the overview page in JSON format.

actionTooltips() : boolean|\JsonHttpControllerResponse

Response

boolean|\JsonHttpControllerResponse

Returns tooltips data in JSON format.

Updates product information.

actionUpdate() : boolean|\JsonHttpControllerResponse

Response

boolean|\JsonHttpControllerResponse

Returns the operation status.

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

Initializes the required objects.

init()

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

Properties

db

db : \CI_DB_query_builder
var

Type(s)

\CI_DB_query_builder

quickEditProductReadService

quickEditProductReadService : \QuickEditProductReadService
var

Type(s)

\QuickEditProductReadService

quickEditService

quickEditService : \QuickEditService
var

Type(s)

\QuickEditService

quickEditProductWriteService

quickEditProductWriteService : \QuickEditProductWriteService
var

Type(s)

\QuickEditProductWriteService

quickEditOverviewColumns

quickEditOverviewColumns : \QuickEditOverviewColumns
var

Type(s)

\QuickEditOverviewColumns

quickEditOverviewTooltips

quickEditOverviewTooltips : \QuickEditOverviewTooltips
var

Type(s)

\QuickEditOverviewTooltips

dataTableHelper

dataTableHelper : \DataTableHelper
var

Type(s)

\DataTableHelper

userConfigurationService

userConfigurationService : \UserConfigurationService
var

Type(s)

\UserConfigurationService

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