Front-Office Documentation

Basket

asyncOrder

Parameters

Variable Type Default Required
validationResponse SDKDtosPaymentValidationResponse null true
postParameters array [] false
getParameters array [] false

Example

{% import macrosCore.basket as basketMacros %}
{{- basketMacros.asyncOrder({
validationResponse: constant('FWKCoreControllersController::CONTROLLER_ITEM'),
postParameters: constant('FWKControllersCheckoutAsyncOrderController::POST_PARAMETERS'),
getParameters: constant('FWKControllersCheckoutAsyncOrderController::GET_PARAMETERS')
}) -}}

Related

macros/modes/{{coreMode}}/basket/asyncOrder.html.twig

View Helper

FWK/ViewHelpers/Basket/Macro/AsyncOrder.php

basketContent

Parameters

Variable Type Default Required
basket SDKDtosBasketBasket null true
editable bool false false
saveForLater bool false false
editableGifts bool false false
quantityPlugin bool false false
showShippingSection bool false false
showSelectableBox bool false false
selectableBoxRows int 5 false
showWarnings bool true false
showWarningsBlock bool true false
hiddenWarningCodes array [] false
errorWarningPosition string FWK/ViewHelpers/Basket/Macro/BasketContent::WARNING_POSITION_HEADER false
Available values

FWK/ViewHelpers/Basket/Macro/BasketContent::WARNING_POSITION_HEADER



FWK/ViewHelpers/Basket/Macro/BasketContent::WARNING_POSITION_LINE
warningWarningPosition string FWK/ViewHelpers/Basket/Macro/BasketContent::WARNING_POSITION_HEADER false
Available values

FWK/ViewHelpers/Basket/Macro/BasketContent::WARNING_POSITION_HEADER



FWK/ViewHelpers/Basket/Macro/BasketContent::WARNING_POSITION_LINE
infoWarningPosition string FWK/ViewHelpers/Basket/Macro/BasketContent::WARNING_POSITION_HEADER false
Available values

FWK/ViewHelpers/Basket/Macro/BasketContent::WARNING_POSITION_HEADER



FWK/ViewHelpers/Basket/Macro/BasketContent::WARNING_POSITION_LINE
showCustomTagPosition array [] false
showDiscountValue string FWK/ViewHelpers/Basket/Macro/BasketContent::SHOW_DISCOUNT_VALUE_BOTH false
Available values

FWK/ViewHelpers/Basket/Macro/BasketContent::SHOW_DISCOUNT_VALUE_VALUE



FWK/ViewHelpers/Basket/Macro/BasketContent::SHOW_DISCOUNT_VALUE_PERCENTAGE



FWK/ViewHelpers/Basket/Macro/BasketContent::SHOW_DISCOUNT_VALUE_BOTH



FWK/ViewHelpers/Basket/Macro/BasketContent::SHOW_DISCOUNT_VALUE_NONE
additionalItems string FWK/Core/ViewHelpers/Basket/Macro/BaseOutput::ADDITIONAL_ITEMS_PRESENTATION false
mode string FWK/Core/ViewHelpers/Basket/Macro/BaseOutput::MODE_DISCLOSURE false
Available values

FWK/Core/ViewHelpers/Basket/Macro/BaseOutput::MODE_DISCLOSURE



FWK/Core/ViewHelpers/Basket/Macro/BaseOutput::MODE_CASH_TICKET
linkable bool true false
showOptions bool true false
showOptionValuesName string FWK/Core/ViewHelpers/Basket/Macro/BaseOutput::SHOW_OPTION_VALUES_NAME_SHOW_NAME false
Available values

FWK/Core/ViewHelpers/Basket/Macro/BaseOutput::SHOW_OPTION_VALUES_NAME_NOT_SHOW



FWK/Core/ViewHelpers/Basket/Macro/BaseOutput::SHOW_OPTION_VALUES_NAME_SHOW_NAME



FWK/Core/ViewHelpers/Basket/Macro/BaseOutput::SHOW_OPTION_VALUES_NAME_SHOW_DESCRIPTION
showOptionValuesSku bool false false
showZeroDiscount bool false false
giftsPresentation string FWK/Core/ViewHelpers/Basket/Macro/BaseOutput::GIFTS_PRESENTATION_PRODUCTS_BLOCK false
Available values

FWK/Core/ViewHelpers/Basket/Macro/BaseOutput::GIFTS_PRESENTATION_PRODUCTS_BLOCK



FWK/Core/ViewHelpers/Basket/Macro/BaseOutput::GIFTS_PRESENTATION_INDEPENDENT
showTaxDisclosure bool true false
showTaxIncluded bool null false
showTaxName bool true false
tableClass string '' false
shoePrices bool true false
showImage bool true false
showSku bol false false
showManufacturerSku bool false false
showAsGridUniqueDimension bool false false
showCustomTags bool false false
showDevolutionButton bool false false
showDiscounts bool true false
showDiscountName bool false false
showZeroShipping bool true false
showZeroPayment bool true false
showFreeTaxMessage bool false false
showPreviousPrice bool false false
showPercentDifference bool false false
showPriceDifference bool false false
showProductStockId bool false false
showFooter bool true false
productTemplate string null false
productsBundleTemplate string null false
productsBundleItemTemplate string null false
productsGiftTemplate string null false
productSelectableGiftTemplate string null false
routeType string '' false
totalProductDiscounts float 0 false
showTaxesZeroTotalIncrement bool false false
mergeGridDiscounts bool false false

Example


{% import macrosCore.basket as basketMacros %}
{{- basketMacros.basketContent({
basket: basket,
editable: true,
quantityPlugin: true,
mode: constant('FWKViewHelpersBasketMacroBasketContent::MODE_DISCLOSURE'),
showDiscounts: true,
showDiscountName: true
}) -}}

Related

macros/modes/{{coreMode}}/basket/basketContent.html.twig

View Helper

FWK/ViewHelpers/Basket/Macro/BasketContent.php

basketForm

Parameters

Variable Type Default Required
content string null false
class string '' false

Example


{% import macrosCore.basket as basketMacros %}
{{ basketMacros.basketForm({
content: contentBasketForm,
class: 'test-class'
}) }}

Related

macros/modes/{{coreMode}}/basket/basketForm.html.twig

View Helper

FWK/ViewHelpers/Basket/Macro/BasketForm.php

buttons

Parameters

Variable Type Default Required
basket SDKDtosBasketBasket null true
showRecalculated bool true false
showClear bool true false
showContinue bool true false
submitAccion string FWK/Enums/RouteType::CHECKOUT_END_ORDER false
classList string '' false
backLocation string '' false
forceDisable bool false false
errorCode string '' false

Example


{% import macrosCore.basket as basketMacros %}
{{ basketMacros.buttons({
basket: controllerItem
}) }}

Related

macros/modes/{{coreMode}}/basket/buttons.html.twig

View Helper

FWK/ViewHelpers/Basket/Macro/Buttons.php

comment

Parameters

Variable Type Default Required
basket SDKDtosBasketBasket null true
forceOutput bool false false
showPlaceholder bool true false

Example


{% import macrosCore.basket as basketMacros %}
{{ basketMacros.comment({
basket: basketObj,
forceOutput: false,
showPlaceholder: true
}) }}

Related

macros/modes/{{coreMode}}/basket/comment.html.twig

View Helper

FWK/ViewHelpers/Basket/Macro/Comment.php

customTags

Parameters

Variable Type Default Required
basket SDKDtosBasketBasket null true
customTags SDKCoreDtosElementCollection null true
showPositions array [] false
useCalendar bool true false
showFormFields bool true false
saveButtonSubmitAction string '' false

Example


{% import macrosCore.basket as basketMacros %}
{{ basketMacros.customTags({
basket: basketObj,
customTags: customTagsObj,
showPositions: [],
useCalendar: true,
showFormFields: true,
saveButtonSubmitAction: route.type
}) }}

Related

macros/modes/{{coreMode}}/basket/customTags.html.twig

View Helper

FWK/ViewHelpers/Basket/Macro/CustomTags.php

deleteDiscountCodes

Parameters

Variable Type Default Required
basket SDKDtosBasketBasket null true

Example


{% import macrosCore.basket as basketMacros %}
{{- basketMacros.deleteDiscountCodes({
basket: controllerItem
}) -}}

Related

macros/modes/{{coreMode}}/basket/deleteDiscountCodes.html.twig

View Helper

FWK/ViewHelpers/Basket/Macro/DeniedOrderMessage.php

deliveries

Parameters

Variable Type Default Required
basket SDKDtosBasketBasket null true
deliveries SDKCoreDtosElementCollection null true
physicalLocations SDKCoreDtosElementCollection null false
pickupPointProviders ElementCollection null false
showTitle bool true false
showLogo bool false false
showTaxIncluded bool null false
showDescription bool true false
showPickup bool false false
showProducts bool true false
showWarnings bool true false
showSelectPickingDescription bool false false

Example


{% import macrosCore.basket as basketMacros%}
{{- basketMacros.deliveries({
basket: basket,
deliveries: deliveries,
showPickup: false,
showTitle: true,
showLogo: true,
showTaxIncluded: true
}) -}}

Related

macros/modes/{{coreMode}}/basket/deliveries.html.php

View Helper

FWK/ViewHelpers/Basket/Macro/Deliveries.php

deniedOrderMessage

Parameters

Variable Type Default Required
basket SDKDtosBasketBasket null true
errorCode string '' false
errorFields SDKDtosBasketErrorFields '' false

Example


{% import macrosCore.basket as basketMacros %}
{{- basketMacros.deniedOrderMessage({
basket: controllerItem,errorCode: errorCode
}) -}}

Related

macros/modes/{{coreMode}}/basket/deniedOrderMessage.html.twig

View Helper

FWK/ViewHelpers/Basket/Macro/DeniedOrderMessage.php

endOrder

Parameters

Variable Type Default Required
payResponse SDKDtosPayResponse null true

Example


{% import macrosCore.basket as basketMacros %}
{{ basketMacros.endOrder({
payResponse: controllerItem
}) }}

Related

macros/modes/{{coreMode}}/basket/endOrder.html.twig

View Helper

FWK/ViewHelpers/Basket/Macro/EndOrder.php

OSCForm

Parameters

Variable Type Default Required
content string null false
class string '' false

Example


{% import macrosCore.basket as basketMacros %}
{{ basketMacros.OSCForm({
content: twigSetVariable,
class: 'test-class'
}) }}

Related

macros/modes/{{coreMode}}/basket/OSCForm.html.twig

View Helper

FWK/ViewHelpers/Basket/Macro/OSCForm.php

OSCModule

Parameters

Variable Type Default Required
content string null false
class string '' false
type string '' false
Available values

FWKViewHelpersBasketMacroOSCModule::TYPE_BASKET



FWKViewHelpersBasketMacroOSCModule::TYPE_USER_FORM



FWKViewHelpersBasketMacroOSCModule::TYPE_PAYMENTS



FWKViewHelpersBasketMacroOSCModule::TYPE_SHIPPINGS



FWKViewHelpersBasketMacroOSCModule::TYPE_COMMENTS



FWKViewHelpersBasketMacroOSCModule::TYPE_DISCOUNTS



FWKViewHelpersBasketMacroOSCModule::TYPE_LEGAL_CHECK



FWKViewHelpersBasketMacroOSCModule::TYPE_BUTTONS

Example


{% import macrosCore.basket as basketMacros %}
{{ basketMacros.OSCModule({
content: twigSetVariable,
class: 'test-class',
type: constant('FWKViewHelpersBasketMacroOSCModule::TYPE_USER_FORM')
}) }}

Related

macros/modes/{{coreMode}}/basket/OSCModule.html.twig

View Helper

FWK/ViewHelpers/Basket/Macro/OSCModule.php

lockedStocksContent

Parameters

Variable Type Default Required
showRenewButton bool null false
showDescription bool true false
class string '' false
expiresAtExtendMinutes int null false
expiresAtExtendMinutesUponUserRequest bool true false
popup bool false false
expired bool false false

Example


{% import macrosCore.basket as basketMacros %}
{{ basketMacros.lockedStocksContent({
showDescription: true
}) }}

Related

macros/modes/{{coreMode}}/basket/lockedStocksContent.html.twig

View Helper

FWK/ViewHelpers/Basket/Macro/LockedStocksContent.php

miniBasketWrap

Parameters

Variable Type Default Required
basket SDKDtosBasketBasket null false
content string null true
showTaxIncluded bool null false
class string '' false

Example


{% import macrosCore.basket as basketMacros %}
{{ basketMacros.miniBasketWrap({
basket: basketObj,
content: twigSetVariable,
showPaymentSystem: true,
showShipping: true,
showTaxIncluded: true,
class: ''
}) }}

Related

macros/modes/{{coreMode}}/basket/miniBasketWrap.html.twig

View Helper

FWK/ViewHelpers/Basket/Macro/MiniBasketWrap.php

miniBasketContent

Parameters

Variable Type Default Required
basket SDKDtosBasketBasket null true
showTaxIncluded bool null false
showTotal bool true false
linkable bool true false
showPaymentSystem bool true false
showShipping bool true false
showCustomTags bool false false
showCustomTagPositions array [] false
showDeleteItems bool true false
showImage bool true false
showBrand bool false false
showSku bool false false
showOptions bool true false
showHeader bool true false
showFooter bool true false
showOptionValue string FWK/ViewHelpers/Basket/Macro/MiniBasketContent::SHOW_OPTION_VALUES_NAME_SHOW_NAME false
Available values

FWK/ViewHelpers/Basket/Macro/MiniBasketContent::SHOW_OPTION_VALUES_NAME_NOT_SHOW



FWK/ViewHelpers/Basket/Macro/MiniBasketContent::SHOW_OPTION_VALUES_NAME_SHOW_NAME



FWK/ViewHelpers/Basket/Macro/MiniBasketContent::SHOW_OPTION_VALUES_NAME_SHOW_DESCRIPTION
showTotalDiscounts bool true false
showItemNameDiscounts bool false false
showZeroDiscount bool false false
showItemValueDiscounts string FWK/ViewHelpers/Basket/Macro/BasketContent::SHOW_DISCOUNT_VALUE_NONE false
Available values

FWK/ViewHelpers/Basket/Macro/BasketContent::SHOW_DISCOUNT_VALUE_VALUE



FWK/ViewHelpers/Basket/Macro/BasketContent::SHOW_DISCOUNT_VALUE_PERCENTAGE



FWK/ViewHelpers/Basket/Macro/BasketContent::SHOW_DISCOUNT_VALUE_BOTH



FWK/ViewHelpers/Basket/Macro/BasketContent::SHOW_DISCOUNT_VALUE_NONE
showTotalVouchers bool true false
class string '' false
gripOptionsClassPrefix string '' false
editable bool false false
quantityPlugin bool false false
showSelectableBox bool false false
selectableBoxRows int 5 false
showGifts bool false false

Example


{% import macrosCore.basket as basketMacros %}
{{ basketMacros.miniBasketContent({
basket: basketObj,
showTaxIncluded: false,
showTotal: true,
linkable: true,
showPaymentSystem: true,
showShipping: true,
showCustomTags: false,
showCustomTagPositions: [],
showDeleteItem: true,
showImage: true,
showSku: false,
showOptions: true,
showHeader: true,
showFooter: true,
showOptionValuesName: constant('FWKViewHelpersBasketMacrominiBasketContent::SHOW_OPTION_VALUES_NAME_SHOW_NAME'),
showTotalDiscounts: true,
showTotalVouchers: true,
class: '',
editable: false,
quantityPlugin: false,
showSelectableBox: false,
selectableBoxRows: 5
}) }}

Related

macros/modes/{{coreMode}}/basket/miniBasketContent.html.twig

View Helper

FWK/ViewHelpers/Basket/Macro/MiniBasketContent.php

paymentSystems

Parameters

Variable Type Default Required
basket SDKDtosBasketBasket null true
paymentSystems null true
showTaxIncluded bool null false
showTitle bool true false
showZeroPrice bool true false
showDescription bool true false
showImage bool false false

Example


{% import macrosCore macrosCore.basket as basketMacros %}
{{- basketMacros.paymentSystems({
basket: basket,
paymentSystems: paymentSystems
}) -}}

Related

macros/modes/{{coreMode}}/basket/paymentSystems.html.twig

View Helper

FWK/ViewHelpers/Basket/Macro/PaymentSystems.php

redeemRewardPoints

Parameters

Variable Type Default Required
basket SDKDtosBasketBasket null false
rewardPoints SDKCoreDtosElementCollection null true
maxAvailableRewardPoints array [] false
quantityPlugin bool false false
showSelectableBox bool false false
class string '' false
showRewardPointsHeader bool true false

Example


{% import macrosCore.basket as basketMacros %}
{{ basketMacros.redeemRewardPoints({
basket: session.basket, rewardPoints: userRewardPoints, maxAvailableRewardPoints: {'ePoint_1': 100, 'ePoint_2': 200}
}) }}

Related

macros/modes/{{coreMode}}/basket/redeemRewardPoints.html.twig

View Helper

FWK/ViewHelpers/Basket/Macro/RedeemRewardPoints.php

rewardPoints

Parameters

Variable Type Default Required
basket SDKDtosBasketBasket null true
class string '' false
showHeader bool true false

Example


{% import macrosCore.basket as basketMacros %}
{{ basketMacros.rewardPoints({
basket: session.basket, rewardPoints: userRewardPoints, maxAvailableRewardPoints: {'ePoint_1': 100, 'ePoint_2': 200}
}) }}

Related

macros/modes/{{coreMode}}/basket/rewardPoints.html.twig

View Helper

FWK/ViewHelpers/Basket/Macro/RewardPoints.php

steps

Parameters

Variable Type Default Required
steps array |FWK/ViewHelpers/Basket/Macro/Setps::STEP_BASKET, |FWK/ViewHelpers/Basket/Macro/Setps::STEP_CUSTOMER, |FWK/ViewHelpers/Basket/Macro/Setps::STEP_PAYMENT_AND_ASHIPPING, |FWK/ViewHelpers/Basket/Macro/Setps::STEP_CONFIRM_ORDER | false
Available values

FWK/ViewHelpers/Basket/Macro/Setps::STEP_BASKET



FWK/ViewHelpers/Basket/Macro/Setps::STEP_CUSTOMER



FWK/ViewHelpers/Basket/Macro/Setps::STEP_PAYMENT_AND_ASHIPPING



FWK/ViewHelpers/Basket/Macro/Setps::STEP_CONFIRM_ORDER
routeType string '' false
showNumbers bool false false

Example


{% import macrosCore.basket as basketMacros %}
{{ basketMacros.steps({
steps: [
constant('FWKViewHelpersBasketMacroSetps::STEP_BASKET'),
constant('FWKViewHelpersBasketMacroSetps::STEP_CUSTOMER'),
constant('FWKViewHelpersBasketMacroSetps::STEP_PAYMENT_AND_ASHIPPING'),
constant('FWKViewHelpersBasketMacroSetps::STEP_CONFIRM_ORDER')
]
}) }}

Related

macros/modes/{{coreMode}}/basket/steps.html.twig

View Helper

FWK/ViewHelpers/Basket/Macro/Steps.php

voucherForm

Parameters

Variable Type Default Required
basket SDKDtosBasketBasket null false
forceOutput bool false false

Example


{% import macrosCore.basket as basketMacros %}
{{ basketMacros.voucherForm({
basket: controllerItem
}) }}

Related

macros/modes/{{coreMode}}/basket/voucherForm.html.twig

View Helper

FWK/ViewHelpers/Basket/Macro/VoucherForm.php