DocumentViewHelper
extends ViewHelper
in package
This is the DocumentViewHelper class.
The purpose of this class is to facilitate to Twig the generation of the order'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 | |
| billingInformationMacro() | This method merges the given arguments, calculates and returns the view parameters for the billing address output. | : array<string|int, mixed> |
| buttonsMacro() | This method merges the given arguments, calculates and returns the view parameters for the buttons. | : array<string|int, mixed> |
| confirmOrderMacro() | This method merges the given arguments, calculates and returns the view parameters for the confirmOrder. | : array<string|int, mixed> |
| documentInformationMacro() | This method merges the given arguments, calculates and returns the view parameters for the order documentInformation output. | : array<string|int, mixed> |
| documentMacro() | This method merges the given arguments and calculates and returns the view parameters for the output. | : array<string|int, mixed> |
| getApplicationTaxesIncluded() | This method returns the setting of 'show taxes included'. | : bool |
| headquarterInformationMacro() | This method merges the given arguments, calculates and returns the view parameters for the headquarter information output. | : array<string|int, mixed> |
| mergeArguments() | This method merges macro arguments with macro associated class properties by reference. | : void |
| pickingInformationMacro() | This method merges the given arguments, calculates and returns the view parameters for the picking address output. | : array<string|int, mixed> |
| rewardPointsMacro() | This method merges the given arguments, calculates and returns the view parameters for the rewardPoints. | : array<string|int, mixed> |
| shippingInformationMacro() | This method merges the given arguments, calculates and returns the view parameters for the shipping address output. | : 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 —billingInformationMacro()
This method merges the given arguments, calculates and returns the view parameters for the billing address output.
public
billingInformationMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- document
- fields
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —buttonsMacro()
This method merges the given arguments, calculates and returns the view parameters for the buttons.
public
buttonsMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- orderId
- showBackButton
- showPrintButton
- classList
- token
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —confirmOrderMacro()
This method merges the given arguments, calculates and returns the view parameters for the confirmOrder.
public
confirmOrderMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- order
- showTransactionId
- showAuthNumber
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —documentInformationMacro()
This method merges the given arguments, calculates and returns the view parameters for the order documentInformation output.
public
documentInformationMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- document
- showTransactionId
- showAuthNumber
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —documentMacro()
This method merges the given arguments and calculates and returns the view parameters for the output.
public
documentMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- document
- mode
- linkable
- showOptions
- showOptionValuesName
- showOptionValuesSku
- showZeroDiscount
- giftsPresentation
- showTaxDisclosure
- showTaxIncluded
- tableClass
- showPrices
- showImage
- showSku
- showManufacturerSku
- showOffsets
- showCustomTags
- showDiscounts
- showDiscountName
- showZeroShipping
- showZeroPayment
- showFreeTaxMessage
- showPreviousPrice
- showPercentDifference
- showPriceDifference
- showProductStockId
- showFooter
- productsTemplate
- productsBundleTemplate
- productsBundleItemTemplate
- productsGiftTemplate
- productSelectableGiftTemplate
- routeType
- footerRows
- disclosure
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 —headquarterInformationMacro()
This method merges the given arguments, calculates and returns the view parameters for the headquarter information output.
public
headquarterInformationMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- document
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 —pickingInformationMacro()
This method merges the given arguments, calculates and returns the view parameters for the picking address output.
public
pickingInformationMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- document
- fields
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —rewardPointsMacro()
This method merges the given arguments, calculates and returns the view parameters for the rewardPoints.
public
rewardPointsMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- document
- class
- showHeader
- showTotalRedeemed
- showTotalEarned
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —shippingInformationMacro()
This method merges the given arguments, calculates and returns the view parameters for the shipping address output.
public
shippingInformationMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- document
- fields
- pickingFields
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments