This bundle aims to provide an easy way to generate links to same-pages-but-different-locales of a website.
Imagine you need to generate the list of localized URLs corresponding to the english one below:
http://mydomain.tld/en/category/drawing/pencil/ff0000
constructed via the following route (using BeSimpleI18nRoutingBundle)
front_category_item_color:
locales:
en: "en/category/{category_name}/{item_name}/{color_code}"
fr: "fr/categorie/{category_name}/{item_name}/{color_code}"
it: "it/categoria/{category_name}/{item_name}/{color_code}"
defaults: { _controller: MyCategoryBundle:Category:itemColor }Where category_name and item_name are localized but color_code is language independant.
Just add the following Annotation to your controller
use Woecifaun\Bundle\TranslationBridgeBundle\Configuration\TranslationBridge;
…
/**
* @ParamConverter(…)
* @Template()
* @TranslationBridge(
* "category_name" = "category.name",
* "item_name" = "item.name",
* "color_code" = "item.color"
* )
*/
public function itemColorAction(Category $category, Item $item)
{
…
}The following array will then be injected in the template with your other variables:
[
'en' => 'http://mydomain.tld/en/category/drawing/pencil/ff0000',
'fr' => 'http://mydomain.tld/fr/categorie/dessin/crayon/ff0000',
'it' => 'http://mydomain.tld/it/categoria/disegno/matita/ff0000',
]To generate the alternate links (see Google article on translations), just include the following code in the <head> element of your twig template:
{% include 'WoecifaunTranslationBridgeBundle::alternates.html.twig' %}HTML code generated will be as following:
…
<link rel="alternate" href="http://mydomain.tld/en/category/drawing/pencil/ff0000" hreflang="en" />
<link rel="alternate" href="http://mydomain.tld/fr/categorie/dessin/crayon/ff0000" hreflang="fr" />
<link rel="alternate" href="http://mydomain.tld/it/categoria/disegno/matita/ff000" hreflang="it" />
…- Use of ParamConverter: As the Translation Bridge Bundle tries to match annotation settings to controller arguments in order to call the correct methods on them, wildcards values need to be converted to PHP objects.
- Use of @Template() Annotation: The Translation Bridge array will be injected in the array returned by the controller when used in conjonction with the Template() Annotation. If the value returned by the controller is not an array, the Translation Bridge logic won't even be run.
- woecifaun.translationBridge.appLocales listing every locale affected by the Translation Bridge must be defined in your parameters file.
woecifaun.translationBridge.appLocales: [fr, en, it, de]In case you want or you need to change the logic handling the routes translation, just add the following line in your parameters file (with a real path):
woecifaun_translation_bridge.class: My\Bundle\MyBundle\PathTo\MyOwn\TranslationBridge
- The class must implement the
Woecifaun\Bundle\TranslationBridgeBundle\Model\TranslationBridgeInterface. routerandproperty_accessorservices as well as theappLocalesparameter (see above) will be automatically injected via the constructor.
ℹ️ The following commands require you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.
In your terminal and located in your project directory, type the command
$ composer config repositories.translation-bridge vcs https://github.com/woecifaun/translation-bridge-bundle📦 Packagist install is coming, thus this step won't be needed anymore.
Then execute the following command to download the latest version of this bundle:
$ composer require woecifaun/translation-bridge-bundle:~0.0Then, enable the bundle by adding the following line in the app/AppKernel.php
file of your project:
<?php
// app/AppKernel.php
// ...
class AppKernel extends Kernel
{
public function registerBundles()
{
$bundles = array(
// ...
new Woecifaun\Bundle\TranslationBridgeBundle\WoecifaunTranslationBridgeBundle(),
);
// ...
}
// ...
}