:warning: Warning: This bundle is abandoned. You should consider using a more supported and maintained bundle, like lexik/LexikTranslationBundle., (*1)
Orbitale TranslationBundle
Adds new features to native Symfony translator, without replacing it., (*2)
Creates translation files, format filenames with the translation domains names, but with more powerful support of all translations., (*3)
Installation
With Composer, (*4)
Just write this command line instruction if Composer is installed in your Symfony root directory :, (*5)
composer require orbitale/translation-bundle
I recommend to use Composer, as it is the best way to keep this repository update on your application.
You can easily download Composer by checking the official Composer website, (*6)
Initialization
You need to initiate some settings to make sure the bundle is configured properly., (*7)
-
First, register the bundle in the kernel :, (*8)
<?php
# app/AppKernel.php
class AppKernel extends Kernel
{
public function registerBundles() {
$bundles = array(
// ...
new Orbitale\Bundle\TranslationBundle\OrbitaleTranslationBundle(),// Registers Orbitale TranslationBundle
-
Update your database to add the new entity :, (*9)
php app/console doctrine:schema:update --force
-
Enable the translator in the framework:, (*10)
# app/config/config.yml
framework:
translator: { fallback: "%locale%" } # Un-comment this line to enable the translator
-
(optional) If it's not done already by composer, install the assets with php app/console assets:install --symlink, (*11)
-
Done !, (*12)
Usage
You can use your translator like before, in Twig, controllers or anything., (*13)
If you already have translation files, Orbitale's translator will find them and rely on the native translator to cache them and retrieve them., (*14)
But if the translator does not find any translation, then it will search in the database, and if there is none, it will persist a new "empty" translation, for you to know that something has to be translated !, (*15)
Managing translations in the database
You can manage translations in three different ways :, (*16)
-
Using the Orbitale's TranslationController, (*17)
You'll just load the internal controller by injecting our routes into your app, and get access to our translation manager. See "Admin Panel" first section for more informations., (*18)
-
Connecting to your SonataAdminBundle configuration, (*19)
You can add one single configuration value to inject the TranslationAdmin service to add a simple manager into your backoffice, (*20)
-
Raw database management, (*21)
Well, this is the brutal method, but you can simply search in your database with any db-administration system, and modify translations manually. For sanity reasons, I let you write your SQL statements, or load PhpMyAdmin to modify the translations yourself ;), (*22)
Admin Panel
First solution : internal controller
For this you can inject our routing files into your own routing config :, (*23)
# app/config/routing.yml
orbitale_translation_front:
resource: "@OrbitaleTranslationBundle/Resources/config/routing_front.yml"
prefix: /
orbitale_translation_admin:
resource: "@OrbitaleTranslationBundle/Resources/config/routing_admin.yml"
prefix: /
Note : I deliberately wrote the prefix : you should specify them, as your routes are totally different than any other routes. They are unique, yours, and they are dedicated to your app. These are your prefixes, enjoy them <3., (*24)
Basically, the template is a classical Twitter's Bootstrap v3 and jQuery v2, all bundled in the bundle., (*25)
There are four routes usable by the OrbitaleTranslationBundle controller :, (*26)
Front
-
Locale change :
/%prefix%/lang/{locale} , A simple route that allows the user to change the locale he's using. Obviously, if you have all routes beginning with the locale, for example http://www.mysite.com/{locale}/action/param/..., this route is unnecessary, but it's still here to help you getting rid of the many checks, as this bundle uses a special listener to check the locale for any request.
Admin
-
Admin panel index :
/%prefix%/translations/ , Shows a list of all elements found in the database, sorted by locale and translation domains. A tiny count system allows you to directly have a view on how many elements are translated or not. To view directly the health state of the translations, the counts will use badges and have three different colors : red if no element is translated, orange if some elements are translated but not all, and green if all elements are translated., (*27)
-
Admin panel edition :
/%prefix%/translations/{locale}/{domain} , With a little Javascript, it can save your translations in the database. You can save the datas with an AJAX request and a little tooltip will appear showing you if the translation has succeded., (*28)
-
Admin panel extraction :
/%prefix%/translations/export/{locale} , (Locale is optional) This route allows the user to extract translations into files, in YML format, in a configurable output directory.
Tip : This feature is also available in command line.
Warning! This commands overwrite your actual translations if they're located in the app/Resources/translations directory ! This bundle cannot (yet ?) merge the existing files with the currently extracted translations., (*29)
Second solution : SonataAdminBundle
If you are using SonataAdminBundle in your Symfony app, then you can add the TranslationAdmin class by simply adding a configuration parameter :, (*30)
# app/config/config.yml
orbitale_translation:
use_sonata: true
The OrbitaleTranslationExtension class will then load a SonataAdmin service which adds a translation list, and allows you to edit your translations directly in your Sonata backoffice., (*31)
Configuration reference
orbitale_translation:
# View default_locales.yml to view all 135 supported locales !
# By default, it will only use the %locale% parameter
locales: ~
# Whether you want to use the Admin class with SonataAdminBundle
use_sonata: false
# This is the layout that will be extended by all internal administration views (list and edition)
admin_layout: OrbitaleTranslationBundle:Translation:_layout.html.twig
# This is the directory where the extracted translations will be saved, when using the translation UI or the command-line-interface.
output_directory: %kernel.root_dir%/Resources/translations/
Locales :
Example :, (*32)
# app/config/config.yml
orbitale_translations:
locales: ~
By default, about 135 locales are supported. The ideal configuration for this bundle is to use the shortest syntax for locale name, for example fr instead of fr_FR, and en instead of en_US or en_UK., (*33)
The default value for this parameter is automatically set to %locale% if you have set it in your application parameters., (*34)
To view supported locales, see the default_locales.yml file., (*35)
Specifying the locales parameter in your config file totally overrides the default locales., (*36)
If you want to use more locales, you have three ways of doing it :, (*37)
-
locales: {"fr": "Français", "en": "English"}
This is the basic way, and it is the only way to add languages that are not supported by this bundle. But if a locale is not supported, you'd better make a pull-request or open an issue for it !, (*38)
-
locales: ["fr", "en"]
This is basically a way to use only 2 locales in your website. With the 3rd way, it allows you to use the powerful $translator->getLangs() method, which returns all used locales. If you were not using this method, this method would then return all 135 locales. It's useful to make a dynamic "Change language" menu : you put your languages in the configuration, then you get them from the translator, and you have both the locale and the public language name ! (in english). This is great for a dropdown menu, for example !, (*39)
-
locales: "fr,en,de,es"
With the 2nd method, it's the shortest way. The languages will only be splitted into an array and the extension will find them, (*40)
If you want to extract the translations from the database to files, you can do it in two ways :, (*41)
- Use the internal controller. If you configured the internal routing parameters, you can use the translation UI and click the "extract" link to call a specific service. A locale is not necessary, as it can save all translation from all locales. It will only save translated messages.
- Use the command line tool, by running
orbitale:translation:extract command. With this tool, you can specify the locale, but also some more options, like the --output-directory (default app/Resources/translations/), the --output-format (default "yml", but you can use any format provided by Symfony's native translator, as I use the native service to export translations), and two other notions : dirty and keeping files.
A dirty translation is a blank translation, where the source, locale and domain are specified, and not the translation. If you specify the --dirty option to the command line tool, every blank translation will be saved in the files. Normally, they are not, as it's really not useful, and if you translate an element in the database but do not extract database into files, the expression will still be untranslated until you extract files., (*42)
When you specify the --keep-files option, it will only write non-existing files. It means you can save only "new translation domains" if you have new ones., (*43)
How it works, behind
The new translator simply extends Symfony's native translator, to keep using native's powerful translation system, just adding it a new abstraction layer : the database., (*44)
When you use the native Twig filters ( trans, transchoice, trans_default_domain ), when you get the translator from the Services Container ( $this->container->get('translator');/*From a controller*/ ), whenever you translate an expression, Orbitale TranslationBundle's translator service will do several things the native one does not do., (*45)
-
First, it will search if the element exists in the Symfony's native translator.
If it does, then, it just returns it., (*46)
-
Else, it will get the translation domain asked, if none, use messages (exactly like the native translator), and will load an internal catalogue, and check if the source (also named "id" in the native translator) exists in the database (it will create a specific token based on source, locale and domain, and check token's existence)., (*47)
-
If the token does not exist, then it will persist a new element in the database, with an empty translation. At this moment, it will be visible in the translation UI (admin panel), and the count number will indicate a "missing" translation : x/y , where x equals the number of translated elements and y equals the total number of elements., (*48)
-
If the token exists, and if the element is already translated in the database, the translation is returned. If not, then the original expression is returned, after parsing the eventual translation parameters., (*49)
-
As you may have noticed, Symfony's native translator is called at first. It's simply to use Symfony's powerful cache system, which saves all translations inside a cached catalogue, to strongly enhance time execution and memory saving., (*50)
Wallogit.com
