library translation_editor

netpeople/translation_editor

TranslatorBundle

This bundle's purpose is to provide an interface for edition, addition and deletion of translations messages., _(*1)

Currently supported formats:, _(*2)

• YAML
• XLIFF
• CSV

Install & setup the bundle

1. Fetch the source code, _(*3)

   Using Git to control your project from project root directory:, _(*4)

   ``` bash, <sub>(*5)</sub>

   git submodule add git://github.com/docteurklein/TranslatorBundle.git vendor/bundles/Knp/Bundle/TranslatorBundle, <sub>(*6)</sub>

   
   By cloning repository:
   
   ``` bash 
   
   mkdir -p vendor/bundles/Knp/Bundle
   cd !$
   git clone git://github.com/docteurklein/TranslatoBundle.git
   
   

   By including into deps file:, <sub>(*7)</sub>

   ``` ./deps-file, <sub>(*8)</sub>

   [TranslatorBundle] git=git://github.com/docteurklein/TranslatorBundle.git target=/bundles/Knp/Bundle/TranslatorBundle, <sub>(*9)</sub>

   ```, <sub>(*10)</sub>

2. Add the bundle to your AppKernel class, <sub>(*11)</sub>

   ``` php, <sub>(*12)</sub>

   // app/AppKernerl.php public function registerBundles() { $bundles = array( // ... new Knp\Bundle\TranslatorBundle\KnpTranslatorBundle, // ... ); // ... }, <sub>(*13)</sub>

   ```, <sub>(*14)</sub>

3. Add the Knp namespace to your autoloader, <sub>(*15)</sub>

   
   // app/autoload.php
   $loader->registerNamespaces(array(
       'Knp' => __DIR__.'/../vendor/bundles',
       // your other namespaces
   );
   
   

4. Add routing, <sub>(*16)</sub>

   ``` yaml, <sub>(*17)</sub>

   // app/config/routing.yml, <sub>(*18)</sub>

   knplabs_translator_admin: resource: @KnpTranslatorBundle/Resources/config/routing/edition.yml prefix: /trans/admin, <sub>(*19)</sub>

   knplabs_translator: resource: @KnpTranslatorBundle/Resources/config/routing/routing.yml prefix: /trans, <sub>(*20)</sub>

   ```, <sub>(*21)</sub>

These route files provide the following routes:, <sub>(*22)</sub>

[router] Current routes
Name                     Method  Pattern
knplabs_translator_list  GET    /trans/admin/list
knplabs_translator_get   GET    /trans/{id}/{domain}/{locale}
knplabs_translator_put   PUT    /trans/

Minimal configuration

This bundle requires the activation of the core translator:, <sub>(*23)</sub>

``` yaml

// app/config/config.yml
framework:
    # ...
    translator:    { fallback: en }
    # ...

```

Additional configuration

This bundle relies on the Ext Core library. You can decide wheter or not it will be included automatically., <sub>(*24)</sub>

``` yaml

knplabs_translator:
    include_vendor_assets: false # defaults to true

```

Services

This bundle introduces those services:, <sub>(*25)</sub>

translator.dumper.csv                    container Knp\Bundle\TranslatorBundle\Dumper\CsvDumper
translator.dumper.xliff                  container Knp\Bundle\TranslatorBundle\Dumper\XliffDumper
translator.dumper.yaml                   container Knp\Bundle\TranslatorBundle\Dumper\YamlDumper
translator.writer                        container Knp\Bundle\TranslatorBundle\Translation\Translator

controllers are services too:

knplabs_translator.controller.edition    request   Knp\Bundle\TranslatorBundle\Controller\EditionController
knplabs_translator.controller.translator request   Knp\Bundle\TranslatorBundle\Controller\TranslatorController

API

``` php

class Knp\Bundle\TranslatorBundle\Translation\Translator extends Symfony\Bundle\FrameworkBundle\Translation\Translator
{

    public function isTranslated($id, $domain, $locale);

    public function update($id, $value, $domain, $locale);

    public function getResources($locale, $domain);

    public function getFallbackLocale();

    public function getCatalog($locale);

    public function getLocales();

    public function all();


```

Updating a given translation key is really simple:, <sub>(*26)</sub>

``` php

$this->get('translator.writer')->update('the key to translate', 'the translated string', 'messages', 'en');

```

Rest API

• Update english translations files for domain tests with translated value for key foo.bar.baz, <sub>(*27)</sub>

  ``` bash, <sub>(*28)</sub>

  curl -X PUT http://project-url/trans/ \ -F 'id=foo.bar.baz' \ -F 'domain=messages' \ -F 'locale=en' \ -F 'value=translate value', <sub>(*29)</sub>

  ```, <sub>(*30)</sub>

• Get the translated value of key foo.bar.baz for english locale for tests domain, <sub>(*31)</sub>

  ``` bash, <sub>(*32)</sub>

  curl http://project-url/trans/foo.bar.baz/tests/en, <sub>(*33)</sub>

  ```, <sub>(*34)</sub>