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.
|
extends
|
HttpViewController
|
|
category
|
System
|
|
package
|
HttpViewControllers
|
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.
Returns an initialized ShoppingCartContentView object
_getCartContentView() : \ShoppingCartContentViewInterface
Response
\ShoppingCartContentViewInterface
Builds a JSON array that contains the HTML snippets to build the current shopping cart
_getCartJson() : array
Response
arrayJSON array of the current shopping cart
Gets a JSON array of HTML snippets to build the content of the current shopping cart apart from its products.
_getContents(\ShoppingCartContentViewInterface $shoppingCartContentView) : array
Arguments
$shoppingCartContentView
\ShoppingCartContentViewInterface
Response
arrayJSON array of the informational content (without products) of the shopping cart
Gets the HTML for the content of the voucher redeem modal
_getGiftCartContent() : mixed|string
Gets a JSON array that contains the HTML snippet for the content of the voucher redeem modal
_getGiftContents(\ShoppingCartContentViewInterface $shoppingCartContentView) : array
Arguments
$shoppingCartContentView
\ShoppingCartContentViewInterface
Response
arrayJSON array of the contents
Builds a JSON array that contains the HTML snippets to build the voucher redeem modal
_getGiftJson() : array
Response
arrayJSON array of the contents
Gets th HTML for the voucher redeem modal
_getGiftLayer() : mixed|string
Gets the HTML for all info messages.
_getInfoMessages(\ShoppingCartContentViewInterface $shoppingCartContentView) : string
Arguments
$shoppingCartContentView
\ShoppingCartContentViewInterface
Response
string
Gets the HTML for all messages/warnings
_getMessages(\ShoppingCartContentViewInterface $shoppingCartContentView) : mixed|string
Arguments
$shoppingCartContentView
\ShoppingCartContentViewInterface
Response
mixed|string
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
Gets the HTML for all product related messages.
_getProductErrorMessages(\ShoppingCartContentViewInterface $shoppingCartContentView) : array
Arguments
$shoppingCartContentView
\ShoppingCartContentViewInterface
Response
array
Gets a JSON array of HTML snippets to build the product listing of the current shopping cart content
_getProducts(\OrderDetailsCartContentViewInterface $orderDetailsCartContentView) : array
Arguments
$orderDetailsCartContentView
\OrderDetailsCartContentViewInterface
Response
arrayJSON array of the shopping cart content
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
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.
Gets the HTML for the totals block
_getTotals(\OrderDetailsCartContentViewInterface $orderDetailsCartContentView) : mixed|string
Arguments
$orderDetailsCartContentView
\OrderDetailsCartContentViewInterface
Response
mixed|string
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.
Resets some session data that is set within the build methods of the content views
_tearDownTemporarySessionData()
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.
actionAdd
actionAdd() : \JsonHttpControllerResponse
actionBuyProduct
actionBuyProduct() : \JsonHttpControllerResponse
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
actionDelete
actionDelete() : \JsonHttpControllerResponse
Sets the session variable to not use customer voucher
actionDoNotUseBalance() : \RedirectHttpControllerResponse
actionRedeemGift
actionRedeemGift() : \JsonHttpControllerResponse
actionRedeemGiftCouponCode
actionRedeemGiftCouponCode()
actionRemoveVoucherByCode
actionRemoveVoucherByCode()
actionUpdate
actionUpdate() : \JsonHttpControllerResponse
Sets the session variable to use customer voucher
actionUseBalance() : \RedirectHttpControllerResponse
getCouponDetailsByCode
getCouponDetailsByCode(\NonEmptyStringType $couponCode)
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
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
Properties
turboBuyNow
turboBuyNow : boolean
showCart
showCart : boolean
showDetails
showDetails : boolean
productErrorMessages
productErrorMessages : array
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