CheckStatusController
extends HttpViewController
in package
Class CheckStatusController
Tags
Table of Contents
- $assets : AssetCollectionInterface
- $contentView : ContentViewInterface
- $groupRepositoryFactory : GroupRepositoryFactory
- $httpContextReader : HttpContextReaderInterface
- $httpResponseProcessor : HttpResponseProcessorInterface
- $modifierGroups : mixed
- $postDataArray : array<string|int, mixed>
- $queryParametersArray : array<string|int, mixed>
- $readService : ProductImageListReadServiceInterface
- $sellingUnit : SellingUnitInterface
- $sellingUnitId : mixed
- $serverDataArray : array<string|int, mixed>
- $xtcPrice : xtcPrice_ORIGIN
- __construct() : mixed
- actionAttributes() : HttpControllerResponse
- actionDefault() : HttpControllerResponse
- Default action method.
- proceed() : mixed
- Processes a http response object which is get by invoking an action method.
- requestedQuantity() : QuantityInterface
- sellingUnit() : SellingUnitInterface
- sellingUnitId() : SellingUnitId
- _callActionMethod() : HttpControllerResponseInterface
- Invokes an action method by the given action name.
- _formatPrice() : string
- _get_cart_quantity() : int
- _get_product_galleries_html() : mixed
- _getAttributesImagesData() : array<string|int, mixed>
- _getAttributesImagesHtml() : mixed
- _getAttributesPrice() : mixed
- _getAttributesResponseArray() : array<string|int, mixed>
- _getAttributeStockChecker() : array<string|int, mixed>
- _getAttributesWeight() : mixed
- _getDiscount() : string
- _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.
- _getPropertiesResponseArray() : array<string|int, mixed>
- _getQuantityChecker() : string
- _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.
- _getServerData() : string|null
- Returns the expected $_SERVER value by the given key name.
- _getStockChecker() : array<string|int, mixed>
- _initialize_from_modifiers() : mixed
- Parses the new modifiers data structure to the current (old) way
- _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.
- buildVpeHtml() : string
- createModifierGroupsThemeContentView() : ModifierGroupsThemeContentView
- getCombiModelAndProductsId() : CombiModelAndProductsIdDtoInterface
- getIndexOfFirstNewImage() : false|int|string
- getInitialSlideIndex() : int
- Returns the index of the first relevant image in the gallery for preselecting it in the gallery after selecting a product option on the product detail page.
- getPreviousImages() : SellingUnitImageCollectionInterface
- getSelectionHtmlTheme() : string|array<string|int, string>
- getSelectionTemplate() : object
- getSellingUnitWeightValue() : float|string
- 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.
- groupRepositoryFactory() : GroupRepositoryFactory
- modifierGroups() : GroupCollectionInterface
- parsePropertyValuesAsString() : string
- readService() : ProductImageListReadServiceInterface
- replaceGallery() : bool
- sortModifiers() : array<string|int, mixed>
- Sort the attribute modifiers reflecting the sort order stored in the database
- customerGroupIsAllowedToViewPrices() : bool
- getXtcPrice() : xtcPrice_ORIGIN
Properties
$assets
protected
AssetCollectionInterface
$assets
$contentView
protected
ContentViewInterface
$contentView
$groupRepositoryFactory
protected
GroupRepositoryFactory
$groupRepositoryFactory
$httpContextReader
protected
HttpContextReaderInterface
$httpContextReader
$httpResponseProcessor
protected
HttpResponseProcessorInterface
$httpResponseProcessor
$modifierGroups
protected
mixed
$modifierGroups
$postDataArray
protected
array<string|int, mixed>
$postDataArray
$queryParametersArray
protected
array<string|int, mixed>
$queryParametersArray
$readService
protected
ProductImageListReadServiceInterface
$readService
$sellingUnit
protected
SellingUnitInterface
$sellingUnit
$sellingUnitId
protected
mixed
$sellingUnitId
$serverDataArray
protected
array<string|int, mixed>
$serverDataArray
$xtcPrice
protected
xtcPrice_ORIGIN
$xtcPrice
Methods
__construct()
public
__construct(HttpContextReaderInterface $httpContextReader, HttpResponseProcessorInterface $httpResponseProcessor, ContentViewInterface $defaultContentView) : mixed
Parameters
- $httpContextReader : HttpContextReaderInterface
- $httpResponseProcessor : HttpResponseProcessorInterface
- $defaultContentView : ContentViewInterface
Return values
mixed —actionAttributes()
public
actionAttributes() : HttpControllerResponse
Tags
Return values
HttpControllerResponse —actionDefault()
Default action method.
public
actionDefault() : HttpControllerResponse
Tags
Return values
HttpControllerResponse —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
Return values
mixed —requestedQuantity()
public
requestedQuantity() : QuantityInterface
Return values
QuantityInterface —sellingUnit()
public
sellingUnit() : SellingUnitInterface
Tags
Return values
SellingUnitInterface —sellingUnitId()
public
sellingUnitId() : SellingUnitId
Tags
Return values
SellingUnitId —_callActionMethod()
Invokes an action method by the given action name.
protected
_callActionMethod(string $actionName) : HttpControllerResponseInterface
Parameters
- $actionName : string
-
Name of action method to call, without 'action'-Suffix.
Tags
Return values
HttpControllerResponseInterface —Response message.
_formatPrice()
protected
_formatPrice( $price, StoredProductInterface $product) : string
Parameters
- $price :
- $product : StoredProductInterface
Return values
string —_get_cart_quantity()
protected
_get_cart_quantity( $product_id, $properties) : int
Parameters
Return values
int —_get_product_galleries_html()
protected
_get_product_galleries_html( $product, SellingUnitImageCollectionInterface $images) : mixed
Parameters
Return values
mixed —_getAttributesImagesData()
protected
_getAttributesImagesData() : array<string|int, mixed>
Return values
array<string|int, mixed> —_getAttributesImagesHtml()
protected
_getAttributesImagesHtml(AttributesAjaxHandler $ajaxHandler) : mixed
Parameters
- $ajaxHandler : AttributesAjaxHandler
Return values
mixed —_getAttributesPrice()
protected
_getAttributesPrice(AttributesAjaxHandler $ajaxHandler) : mixed
Parameters
- $ajaxHandler : AttributesAjaxHandler
Return values
mixed —_getAttributesResponseArray()
protected
_getAttributesResponseArray(string $p_weight, string $p_price, string $p_images, string $p_quantityChecker, string $stockChecker) : array<string|int, mixed>
Parameters
- $p_weight : string
- $p_price : string
- $p_images : string
- $p_quantityChecker : string
- $stockChecker : string
Return values
array<string|int, mixed> —_getAttributeStockChecker()
protected
_getAttributeStockChecker(AttributesAjaxHandler $ajaxHandler) : array<string|int, mixed>
Parameters
- $ajaxHandler : AttributesAjaxHandler
Return values
array<string|int, mixed> —_getAttributesWeight()
protected
_getAttributesWeight(AttributesAjaxHandler $ajaxHandler) : mixed
Parameters
- $ajaxHandler : AttributesAjaxHandler
Return values
mixed —_getDiscount()
protected
_getDiscount() : string
Return values
string —_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.
_getPostDataCollection()
Creates and returns a key value collection which represent the global $_POST array.
protected
_getPostDataCollection() : KeyValueCollection
Return values
KeyValueCollection —_getPropertiesResponseArray()
protected
_getPropertiesResponseArray(mixed $selectionTemplate, string $p_quantityChecker, StoredProductInterface $product) : array<string|int, mixed>
Parameters
- $selectionTemplate : mixed
- $p_quantityChecker : string
- $product : StoredProductInterface
Return values
array<string|int, mixed> —_getQuantityChecker()
protected
_getQuantityChecker(StoredProduct $product) : string
Parameters
- $product : StoredProduct
Return values
string —_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.
_getQueryParametersCollection()
Creates and returns a key value collection which represent the global $_GET array.
protected
_getQueryParametersCollection() : KeyValueCollection
Return values
KeyValueCollection —_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.
_getStockChecker()
protected
_getStockChecker(StoredProductInterface $product) : array<string|int, mixed>
Parameters
- $product : StoredProductInterface
Return values
array<string|int, mixed> —_initialize_from_modifiers()
Parses the new modifiers data structure to the current (old) way
protected
_initialize_from_modifiers() : mixed
Return values
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
Return values
mixed —buildVpeHtml()
protected
buildVpeHtml() : string
Tags
Return values
string —createModifierGroupsThemeContentView()
protected
createModifierGroupsThemeContentView(SellingUnitInterface $sellingUnit, CustomersStatusShowPrice $showPriceStatus) : ModifierGroupsThemeContentView
Parameters
- $sellingUnit : SellingUnitInterface
- $showPriceStatus : CustomersStatusShowPrice
Return values
ModifierGroupsThemeContentView —getCombiModelAndProductsId()
protected
getCombiModelAndProductsId(stdClass $selectionTemplate, StoredProductInterface $product) : CombiModelAndProductsIdDtoInterface
Parameters
- $selectionTemplate : stdClass
- $product : StoredProductInterface
Return values
CombiModelAndProductsIdDtoInterface —getIndexOfFirstNewImage()
protected
getIndexOfFirstNewImage(array<string|int, mixed> $imageUrls, array<string|int, mixed> $defaultImageUrls) : false|int|string
Parameters
- $imageUrls : array<string|int, mixed>
- $defaultImageUrls : array<string|int, mixed>
Return values
false|int|string —getInitialSlideIndex()
Returns the index of the first relevant image in the gallery for preselecting it in the gallery after selecting a product option on the product detail page.
protected
getInitialSlideIndex(ProductInterface $product, SellingUnitImageCollectionInterface $sellingUnitImages) : int
Parameters
- $product : ProductInterface
- $sellingUnitImages : SellingUnitImageCollectionInterface
Return values
int —getPreviousImages()
protected
getPreviousImages() : SellingUnitImageCollectionInterface
Tags
Return values
SellingUnitImageCollectionInterface —getSelectionHtmlTheme()
protected
getSelectionHtmlTheme() : string|array<string|int, string>
Tags
Return values
string|array<string|int, string> —getSelectionTemplate()
protected
getSelectionTemplate() : object
Tags
Return values
object —getSellingUnitWeightValue()
protected
getSellingUnitWeightValue() : float|string
Tags
Return values
float|string —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
Return values
ExistingFile —containing absolute file path to the given template file
groupRepositoryFactory()
protected
groupRepositoryFactory() : GroupRepositoryFactory
Return values
GroupRepositoryFactory —modifierGroups()
protected
modifierGroups() : GroupCollectionInterface
Tags
Return values
GroupCollectionInterface —parsePropertyValuesAsString()
protected
parsePropertyValuesAsString() : string
Return values
string —readService()
protected
readService() : ProductImageListReadServiceInterface
Return values
ProductImageListReadServiceInterface —replaceGallery()
protected
replaceGallery(string $hash) : bool
Parameters
- $hash : string
Return values
bool —sortModifiers()
Sort the attribute modifiers reflecting the sort order stored in the database
protected
sortModifiers(array<string|int, mixed> $queryModifiers, ProductId $productId) : array<string|int, mixed>
Parameters
- $queryModifiers : array<string|int, mixed>
- $productId : ProductId
Return values
array<string|int, mixed> —customerGroupIsAllowedToViewPrices()
private
customerGroupIsAllowedToViewPrices() : bool
Return values
bool —getXtcPrice()
private
getXtcPrice() : xtcPrice_ORIGIN