Front-Office Documentation

Util

Parameters

Example


{% import macrosCore.util as utilMacros %}
{{ utilMacros.agencyLogo({
name: 'logicommerce.com',
id: 'logoLogicommerce',
class: 'logoLogicommerce',
classLink: 'logoLogicommerce',
link: 'https://www.logicommerce.com',
logo: 'logicommerce',
folder: 'agencyLogo',
linkRel: 'nofollow noreferrer',
color: 'default'
}) }}

Related

macros/modes/{{coreMode}}/util/agencyLogo.html.twig

View Helper

FWK/ViewHelpers/Util/Macro/AgencyLogo.php

breadcrumb

Parameters

Variable Type Default Required
showHome bool true false
showArea bool true false
maxLevels int 0 false
tag string FWK/ViewHelpers/Util/Macro/Breadcrumb::TAG_UL false
Available values

FWK/ViewHelpers/Util/Macro/Breadcrumb::TAG_UL



FWK/ViewHelpers/Util/Macro/Breadcrumb::TAG_DIV
data array null true

Example


{% import macrosCore.util as utilMacros %}
{{ utilMacros.breadcrumb({
data: route.breadcrumb
}) }}

Related

macros/modes/{{coreMode}}/util/breadcrumb.html.twig

View Helper

FWK/ViewHelpers/Util/Macro/Breadcrumb.php

coreJsEnvironmentVariables

Parameters

Variable Type Default Required
mobileAgents string '' false
languageCode string session.generalSettings.language false
countryCode string session.generalSettings.country false

Example


{% import macrosCore macrosCore.util as utilMacros %}
{{ utilMacros.coreJsEnvironmentVariables({
languageCode: route.language
}) }}

Related

macros/modes/{{coreMode}}/util/coreJsEvironmentVariables.html.twig

View Helper

FWK/ViewHelpers/Util/Macro/CoreJsEvironmentVariables.php

coreJsSessionVariables

Parameters

Variable Type Default Required
user SDKDtosUserUser null true

Example




{% import macrosCore.util as utilMacros %}


{{ utilMacros.coreJsSessionVariables({


user: session.user


}) }}


Related

macros/modes/{{coreMode}}/util/CoreJsSessionVariables.html.twig

View Helper

FWK/ViewHelpers/Util/Macro/CoreJsSessionVariables.php

countriesLinksForm

Parameters

Variable Type Default Required
class string '' false
countriesLinksForm FWKCoreFormForm null true
acceptRouteWarning bool false false

Example




{% import macrosCore.util as utilMacros %}


{{ utilMacros.countriesLinksForm({


class: 'my-class',


countriesLinksForm: controllerItem.countriesLinksForm


}) }}


Related

macros/modes/{{coreMode}}/util/countriesLinksForm.html.twig

View Helper

FWK/ViewHelpers/Util/Macro/CountriesLinksForm.php

expressCheckout

Parameters

Variable Type Default Required
class string '' false
showTitle bool false false

Example




{% import macrosCore.util as utilMacros %}


{{ utilMacros.expressCheckout({


class: 'my-class',


showTitle: true


}) }}


Related

macros/modes/{{coreMode}}/util/expressCheckout.html.twig

View Helper

FWK/ViewHelpers/Util/Macro/expressCheckout.php

fillDataFunction

Parameters

Variable Type Default Required
user SDKDtosUserUser null true

Example


{% import macrosCore.util as utilMacros %}
{{ utilMacros.fillDataFunction({
user: session.user
}) }}

Related

macros/modes/{{coreMode}}/util/fillDataFunction.html.twig

View Helper

FWK/ViewHelpers/Util/Macro/FillDataFunction.php

lcCommerceData

Parameters

Variable Type Default Required
route SDKDtosCommonRoute null true
pageProduct SDKDtosCatalogProductProduct null false
pageCategory SDKDtosCatalogCategory null false
pageProducts SDKCoreDtosElementCollection null false
order SDKCoreDtosDocumentsDocument null false

Example


{% import macrosCore.util as utilMacros %}
{{ utilMacros.lcCommerceData({
route: route
}) }}

Related

macros/modes/{{coreMode}}/util/lcCommerceData.html.twig

View Helper

FWK/ViewHelpers/Util/Macro/lcCommerceData.php

lcCommerceSession

Parameters

Variable Type Default Required
session FWKCoreResourcesSession null true

Example


{% import macrosCore.util as utilMacros %}
{{ utilMacros.lcCommerceSession({
session: session
}) }}

Related

macros/modes/{{coreMode}}/util/lcCommerceSession.html.twig

View Helper

FWK/ViewHelpers/Util/Macro/lcCommerceSession.php

pagination

Parameters

Variable Type Default Required
pagination SDKCoreDtosPagination null true
pagerParameters FWKCoreThemeDtosPagination null true
mode string FWK/ViewHelpers/Util/Macro/Pagination::MODE_BLOCKS false
Available values

FWK/ViewHelpers/Util/Macro/Pagination::MODE_BLOCKS



FWK/ViewHelpers/Util/Macro/Pagination::MODE_TEXT

Example


{% import macrosCore.util as utilMacros %}
{{ utilMacros.pagination({
pagination: products.pagination,
pagerParameters: themeConfiguration.category.productList.pagination
}) }}

Related

macros/modes/{{coreMode}}/util/paginationText.html.twig

macros/modes/{{coreMode}}/util/paginationBlock.html.twig

View Helper

FWK/ViewHelpers/Util/Macro/Pagination.php

pluginsAssets

Parameters

Variable Type Default Required
assets array [] false
ambience string '' false
position string '' false
type string '' false

Example


{% import macrosCores.util as utilMacros %}
{{- utilMacros.pluginsAssets({
assets: pluginsAssets.items,
position: constant('SDKEnumsTrackerPosition::HEAD_TOP')
}) -}}

Related

macros/modes/{{coreMode}}/util/pluginsAssets.html.twig

View Helper

FWK/ViewHelpers/Util/Macro/PluginsAssets.php

printableContent

Parameters

Variable Type Default Required
windowAttributes string '' false
content string '' false
hrefType string '' false
title string '' false

Example


{% import macrosCore.util as utilMacros %}
{{ utilMacros.printableContent({
windowAttributes: 'width=800,height=600,location=no,left=200px',
content: printableContent,
hrefType: '_blank',
title: 'Terms of user and privaty policy'
}) }}

Related

macros/modes/{{coreMode}}/util/printableContent.html.twig

View Helper

FWK/ViewHelpers/Util/Macro/PrintableContent.php

routeWarningAlertModal

Parameters

Variable Type Default Required
route SDKDtosCommonRoute null true
showCountriesLinksForm bool false false
countriesLinksFormAcceptRouteWarning bool true false
countriesLinksFormClass string '' false

Example


{% import macrosCore.util as utilMacros %}
{{ utilMacros.routeWarningAlertModal({
route: route
}) }}

Related

macros/modes/{{coreMode}}/util/routeWarningAlertModal.html.twig

View Helper

FWK/ViewHelpers/Util/Macro/routeWarningAlertModal.php

searchForm

Parameters

Variable Type Default Required
form FWKCoreFormForm null true
showLabel bool true false
showPlaceholder bool true false
minCharacters int 3 false
searchProducts bool true false
searchCategories bool false false
searchBlog bool false false
searchPages bool false false
searchNews bool false false

Example


{% import macrosCore.util as utilMacros %}
{{ utilMacros.searchForm({
form : formSearch,
showLabel: false,
minCharacters: 3,
showPlaceholder: true
}) }}

Related

macros/modes/{{coreMode}}/util/searchForm.html.twig

View Helper

FWK/ViewHelpers/Util/Macro/SearchForm.php

trackers

Parameters

Variable Type Default Required
trackers array [] false
ambience string '' false
position string '' false
type string '' false

Example


{% import macrosCore.util as utilMacros %}
{{ utilMacros.trackers({
trackers: trackers,
position: constant('SDKEnumsTrackerPosition::HEAD_TOP')
}) }}

Related

macros/modes/{{coreMode}}/util/trackers.html.twig

View Helper

FWK/ViewHelpers/Util/Macro/Trackers.php

viewSection

Parameters

Variable Type Default Required
itemList FWKCoreThemeDtosItemList null true
showElementsList string false

Example


{% import macrosCore.util as utilMacros %}
{{- utilMacros.viewSection({
itemList: themeConfiguration.category.productList
}) -}}

Related

macros/modes/{{coreMode}}/util/perPage.html.twig

macros/modes/{{coreMode}}/util/sort.html.twig

macros/modes/{{coreMode}}/util/template.html.twig

View Helper

FWK/ViewHelpers/Util/Macro/ViewSection.php

physicalLocationsForm

Parameters

Variable Type Default Required
form FWKCoreFormForm null true
levels integer 1 false

Example




{% import macrosCore.util as utilMacros %}


{{- utilMacros.physicalLocationsForm({


form: physicalLocationsForm,


levels: 1,


restricted: false


}) -}}


Related

macros/modes/{{coreMode}}/util/physicalLocationsForm.html.twig

View Helper

FWK/ViewHelpers/Util/Macro/PhysicalLocationsForm.php

physicalLocationsFilter

Parameters

Variable Type Default Required
physicalLocationsFilter array [] false
pickupPointProviders ElementCollection null false
countries ElementCollection null false
defaultCountry string false

Example




{% import macrosCore.util as utilMacros %}


{{- utilMacros.physicalLocationsFilter({


countries: countries,


defaultCountry: defaultCountry,


physicalLocationsFilter: physicalLocationsFilter


}) -}}


Related

macros/modes/{{coreMode}}/util/physicalLocationsFilter.html.twig

View Helper

FWK/ViewHelpers/Util/Macro/PhysicalLocationsForm.php

physicalLocationsMap

Parameters

Variable Type Default Required
physicalLocationsItems array [] false
mapsApiKey string false
showAllMapMarkersButton bool false false

Example




{% import macrosCore.util as utilMacros %}


{{- utilMacros.physicalLocationsMap({


countries: countries,


defaultCountry: defaultCountry,


physicalLocationsMap: physicalLocationsMap


}) -}}


Related

macros/modes/{{coreMode}}/util/physicalLocationsMap.html.twig

View Helper

FWK/ViewHelpers/Util/Macro/PhysicalLocationsForm.php

physicalLocations

Parameters

Variable Type Default Required
physicalLocations ElementCollection null false
optionName string physicalLocation false
optionClass string false
addCountrySelector bool false false
addStateSelector bool false false
addCitySelector bool false false
addPostalCodeSelector bool false false
addAllOption bool false false
showInMap bool false false
mapsApiKey string null false
defaultPhysicalLocationId int 0 false
showDirections bool true false
physicalLocationFields array ['address', 'postalCode', 'city', 'state', 'country', 'phone', 'email', 'information'] false
showPlacesAutocomplete bool false false
showAllMapMarkersButton bool false false
showPickupPointProviderMapMarkers bool false false
filterByPhysicalLocations bool true false
searchResultZoom int 11 false
searchMinResults int 0 false
searchMaxResults int 0 false
physicalLocationItemsCheckVisibility bool false false

Example




{% import macrosCore.util as utilMacros %}


{{- utilMacros.physicalLocations({


countries: countries,


defaultCountry: defaultCountry,


physicalLocationsFilter: physicalLocationsFilter


}) -}}


Related

macros/modes/{{coreMode}}/util/physicalLocations.html.twig

macros/modes/{{coreMode}}/util/physicalLocationInformation.html.twig

View Helper

FWK/ViewHelpers/Util/Macro/PhysicalLocationsForm.php