liip / hyphenator-bundle
This Bundle provides support for hyphenating long words using the Org_Heigl_Hyphenator library
Installs: 2 026
Dependents: 1
Suggesters: 0
Security: 0
Stars: 20
Watchers: 40
Forks: 3
Open Issues: 0
Type:symfony-bundle
Requires
- php: >=5.3.9
- org_heigl/hyphenator: ~2.0
- symfony/framework-bundle: ~2.3|~3.0
- twig/twig: ~1.20|~2.0
Requires (Dev)
- symfony/browser-kit: ~2.3|~3.0
- symfony/twig-bundle: ~2.3|~3.0
README
Adds support for hyphenating long words using the Org_Heigl_Hyphenator library.
This bundle will add a Twig Extension for templates and a Hyphenator service.
Installation
-
Download the Bundle
Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:
$ composer require liip/hyphenator-bundle
This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.
-
Enable the Bundle
Add the following line in the
app/AppKernel.php
file to enable this bundle only for thetest
environment:<?php // app/AppKernel.php // ... class AppKernel extends Kernel { public function registerBundles() { .. new Liip\HyphenatorBundle\LiipHyphenatorBundle(), return $bundles } // ... }
-
Configure the bundle:
The supported options for the Hyphenator with the defaults are:
# 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 likeen_EN
,en
will not work.For details about their meaning consult the Hyphenator library documentation.
Usage
This library adds a filter for twig templates that can be used like:
{{ "Somelongwordtohyphenate"|hyphenate }}
Alternatively the filter can be applied to an entire block:
{% filter hyphenate %}
...
Somelongwordtohyphenate
....
{% endfilter %}
Furthermore its possible to pass in a locale as a parameter if the default locale should not be used:
{{ "Somelongwordtohyphenate"|hyphenate("de") }}