CartController
extends HttpViewController
in package
Class CartController
Tags
Table of Contents
- $assets : AssetCollectionInterface
- $contentView : ContentViewInterface
- $httpContextReader : HttpContextReaderInterface
- $httpResponseProcessor : HttpResponseProcessorInterface
- $postDataArray : array<string|int, mixed>
- $productErrorMessages : array<string|int, mixed>
- $queryParametersArray : array<string|int, mixed>
- $serverDataArray : array<string|int, mixed>
- $showCart : bool
- $showDetails : bool
- $turboBuyNow : bool
- __construct() : mixed
- actionAdd() : JsonHttpControllerResponse
- actionBuyProduct() : JsonHttpControllerResponse
- actionDefault() : JsonHttpControllerResponse
- Default action method.
- actionDelete() : JsonHttpControllerResponse
- actionDoNotUseBalance() : RedirectHttpControllerResponse
- Sets the session variable to not use customer voucher
- actionRedeemGift() : JsonHttpControllerResponse
- actionRedeemGiftCouponCode() : mixed
- actionRemoveVoucherByCode() : mixed
- actionUpdate() : JsonHttpControllerResponse
- actionUseBalance() : RedirectHttpControllerResponse
- Sets the session variable to use customer voucher
- proceed() : mixed
- Processes a http response object which is get by invoking an action method.
- _callActionMethod() : HttpControllerResponseInterface
- Invokes an action method by the given action name.
- _getCartContentView() : ShoppingCartContentViewInterface
- Returns an initialized ShoppingCartContentView object
- _getCartJson() : array<string|int, mixed>
- Builds a JSON array that contains the HTML snippets to build the current shopping cart
- _getContents() : array<string|int, mixed>
- Gets a JSON array of HTML snippets to build the content of the current shopping cart apart from its products.
- _getGiftCartContent() : mixed|string
- Gets the HTML for the content of the voucher redeem modal
- _getGiftContents() : array<string|int, mixed>
- Gets a JSON array that contains the HTML snippet for the content of the voucher redeem modal
- _getGiftJson() : array<string|int, mixed>
- Builds a JSON array that contains the HTML snippets to build the voucher redeem modal
- _getGiftLayer() : mixed|string
- Gets th HTML for the voucher redeem modal
- _getInfoMessages() : string
- Gets the HTML for all info messages.
- _getMessages() : mixed|string
- Gets the HTML for all messages/warnings
- _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.
- _getProductErrorMessages() : array<string|int, mixed>
- Gets the HTML for all product related messages.
- _getProducts() : array<string|int, mixed>
- Gets a JSON array of HTML snippets to build the product listing of the current shopping cart content
- _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.
- _getShippingInformation() : mixed|string
- Gets the HTML for the shipping information
- _getShoppingCartButton() : mixed|string
- Gets the HTML for all available checkout buttons
- _getTotals() : mixed|string
- Gets the HTML for the totals block
- _performAction() : bool
- _render() : string
- Renders and returns a template file.
- _tearDownTemporarySessionData() : mixed
- Resets some session data that is set within the build methods of the content views
- _validatePageToken() : mixed
- Check if the $_POST['pageToken'] or $_GET['pageToken'] variable is provided and if it's valid.
- getCouponDetailsByCode() : mixed
- 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.
Properties
$assets
protected
AssetCollectionInterface
$assets
$contentView
protected
ContentViewInterface
$contentView
$httpContextReader
protected
HttpContextReaderInterface
$httpContextReader
$httpResponseProcessor
protected
HttpResponseProcessorInterface
$httpResponseProcessor
$postDataArray
protected
array<string|int, mixed>
$postDataArray
$productErrorMessages
protected
array<string|int, mixed>
$productErrorMessages
$queryParametersArray
protected
array<string|int, mixed>
$queryParametersArray
$serverDataArray
protected
array<string|int, mixed>
$serverDataArray
$showCart
protected
bool
$showCart
= alse
$showDetails
protected
bool
$showDetails
= alse
$turboBuyNow
protected
bool
$turboBuyNow
= rue
Methods
__construct()
public
__construct(HttpContextReaderInterface $httpContextReader, HttpResponseProcessorInterface $httpResponseProcessor, ContentViewInterface $defaultContentView) : mixed
Parameters
- $httpContextReader : HttpContextReaderInterface
- $httpResponseProcessor : HttpResponseProcessorInterface
- $defaultContentView : ContentViewInterface
Return values
mixed —actionAdd()
public
actionAdd() : JsonHttpControllerResponse
Tags
Return values
JsonHttpControllerResponse —actionBuyProduct()
public
actionBuyProduct() : JsonHttpControllerResponse
Tags
Return values
JsonHttpControllerResponse —actionDefault()
Default action method.
public
actionDefault() : JsonHttpControllerResponse
Tags
Return values
JsonHttpControllerResponse —actionDelete()
public
actionDelete() : JsonHttpControllerResponse
Tags
Return values
JsonHttpControllerResponse —actionDoNotUseBalance()
Sets the session variable to not use customer voucher
public
actionDoNotUseBalance() : RedirectHttpControllerResponse
Return values
RedirectHttpControllerResponse —actionRedeemGift()
public
actionRedeemGift() : JsonHttpControllerResponse
Tags
Return values
JsonHttpControllerResponse —actionRedeemGiftCouponCode()
public
actionRedeemGiftCouponCode() : mixed
Return values
mixed —actionRemoveVoucherByCode()
public
actionRemoveVoucherByCode() : mixed
Return values
mixed —actionUpdate()
public
actionUpdate() : JsonHttpControllerResponse
Tags
Return values
JsonHttpControllerResponse —actionUseBalance()
Sets the session variable to use customer voucher
public
actionUseBalance() : RedirectHttpControllerResponse
Return values
RedirectHttpControllerResponse —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 —_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.
_getCartContentView()
Returns an initialized ShoppingCartContentView object
protected
_getCartContentView() : ShoppingCartContentViewInterface
Return values
ShoppingCartContentViewInterface —_getCartJson()
Builds a JSON array that contains the HTML snippets to build the current shopping cart
protected
_getCartJson() : array<string|int, mixed>
Return values
array<string|int, mixed> —JSON array of the current shopping cart
_getContents()
Gets a JSON array of HTML snippets to build the content of the current shopping cart apart from its products.
protected
_getContents(ShoppingCartContentViewInterface $shoppingCartContentView) : array<string|int, mixed>
Parameters
- $shoppingCartContentView : ShoppingCartContentViewInterface
Return values
array<string|int, mixed> —JSON array of the informational content (without products) of the shopping cart
_getGiftCartContent()
Gets the HTML for the content of the voucher redeem modal
protected
_getGiftCartContent() : mixed|string
Return values
mixed|string —_getGiftContents()
Gets a JSON array that contains the HTML snippet for the content of the voucher redeem modal
protected
_getGiftContents(ShoppingCartContentViewInterface $shoppingCartContentView) : array<string|int, mixed>
Parameters
- $shoppingCartContentView : ShoppingCartContentViewInterface
Return values
array<string|int, mixed> —JSON array of the contents
_getGiftJson()
Builds a JSON array that contains the HTML snippets to build the voucher redeem modal
protected
_getGiftJson() : array<string|int, mixed>
Return values
array<string|int, mixed> —JSON array of the contents
_getGiftLayer()
Gets th HTML for the voucher redeem modal
protected
_getGiftLayer() : mixed|string
Return values
mixed|string —_getInfoMessages()
Gets the HTML for all info messages.
protected
_getInfoMessages(ShoppingCartContentViewInterface $shoppingCartContentView) : string
Parameters
- $shoppingCartContentView : ShoppingCartContentViewInterface
Return values
string —_getMessages()
Gets the HTML for all messages/warnings
protected
_getMessages(ShoppingCartContentViewInterface $shoppingCartContentView) : mixed|string
Parameters
- $shoppingCartContentView : ShoppingCartContentViewInterface
Return values
mixed|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 —_getProductErrorMessages()
Gets the HTML for all product related messages.
protected
_getProductErrorMessages(ShoppingCartContentViewInterface $shoppingCartContentView) : array<string|int, mixed>
Parameters
- $shoppingCartContentView : ShoppingCartContentViewInterface
Return values
array<string|int, mixed> —_getProducts()
Gets a JSON array of HTML snippets to build the product listing of the current shopping cart content
protected
_getProducts(OrderDetailsCartContentViewInterface $orderDetailsCartContentView) : array<string|int, mixed>
Parameters
- $orderDetailsCartContentView : OrderDetailsCartContentViewInterface
Return values
array<string|int, mixed> —JSON array of the shopping cart content
_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.
_getShippingInformation()
Gets the HTML for the shipping information
protected
_getShippingInformation() : mixed|string
Return values
mixed|string —_getShoppingCartButton()
Gets the HTML for all available checkout buttons
protected
_getShoppingCartButton(ShoppingCartContentViewInterface $shoppingCartContentView) : mixed|string
Parameters
- $shoppingCartContentView : ShoppingCartContentViewInterface
Return values
mixed|string —_getTotals()
Gets the HTML for the totals block
protected
_getTotals(OrderDetailsCartContentViewInterface $orderDetailsCartContentView) : mixed|string
Parameters
- $orderDetailsCartContentView : OrderDetailsCartContentViewInterface
Return values
mixed|string —_performAction()
protected
_performAction(string $p_action) : bool
Parameters
- $p_action : string
Return values
bool —_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.
_tearDownTemporarySessionData()
Resets some session data that is set within the build methods of the content views
protected
_tearDownTemporarySessionData() : mixed
Return values
mixed —_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 —getCouponDetailsByCode()
protected
getCouponDetailsByCode(NonEmptyStringType $couponCode) : mixed
Parameters
- $couponCode : NonEmptyStringType
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
Return values
ExistingFile —containing absolute file path to the given template file