Text Template Bundle

Preliminaries

After purchasing this bundle, you'll get access to the private Git repository. We also assume that you are running Akeneo via Docker. If this is not the case, you can simply derive the installation steps.

Installation

After adding the repositories configuration to your composer.json file, run composer to install the files:

docker-compose run -u www-data --rm php php -d memory_limit=4G /usr/local/bin/composer require mitting/akeneo-text-template-bundle v5.0.x-dev

Activate the bundle

Add the following to the array in config/bundles.php:

Mitting\Bundle\AkeneoTextTemplateBundle\MittingAkeneoTextTemplateBundle::class => ['dev' => true, 'test' => true, 'prod' => true],

Add the routing configuration to config/routes/mitting_akeneo_text_template.yml:

mitting_akeneo_text_template:
    resource: "@MittingAkeneoTextTemplateBundle/Resources/config/routing.yml"

Clear the cache:

docker-compose run -u www-data --rm php rm -rf var/cache
docker-compose run -u www-data --rm php php bin/console cache:warmup

Create a job to update products when changing the default value of an attribute:

docker-compose run -u www-data --rm php bin/console akeneo:batch:create-job 'Mitting Text Template Bundle Connector' render_twig_default_value_attributes mitting_text_template render_twig_default_value_attributes

Then run

make upgrade-front

to finish the installation.

Documentation

The bundle adds the "Twig Text" and "Twig Text Area" attribute types. Simply create new attributes of the given types and optionally define a default template. Now you can write twig markup to print out your attribute in any format you like.

Template snippets

Slug including categories

Create a slug based on assigned categories and SKU.

{{ categories | merge([name, sku]) | join(' ') | slugify }}
pc-monitors-tvs-and-projectors-nec-nec-ex201w-10627329

Metric attribute

This example shows how the localizedmetric-filter prints out the value suffixed by the translated metric unit.

Weight: {{ weight | localizedmetric }}
Weight: 512 Gram

Calculate a value based on two metric attributes:

Productiveness: {{(v.amount / a.amount)|number_format}} {{v.symbol}}/{{a.symbol}}
Productiveness: 1.5 l/m²

Price attribute

The localizedprice-filter is based on the localizedcurrency-filter and makes it easy to print the given currency.

Price: {{price | localizedprice('EUR') }}
Price: €100.00

Date attribute

Twig already provides the localizeddate-filter. Here you can see how to use the locale-variable, which is automatically available.

Date: {{ date | localizeddate('medium', 'none', locale) }}
Date: Sep 19, 2011

Number attribute

Use the localizednumber-filter to format any numbers.

Number: {{ number | localizednumber('decimal', 'default', locale) }}
Number: 1.250.000

Boolean attribute

The if-statement lets you output any text.

Available: {% if available %}yes{% else %}no{% endif %}
Available: yes

Simple select attribute

Printing the localized value of a select attribute can be achieved by using the localized-filter.

Color: {{ color | localized }}
Color: Grey

Multi select attribute

Like in the previous simple select snipped, you can use the localized-filter to output multiple values, separated by comma.

Colors: {{ colors | localized }}
Colors: Grey, Red, Blue

Reference data attribute

You can output the result of __toString() like any other scalar attribute.

Color: {{ color_reference }}
Color: Red

Reference data attribute property

It's also possible, to output properties of a reference data object.

Hex-Code: {{ color_reference.hex }}
Hex-Code: #ff0000

Reference data attribute property translation

If your reference data object implements the TranslatableInterface interface, you can directly output the translation.

Pictogram: {{ pictogram.translation.label }}
Pictogram: flameable

Reference data attribute twig filter

Of cause you can register your own twig filters to output anything you want.

{{ color_reference | format_color }}
The hex-code of the color "Red" is #ff0000

Are you missing a feature?

There are plenty of possibilities. Feel free to ask us your questions.