UserViewHelper
extends ViewHelper
in package
This is the UserViewHelper class.
The purpose of this class is to facilitate to Twig the generation of the user's view output (providing some useful methods).
This class extends ViewHelper, see this class.
Tags
Table of Contents
| $languageSheet | : Language|null | |
|---|---|---|
| $session | : Session|null | |
| $theme | : Theme|null | |
| __construct() | : mixed | |
| addressBookMacro() | This method merges the given arguments, calculates and returns the view parameters for the address book. | : array<string|int, mixed> |
| addressFormMacro() | This method merges the given arguments, calculates and returns the view parameters for the address book form. | : array<string|int, mixed> |
| buttonWishlistMacro() | This method merges the given arguments, calculates and returns the view parameters for the buttonWishlist. | : array<string|int, mixed> |
| changePasswordFormMacro() | This method merges the given arguments, calculates and returns the view parameters for the changePasswordForm. | : array<string|int, mixed> |
| closeOauthWindowMacro() | This method merges the given arguments, calculates and returns the view parameters for closeOauthWindow. | : array<string|int, mixed> |
| customerOrdersMacro() | This method merges the given arguments, calculates and returns the view parameters for the customerOrders. | : array<string|int, mixed> |
| deleteAccountFormMacro() | This method merges the given arguments, calculates and returns the view parameters for the deleteAccountForm. | : array<string|int, mixed> |
| deleteWishlistFormMacro() | This method merges the given arguments, calculates and returns the view parameters for the deleteWishlistForm. | : array<string|int, mixed> |
| getApplicationTaxesIncluded() | This method returns the setting of 'show taxes included'. | : bool |
| locationsPathMacro() | This method merges the given arguments, calculates and returns the view parameters for the locationsPath. | : array<string|int, mixed> |
| loginFormMacro() | This method merges the given arguments, calculates and returns the view parameters for the loginForm. | : array<string|int, mixed> |
| lostPasswordFormMacro() | This method merges the given arguments, calculates and returns the view parameters for the lostPasswordForm. | : array<string|int, mixed> |
| mergeArguments() | This method merges macro arguments with macro associated class properties by reference. | : void |
| OrderRmasMacro() | This method merges the given arguments, calculates and returns the view parameters for the orderRmas. | : array<string|int, mixed> |
| orderShipmentsMacro() | This method merges the given arguments, calculates and returns the view parameters for the order shipments. | : array<string|int, mixed> |
| ordersMacro() | This method merges the given arguments, calculates and returns the view parameters for the orders. | : array<string|int, mixed> |
| orderTrackingsMacro() | This method merges the given arguments, calculates and returns the view parameters for the order trackings. | : array<string|int, mixed> |
| panelMacro() | This method merges the given arguments, calculates and returns the view parameters for the panel. | : array<string|int, mixed> |
| paymentCards() | This method merges the given arguments, calculates and returns the view parameters for the payment cards. | : array<string|int, mixed> |
| redeemRewardPointsMacro() | This method merges the given arguments, calculates and returns the view parameters for the redeemRewardPoints. | : array<string|int, mixed> |
| returnRequestFormMacro() | This method merges the given arguments, calculates and returns the view parameters for the returnRequestForm. | : array<string|int, mixed> |
| rmasMacro() | This method merges the given arguments, calculates and returns the view parameters for the rmas. | : array<string|int, mixed> |
| salesAgentCustomersFormMacro() | This method merges the given arguments, calculates and returns the view parameters for the salesAgentCustomersForm. | : array<string|int, mixed> |
| salesAgentCustomersMacro() | This method merges the given arguments, calculates and returns the view parameters for the salesAgentCustomers. | : array<string|int, mixed> |
| salesAgentSalesFormMacro() | This method merges the given arguments, calculates and returns the view parameters for the salesAgentSalesForm. | : array<string|int, mixed> |
| salesAgentSalesMacro() | This method merges the given arguments, calculates and returns the view parameters for the salesAgentSales. | : array<string|int, mixed> |
| sendWishlistFormMacro() | This method merges the given arguments, calculates and returns the view parameters for the sendWishlistForm. | : array<string|int, mixed> |
| smallNewsletterFormMacro() | This method merges the given arguments, calculates and returns the view parameters for the smallNewsletterForm. | : array<string|int, mixed> |
| stockAlertsMacro() | This method merges the given arguments, calculates and returns the view parameters for the stockAlerts. | : array<string|int, mixed> |
| userFormMacro() | This method merges the given arguments, calculates and returns the view parameters for the user form. | : array<string|int, mixed> |
Properties
$languageSheet
protected
Language|null
$languageSheet
= null
$session
protected
Session|null
$session
= null
$theme
protected
Theme|null
$theme
= null
Methods
__construct()
public
__construct(Language $languageSheet, Theme $theme, Session|null $session) : mixed
Parameters
Return values
mixed —addressBookMacro()
This method merges the given arguments, calculates and returns the view parameters for the address book.
public
addressBookMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- billingAddresses
- shippingAddresses
- defaultUserType
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —addressFormMacro()
This method merges the given arguments, calculates and returns the view parameters for the address book form.
public
addressFormMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- form
- selectedCountry
- selectedCountryLocations
- prefix
- defaultUserType
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —buttonWishlistMacro()
This method merges the given arguments, calculates and returns the view parameters for the buttonWishlist.
public
buttonWishlistMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- type
- class
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —changePasswordFormMacro()
This method merges the given arguments, calculates and returns the view parameters for the changePasswordForm.
public
changePasswordFormMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- form
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —closeOauthWindowMacro()
This method merges the given arguments, calculates and returns the view parameters for closeOauthWindow.
public
closeOauthWindowMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- items
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —customerOrdersMacro()
This method merges the given arguments, calculates and returns the view parameters for the customerOrders.
public
customerOrdersMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- orders
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —deleteAccountFormMacro()
This method merges the given arguments, calculates and returns the view parameters for the deleteAccountForm.
public
deleteAccountFormMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- form
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —deleteWishlistFormMacro()
This method merges the given arguments, calculates and returns the view parameters for the deleteWishlistForm.
public
deleteWishlistFormMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- form
- products
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —getApplicationTaxesIncluded()
This method returns the setting of 'show taxes included'.
public
static getApplicationTaxesIncluded() : bool
Return values
bool —locationsPathMacro()
This method merges the given arguments, calculates and returns the view parameters for the locationsPath.
public
locationsPathMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- fieldName
- selectedIds
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —loginFormMacro()
This method merges the given arguments, calculates and returns the view parameters for the loginForm.
public
loginFormMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- form
- showLabel
- showPlaceholder
- redirect
- lostPasswordRedirect
- registerRedirect
- useCaptcha
- showCaptchaLabel
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —lostPasswordFormMacro()
This method merges the given arguments, calculates and returns the view parameters for the lostPasswordForm.
public
lostPasswordFormMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- form
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —mergeArguments()
This method merges macro arguments with macro associated class properties by reference.
public
static mergeArguments(mixed &$classObject[, array<string|int, mixed> $arguments = [] ]) : void
Parameters
- $classObject : mixed
- $arguments : array<string|int, mixed> = []
Return values
void —OrderRmasMacro()
This method merges the given arguments, calculates and returns the view parameters for the orderRmas.
public
OrderRmasMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- rmas
- userId
- showRmasActions
- showRmasIcons
- orderId
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —orderShipmentsMacro()
This method merges the given arguments, calculates and returns the view parameters for the order shipments.
public
orderShipmentsMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- order
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —ordersMacro()
This method merges the given arguments, calculates and returns the view parameters for the orders.
public
ordersMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- orders
- userId
- showOrderStates
- showOrderActions
- showOrderIcons
- documentView
- returnProductsView
- returnTracingView
- showStatus
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —orderTrackingsMacro()
This method merges the given arguments, calculates and returns the view parameters for the order trackings.
public
orderTrackingsMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- shipments
- itemClass
- showContainer
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —panelMacro()
This method merges the given arguments, calculates and returns the view parameters for the panel.
public
panelMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- itemsList
- keys
- icons
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —paymentCards()
This method merges the given arguments, calculates and returns the view parameters for the payment cards.
public
paymentCards([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- paymentSystems
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —redeemRewardPointsMacro()
This method merges the given arguments, calculates and returns the view parameters for the redeemRewardPoints.
public
redeemRewardPointsMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- rewardPoints
- showPending
- showDistribution
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —returnRequestFormMacro()
This method merges the given arguments, calculates and returns the view parameters for the returnRequestForm.
public
returnRequestFormMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- items
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —rmasMacro()
This method merges the given arguments, calculates and returns the view parameters for the rmas.
public
rmasMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- rmas
- userId
- showRmasStates
- showRmasActions
- showRmasIcons
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —salesAgentCustomersFormMacro()
This method merges the given arguments, calculates and returns the view parameters for the salesAgentCustomersForm.
public
salesAgentCustomersFormMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- items
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —salesAgentCustomersMacro()
This method merges the given arguments, calculates and returns the view parameters for the salesAgentCustomers.
public
salesAgentCustomersMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- items
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —salesAgentSalesFormMacro()
This method merges the given arguments, calculates and returns the view parameters for the salesAgentSalesForm.
public
salesAgentSalesFormMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- items
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —salesAgentSalesMacro()
This method merges the given arguments, calculates and returns the view parameters for the salesAgentSales.
public
salesAgentSalesMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- items
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —sendWishlistFormMacro()
This method merges the given arguments, calculates and returns the view parameters for the sendWishlistForm.
public
sendWishlistFormMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- form
- products
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —smallNewsletterFormMacro()
This method merges the given arguments, calculates and returns the view parameters for the smallNewsletterForm.
public
smallNewsletterFormMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- form
- showLabel
- showPlaceholder
- disableValidationMessages
- useCaptcha
- showCaptchaLabel
- hiddeWithLogin
- addLegalCheck
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —stockAlertsMacro()
This method merges the given arguments, calculates and returns the view parameters for the stockAlerts.
public
stockAlertsMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- stockAlerts
- allowRemove
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —userFormMacro()
This method merges the given arguments, calculates and returns the view parameters for the user form.
public
userFormMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- form
- selectedCountry
- selectedCountryLocations
- showCreateAccountCheck
- showShippingAddress
- forceUseShippingAddress
- defaultUserType
- class
- isGuest
- billingAddresses
- shippingAddresses
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments