Util
agencyLogo
Pinta el logo de la agencia
Parameters
| Variable | Type | Default | Required |
| linkRel | string | nofollow noreferrer | false |
| Link de referencia para los colores | |||
| color | string | default | false |
| Color que se quiera usar | |||
| folder | string | agencyLogo | false |
| Carpeta con los logos | |||
| showOnlyText | bool | false | false |
| Muestra solo el texto, sin logo | |||
| name | string | '' | false |
| Nombre de la agencia | |||
| id | string | '' | false |
| Id de la agencia | |||
| class | string | '' | false |
| Nombre de la clase personalizado que se mostrara en html | |||
| classLink | string | '' | false |
| Link a la clase html | |||
| link | string | '' | false |
| Link de la agencia | |||
| logo | string | '' | false |
| Logo de la agencia | |||
| extension | string | '.png' | false |
| Extensión de la imagen del logo de la agencia | |||
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
Macro principal, importada segun el 'mode' que se haya definido en el Theme
View Helper
FWK/ViewHelpers/Util/Macro/AgencyLogo.php
breadcrumb
Pinta las breadcrumb de los subapartado que se visite
Parameters
| Variable | Type | Default | Required |
| showHome | bool | true | false |
| Mostrar el home | |||
| showArea | bool | true | false |
| Selecciona si el area esta desplegada o no | |||
| maxLevels | int | 0 | false |
| El maximo de niveles que se muestran, 0 = ilimitado | |||
| tag | string | FWK/ViewHelpers/Util/Macro/Breadcrumb::TAG_UL | false |
| Defina la estructura del html | Available values | ||
|
FWK/ViewHelpers/Util/Macro/Breadcrumb::TAG_UL Define la estructura en una listaFWK/ViewHelpers/Util/Macro/Breadcrumb::TAG_DIV Define la estructura en una caja |
|||
| data | array | null | true |
| route.breadcrumb(variable de twig) | |||
Example
{% import macrosCore.util as utilMacros %}
{{ utilMacros.breadcrumb({
data: route.breadcrumb
}) }}
Related
macros/modes/{{coreMode}}/util/breadcrumb.html.twig
Macro principal, importada segun el 'mode' que se haya definido en el Theme
View Helper
FWK/ViewHelpers/Util/Macro/Breadcrumb.php
coreJsEnvironmentVariables
Pinta un js con las variables globales requeridas por el js core
Parameters
| Variable | Type | Default | Required |
| mobileAgents | string | '' | false |
| Define los agentes moviles | |||
| languageCode | string | session.generalSettings.language | false |
| Codigo del lenguaje | |||
| countryCode | string | session.generalSettings.country | false |
| Codigo del país | |||
Example
{% import macrosCore macrosCore.util as utilMacros %}
{{ utilMacros.coreJsEnvironmentVariables({
languageCode: route.language
}) }}
Related
macros/modes/{{coreMode}}/util/coreJsEvironmentVariables.html.twig
Macro principal, importada segun el 'mode' que se haya definido en el Theme
View Helper
FWK/ViewHelpers/Util/Macro/CoreJsEvironmentVariables.php
coreJsSessionVariables
Pinta el js con las variables requeridas por el js core
Parameters
| Variable | Type | Default | Required |
| user | SDKDtosUserUser | null | true |
| El usuario actual | |||
Example
{% import macrosCore.util as utilMacros %}
{{ utilMacros.coreJsSessionVariables({
user: session.user
}) }}
Related
macros/modes/{{coreMode}}/util/CoreJsSessionVariables.html.twig
Macro principal, importada segun el 'mode' que se haya definido en el Theme
View Helper
FWK/ViewHelpers/Util/Macro/CoreJsSessionVariables.php
countriesLinksForm
Pinta un selector con la lista de paises y/o idiomas que estan disponibles en la tienda
Parameters
| Variable | Type | Default | Required |
| class | string | '' | false |
| Nombre de clase personalizado que se ve en el html | |||
| countriesLinksForm | FWKCoreFormForm | null | true |
| Formulario | |||
| acceptRouteWarning | bool | false | false |
| Marca la session de usuario que se han aceptado los warnings del route | |||
Example
{% import macrosCore.util as utilMacros %}
{{ utilMacros.countriesLinksForm({
class: 'my-class',
countriesLinksForm: controllerItem.countriesLinksForm
}) }}
Related
macros/modes/{{coreMode}}/util/countriesLinksForm.html.twig
Macro principal, importada segun el 'mode' que se haya definido en el Theme
View Helper
FWK/ViewHelpers/Util/Macro/CountriesLinksForm.php
expressCheckout
Pinta un selector con la lista de paises y/o idiomas que estan disponibles en la tienda
Parameters
| Variable | Type | Default | Required |
| class | string | '' | false |
| Nombre de clase personalizado que se ve en el html | |||
| showTitle | bool | false | false |
| Indica si quiere que se muestre el titulo | |||
Example
{% import macrosCore.util as utilMacros %}
{{ utilMacros.expressCheckout({
class: 'my-class',
showTitle: true
}) }}
Related
macros/modes/{{coreMode}}/util/expressCheckout.html.twig
Macro principal, importada segun el 'mode' que se haya definido en el Theme
View Helper
FWK/ViewHelpers/Util/Macro/expressCheckout.php
fillDataFunction
Genere todas las funciones necesarias para el js-fill-data
Parameters
| Variable | Type | Default | Required |
| user | SDKDtosUserUser | null | true |
| El usuario actual | |||
Example
{% import macrosCore.util as utilMacros %}
{{ utilMacros.fillDataFunction({
user: session.user
}) }}
Related
macros/modes/{{coreMode}}/util/fillDataFunction.html.twig
Macro principal, importada segun el 'mode' que se haya definido en el Theme
View Helper
FWK/ViewHelpers/Util/Macro/FillDataFunction.php
lcCommerceData
Genera el bloque js con la variable lcCommerceData
Parameters
| Variable | Type | Default | Required |
| route | SDKDtosCommonRoute | null | true |
| Objeto Route de la petición | |||
| pageProduct | SDKDtosCatalogProductProduct | null | false |
| En el caso de ser una página de producto, en pageProduct deberemos enviar el objeto Product que represente la petición | |||
| pageCategory | SDKDtosCatalogCategory | null | false |
| En el caso de ser una página de categoría, en pageCategory deberemos enviar el objeto Catogory que represente la petición | |||
| pageProducts | SDKCoreDtosElementCollection | null | false |
| En el caso de ser una página de categoría, en pageProducts deberemos enviar el objeto ElementCollection de Product que contenga los productos de la categoría | |||
| order | SDKCoreDtosDocumentsDocument | null | false |
| En el caso de ser una página de confirmOrder, en order deberemos enviar el objeto Document con la información del pedido | |||
Example
{% import macrosCore.util as utilMacros %}
{{ utilMacros.lcCommerceData({
route: route
}) }}
Related
macros/modes/{{coreMode}}/util/lcCommerceData.html.twig
Macro principal, importada segun el 'mode' que se haya definido en el Theme
View Helper
FWK/ViewHelpers/Util/Macro/lcCommerceData.php
lcCommerceSession
Genera el bloque js con la variable lcCommerceSession
Parameters
| Variable | Type | Default | Required |
| session | FWKCoreResourcesSession | null | true |
| Objeto Session de la petición | |||
Example
{% import macrosCore.util as utilMacros %}
{{ utilMacros.lcCommerceSession({
session: session
}) }}
Related
macros/modes/{{coreMode}}/util/lcCommerceSession.html.twig
Macro principal, importada segun el 'mode' que se haya definido en el Theme
View Helper
FWK/ViewHelpers/Util/Macro/lcCommerceSession.php
pagination
Pinta el paginado
Parameters
| Variable | Type | Default | Required |
| pagination | SDKCoreDtosPagination | null | true |
| Objeto pagination con la informacion de la paginacion | |||
| pagerParameters | FWKCoreThemeDtosPagination | null | true |
| Establece laonfiguracion de la paginacion | |||
| mode | string | FWK/ViewHelpers/Util/Macro/Pagination::MODE_BLOCKS | false |
| Modo en el que se muestra la paginacion | Available values | ||
|
FWK/ViewHelpers/Util/Macro/Pagination::MODE_BLOCKS Pinta el paginado en blockesFWK/ViewHelpers/Util/Macro/Pagination::MODE_TEXT Pinta el paginado en texto |
|||
Example
{% import macrosCore.util as utilMacros %}
{{ utilMacros.pagination({
pagination: products.pagination,
pagerParameters: themeConfiguration.category.productList.pagination
}) }}
Related
macros/modes/{{coreMode}}/util/paginationText.html.twig
Macro principal, importada segun el 'mode' que se haya definido en el Theme
macros/modes/{{coreMode}}/util/paginationBlock.html.twig
Macro principal, importada segun el 'mode' que se haya definido en el Theme
View Helper
FWK/ViewHelpers/Util/Macro/Pagination.php
pluginsAssets
Pinta los elementos con plugins
Parameters
| Variable | Type | Default | Required |
| assets | array | [] | false |
| elementos con los plugins | |||
| ambience | string | '' | false |
| Ambiente actual | |||
| position | string | '' | false |
| Posicion actual en la pagina | |||
| type | string | '' | false |
| El tipo actual de la pagina | |||
Example
{% import macrosCores.util as utilMacros %}
{{- utilMacros.pluginsAssets({
assets: pluginsAssets.items,
position: constant('SDKEnumsTrackerPosition::HEAD_TOP')
}) -}}
Related
macros/modes/{{coreMode}}/util/pluginsAssets.html.twig
Macro principal, importada segun el 'mode' que se haya definido en el Theme
View Helper
FWK/ViewHelpers/Util/Macro/PluginsAssets.php
printableContent
Muestra una caja pintable
Parameters
| Variable | Type | Default | Required |
| windowAttributes | string | '' | false |
| Define los atributos de la ventana | |||
| content | string | '' | false |
| Pinta el contenido de la caja | |||
| hrefType | string | '' | false |
| Tipo de link externo | |||
| title | string | '' | false |
| Titulo que se mostrara en la caja | |||
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
Macro principal, importada segun el 'mode' que se haya definido en el Theme
View Helper
FWK/ViewHelpers/Util/Macro/PrintableContent.php
routeWarningAlertModal
Incluye la modal para poder mostrar los warnings del route
Parameters
| Variable | Type | Default | Required |
| route | SDKDtosCommonRoute | null | true |
| Objeto Route de la petición | |||
| showCountriesLinksForm | bool | false | false |
| Muestra el formulario de countriesLinks en lugar de los botones básicos de continuar o ir a la tienda sugerida en el warning | |||
| countriesLinksFormAcceptRouteWarning | bool | true | false |
| Marca la session de usuario que se han aceptado los warnings del route | |||
| countriesLinksFormClass | string | '' | false |
| Nombre de la clase personalizado que se mostrara en html | |||
Example
{% import macrosCore.util as utilMacros %}
{{ utilMacros.routeWarningAlertModal({
route: route
}) }}
Related
macros/modes/{{coreMode}}/util/routeWarningAlertModal.html.twig
Macro principal, importada segun el 'mode' que se haya definido en el Theme
View Helper
FWK/ViewHelpers/Util/Macro/routeWarningAlertModal.php
searchForm
Pinta el formulario de busqueda
Parameters
| Variable | Type | Default | Required |
| form | FWKCoreFormForm | null | true |
| Objeto form, formulario a usar | |||
| showLabel | bool | true | false |
| Muestra la etiqueta | |||
| showPlaceholder | bool | true | false |
| Muestra el marcador de posicion | |||
| minCharacters | int | 3 | false |
| Caracteres minimos para proporcionar resultados | |||
| searchProducts | bool | true | false |
| Buscar productos | |||
| searchCategories | bool | false | false |
| Buscar categorias | |||
| searchBlog | bool | false | false |
| Buscar en los blogs | |||
| searchPages | bool | false | false |
| Buscar paginas | |||
| searchNews | bool | false | false |
| Buscar noticias | |||
Example
{% import macrosCore.util as utilMacros %}
{{ utilMacros.searchForm({
form : formSearch,
showLabel: false,
minCharacters: 3,
showPlaceholder: true
}) }}
Related
macros/modes/{{coreMode}}/util/searchForm.html.twig
Macro principal, importada segun el 'mode' que se haya definido en el Theme
View Helper
FWK/ViewHelpers/Util/Macro/SearchForm.php
trackers
Pinta los bloques con codigo js que se incrustan
Parameters
| Variable | Type | Default | Required |
| trackers | array | [] | false |
| Los bloques con codigo js | |||
| ambience | string | '' | false |
| Ambiente actual | |||
| position | string | '' | false |
| Posicion en la que queremos pintar | |||
| type | string | '' | false |
| Tipo actual | |||
Example
{% import macrosCore.util as utilMacros %}
{{ utilMacros.trackers({
trackers: trackers,
position: constant('SDKEnumsTrackerPosition::HEAD_TOP')
}) }}
Related
macros/modes/{{coreMode}}/util/trackers.html.twig
Macro principal, importada segun el 'mode' que se haya definido en el Theme
View Helper
FWK/ViewHelpers/Util/Macro/Trackers.php
viewSection
Pinta todas las vistas de los articulos
Parameters
| Variable | Type | Default | Required |
| itemList | FWKCoreThemeDtosItemList | null | true |
| Lista de todos los articulos a pintar | |||
| showElementsList | string | false | |
| Elementos que la macro va a pintar independientemente de itemList. Si el valor esta vacio, se muestra todo. | |||
Example
{% import macrosCore.util as utilMacros %}
{{- utilMacros.viewSection({
itemList: themeConfiguration.category.productList
}) -}}
Related
macros/modes/{{coreMode}}/util/perPage.html.twig
Macro principal, importada segun el 'mode' que se haya definido en el Theme
macros/modes/{{coreMode}}/util/sort.html.twig
Macro principal, importada segun el 'mode' que se haya definido en el Theme
macros/modes/{{coreMode}}/util/template.html.twig
Macro principal, importada segun el 'mode' que se haya definido en el Theme
View Helper
FWK/ViewHelpers/Util/Macro/ViewSection.php
physicalLocationsForm
Pinta el formulario para usar el localizador de puntos físicos
Parameters
| Variable | Type | Default | Required |
| form | FWKCoreFormForm | null | true |
| Objeto form, formulario a usar | |||
| levels | integer | 1 | false |
| Número de niveles que se desea mostrar. Su valor, debe ser, entre 1 y 3 | |||
Example
{% import macrosCore.util as utilMacros %}
{{- utilMacros.physicalLocationsForm({
form: physicalLocationsForm,
levels: 1,
restricted: false
}) -}}
Related
macros/modes/{{coreMode}}/util/physicalLocationsForm.html.twig
Macro principal, importada segun el 'mode' que se haya definido en el Theme
View Helper
FWK/ViewHelpers/Util/Macro/PhysicalLocationsForm.php
physicalLocationsFilter
Pinta el filtro para obtener y mostrar las ubicaciones
Parameters
| Variable | Type | Default | Required |
| physicalLocationsFilter | array | [] | false |
| Párametros enviados a la API para la obtencion de los phisycalLocations | |||
| pickupPointProviders | ElementCollection | null | false |
| Coleccion proveerdores mostrar para obtenes la colección de ubicaciones a mostrar. Espera una coleccion de elementos de tipo SDKDtosDocumentsPickupPointProviders. | |||
| countries | ElementCollection | null | false |
| Coleccion de paises que se desea mostrar en el selector. Espera una coleccion de elementos de tipo SDKDtosSettingsCountrySettings | |||
| defaultCountry | string | false | |
| Codigo de pais del país que se quiere seleccionar por defecto | |||
Example
{% import macrosCore.util as utilMacros %}
{{- utilMacros.physicalLocationsFilter({
countries: countries,
defaultCountry: defaultCountry,
physicalLocationsFilter: physicalLocationsFilter
}) -}}
Related
macros/modes/{{coreMode}}/util/physicalLocationsFilter.html.twig
Macro principal, importada segun el 'mode' que se haya definido en el Theme
View Helper
FWK/ViewHelpers/Util/Macro/PhysicalLocationsForm.php
physicalLocationsMap
Pinta el filtro para obtener y mostrar las ubicaciones
Parameters
| Variable | Type | Default | Required |
| physicalLocationsItems | array | [] | false |
| Tiendas físicas del Commerce | |||
| mapsApiKey | string | false | |
| Api Key de Google Maps | |||
| showAllMapMarkersButton | bool | false | false |
| Muestra un botón para restablecer el zoom del mapa y mostrar todos los puntos. | |||
Example
{% import macrosCore.util as utilMacros %}
{{- utilMacros.physicalLocationsMap({
countries: countries,
defaultCountry: defaultCountry,
physicalLocationsMap: physicalLocationsMap
}) -}}
Related
macros/modes/{{coreMode}}/util/physicalLocationsMap.html.twig
Macro principal, importada segun el 'mode' que se haya definido en el Theme
View Helper
FWK/ViewHelpers/Util/Macro/PhysicalLocationsForm.php
physicalLocations
Pinta las ubicaciones enviadas por paŕametro
Parameters
| Variable | Type | Default | Required |
| physicalLocations | ElementCollection | null | false |
| Coleccion de ubicaciones mostrar. Espera una coleccion de elementos de tipo SDKDtosCatalogPhysicalLocation. | |||
| optionName | string | physicalLocation | false |
| Nombre a aplicar a los options de physicalLocations | |||
| optionClass | string | false | |
| Class a aplicar a los options de physicalLocations | |||
| addCountrySelector | bool | false | false |
| Indica si se quiere mostrar un el selector del niver 'Country' | |||
| addStateSelector | bool | false | false |
| Indica si se quiere mostrar un el selector del niver 'State' | |||
| addCitySelector | bool | false | false |
| Indica si se quiere mostrar un el selector del niver 'City' | |||
| addPostalCodeSelector | bool | false | false |
| Indica si se quiere mostrar un el selector del niver 'PostalCode' | |||
| addAllOption | bool | false | false |
| Indica si se quiere mostrar una opcion para mostrar todas las localizaciones | |||
| showInMap | bool | false | false |
| Indica si se desea mostrar la ubicacion en un mapa | |||
| mapsApiKey | string | null | false |
| Api key para el mapa | |||
| defaultPhysicalLocationId | int | 0 | false |
| Indica el id de la ubicacion que se quiere marcar por defecto | |||
| showDirections | bool | true | false |
| Indica si se desea mostrar el 'Como llegar' de las ubicaciones en un mapa | |||
| physicalLocationFields | array | ['address', 'postalCode', 'city', 'state', 'country', 'phone', 'email', 'information'] | false |
| Indica que propiedades se imprimen de cada physical location. | |||
| showPlacesAutocomplete | bool | false | false |
| Muestra un input para buscar una ubicación concreta. Usa la api de mapa, requiere el parametro mapsApiKey. | |||
| showAllMapMarkersButton | bool | false | false |
| Muestra un botón para restablecer el zoom del mapa y mostrar todos los puntos. | |||
| showPickupPointProviderMapMarkers | bool | false | false |
| Añade un sufijo a la imagen del las marcas en el mapa, para que se pueda cambiar segun el proveedor | |||
| filterByPhysicalLocations | bool | true | false |
| Muestra el filtro segun los resultados obtenidos de los physicalLocations o en cambio muestra un selector para encontrar el locationId y a partir de este buscar los physicalLocations | |||
| searchResultZoom | int | 11 | false |
| Indica el número de zooms que se haran para mostrar el resultado de la busqueda de localidad | |||
| searchMinResults | int | 0 | false |
| El minimo de locacalizaciones que se quiere mostrar tras centrar el resultado de la busqueda. Con valor 0 no se aplica | |||
| searchMaxResults | int | 0 | false |
| El máximo de locacalizaciones que se quiere mostrar tras centrar el resultado de la busqueda. Con valor 0 no se aplica | |||
| physicalLocationItemsCheckVisibility | bool | false | false |
| Indica si se ha de ocultar de la lista de localizaciones los detalles de las localizaciones que quedan puera del mapa visible | |||
Example
{% import macrosCore.util as utilMacros %}
{{- utilMacros.physicalLocations({
countries: countries,
defaultCountry: defaultCountry,
physicalLocationsFilter: physicalLocationsFilter
}) -}}
Related
macros/modes/{{coreMode}}/util/physicalLocations.html.twig
Macro principal, importada segun el 'mode' que se haya definido en el Theme
macros/modes/{{coreMode}}/util/physicalLocationInformation.html.twig
En esta macro se maqueta el detalle e información de la ubicación
View Helper
FWK/ViewHelpers/Util/Macro/PhysicalLocationsForm.php