Introduction
Adds support for hyphenating long words using the Org_Heigl_Hyphenator library., (*1)
This bundle will add a Twig Extension for templates and a Hyphenator service., (*2)
, (*3)
Installation
-
Download the Bundle, (*4)
Open a command console, enter your project directory and execute the
following command to download the latest stable version of this bundle:, (*5)
$ composer require liip/hyphenator-bundle
This command requires you to have Composer installed globally, as explained
in the installation chapter
of the Composer documentation., (*6)
-
Enable the Bundle, (*7)
Add the following line in the app/AppKernel.php
file to enable this bundle only
for the test
environment:, (*8)
<?php
// app/AppKernel.php
// ...
class AppKernel extends Kernel
{
public function registerBundles()
{
..
new Liip\HyphenatorBundle\LiipHyphenatorBundle(),
return $bundles
}
// ...
}
-
Configure the bundle:, (*9)
The supported options for the Hyphenator with the defaults are:, (*10)
# app/config/config.yml
liip_hyphenator:
default_locale: 'en_GB'
hyphen: ­
left_min: 2
right_min: 2
word_min: 6
quality: highest # either the quality name, either the value of the constant
no_hyphenate_string: ''
custom_hyphen: --
tokenizers: ['liip_hyphenator.tokenizer.whitespace', 'liip_hyphenator.tokenizer.punctuation']
filters: ['liip_hyphenator.filter.simple']
All settings are optional. Caution: default_locale
needs to be a fully qualified locale like en_EN
, en
will not work., (*11)
For details about their meaning consult the Hyphenator library documentation., (*12)
Usage
This library adds a filter for twig templates that can be used like:, (*13)
{{ "Somelongwordtohyphenate"|hyphenate }}
Alternatively the filter can be applied to an entire block:, (*14)
{% filter hyphenate %}
...
Somelongwordtohyphenate
....
{% endfilter %}
Furthermore its possible to pass in a locale as a parameter if the default locale should not be used:, (*15)
{{ "Somelongwordtohyphenate"|hyphenate("de") }}