ats/translation-bundle

The "ATS DIGITAL" Symfony translation bundle.

v1.0.2 2019-01-23 13:25 UTC

Requires

• php: >=7.0
• ats/core-bundle: 1.0.*
• friendsofsymfony/jsrouting-bundle: ^2.2
• sensio/framework-extra-bundle: ~3.0
• symfony/asset: 3.4.*
• symfony/cache: 3.4.*
• symfony/config: 3.4.*
• symfony/console: 3.4.*
• symfony/dependency-injection: 3.4.*
• symfony/event-dispatcher: 3.4.*
• symfony/filesystem: 3.4.*
• symfony/finder: 3.4.*
• symfony/http-foundation: 3.4.*
• symfony/http-kernel: 3.4.*
• symfony/monolog-bundle: ^3.1.0
• symfony/routing: 3.4.*
• symfony/templating: 3.4.*
• symfony/twig-bundle: 3.4.*

Requires (Dev)

• kint-php/kint: ^2.2
• phpstan/phpstan: ^0.10.3
• phpstan/phpstan-symfony: ^0.10.1
• squizlabs/php_codesniffer: ^3.3
• symfony/browser-kit: 3.4.*
• symfony/css-selector: ^4.1
• symfony/debug: 3.4.*
• symfony/dom-crawler: 3.4.*
• symfony/framework-bundle: 3.4.*
• symfony/phpunit-bridge: 3.4.*
• symfony/process: 3.4.*
• symfony/web-server-bundle: 3.4.*
• symfony/yaml: ^3.4

Provides

• ext-mongo: *

MIT

README

General

This bundle supersedes the default Symfony approach for i18n manipulation. Instead of being code-centric (i.e. manipulating key/values in YAML files per translation domain), it adopts a database-centric approach.

Features & Capabilities

• Database-centric i18n configuration (for Doctrine MongoDB ODM)
• Dedicated RESTful translation key/language manipulation
• Dedicated GUI for translation key/language manipulation

Setup

1- Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

composer require ats/translation-bundle

2- Enable the bundle by adding the following line in the app/AppKernel.php:

// app/AppKernel.php
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = [
            // ...
            new ATS\TranslationBundle\ATSTranslationBundle(),
        ];

        // ...
    }
}

3- Run bin/console assets:install --symlink to initialize static assets for translation GUI.

Configuration

This bundle requires one single mandatory configuration option to prepend an API prefix for i18n REST endpoints.

ats_translation:
    api:
        prefix: 'your_api_prefix' #e.g. 'api'

Usage

REST API :

i18n manipulation is done via the following routes :

GET /{api_prefix}/translation/compact :

• lists all i18n key/values for all languages. Sample output :

{
	"en": {
		"foo": "bar"
	}
}

GET /{api_prefix}/translation/get-available-languages :

• lists all available languages. Sample output :

['en','fr','de']

POST /{api_prefix}/translation/keys/init :

• seeds i18n context from a set of key/values. This can prove useful when importing a set of translation keys from your frontend. Sample Payload :

   {
  "keys" : ["home.welcome","home.logout","home.profile"]
   }
  

This will batch-insert the aforementioned i18n keys into the translation context.

GUI :

You can access the dedicated UI for i18n manipulation via {backend_host}/translations

FAQ

1. How efficient is this approach performance-wise ?

   • Each i18n invalidation propagates the commited changes to Filesystem cache. All REST API operations rely on cache-first strategy.

2. How can I restrict access to i18n GUI/REST API ?

   • i18n API endpoints and GUI are public by default. You can safely rely on Symfony security components to restrict access. The following configuration sample would deny access to all non-admin users :

	security:
		# [ ... ]
	    access_control:
	        - { path: '/%api_prefix%/translation/*', role:  ROLE_ADMIN } # secures access to REST API
	        - { path: '/translations', role:  ROLE_ADMIN } # secures access to GUI

Roadmap

• Doctrine ORM Support
• Parameter support in translation values
• General UI look-and-feel improvements

What's new?

CHANGELOG.md