Skip to content

Latest commit

 

History

History
117 lines (89 loc) · 4.02 KB

README.md

File metadata and controls

117 lines (89 loc) · 4.02 KB
Raw

Happyr Translation Bundle

This bundle helps you to integrate with a third party translation service. The bundle has been focused to integrate to the Loco service. If you want to know how Happyr work with this bundle you should check out this blog post.

The key features of this bundle is:

  • Easy to download all translations from
  • Support for multiple projects
  • Create new translation assets by the Symfony WebProfiler
  • Edit, flag and synchronize the translation via the Symfony WebProfiler
  • Auto upload missing translations to SaaS

Usage

To download all translations from Loco, simply run:

php app/console happyr:translation:download

When you have added new translations you may submit these to your translation SaaS by the WebProfiler toolbar.

New translations to SaaS

You may also change translations and flag them from the same WebProfiler page.

Manage translations with SaaS

When you want to fetch new translations from your SaaS you should run the synchronize command. This command will keep your current placeholders from missing translations.

php app/console happyr:translation:sync

Install

Install the bundle with composer require happyr/translation-bundle

You do also need to choose what library to use when you are sending http messages. Consult the php-http/client-implementation virtual package to find adapters to use. For more information about virtual packages please refer to Httplug. Example:

php composer.phar require php-http/guzzle6-adapter

This bundle require you to register a service for the HttpClient and the MessageFactory and then set service name to the config like below. The easiest way of doing this is with the HttplugBundle.

happyr_translation:
  httplug_client: 'httplug.client'
  httplug_message_factory: 'httplug.message_factory'

Configure

If you have one Loco project per domain you may configure the bundle like this:

# /app/config/config.yml
happyr_translation:
  locales: ['en','sv','fr','es']
  projects:
    messages:
      api_key: 'foobar' 
    navigation:
      api_key: 'bazbar'

If you just doing one project and have tags for all your translation domains you may use this configuration:

# /app/config/config.yml
happyr_translation:
  locales: ['en','sv','fr','es']
  domains: ['messages', 'navigation']
  projects:
    acme:
      api_key: 'foobar'

You do also need to configure a development route.

# /app/config/routing_dev.yml
_happyr_translation:
  resource: '@HappyrTranslationBundle/Resources/config/routing_dev.yml'

Default configuration

happyr_translation:
  httplug_client: 'httplug.client'
  httplug_message_factory: 'httplug.message_factory'	
  file_extension: 'xlf' # could be  'json', 'mo', 'php', 'po', 'yaml' and many more
  locales: []
  domains: []
  translation_service: 'loco'
  target_dir: '%kernel.root_dir%/Resources/translations'
  auto_add_assets: false
  allow_edit: true

TODO

  • The new page in the WebProfiler needs some design and nice icons.
  • The error handling is not always the best.
    • The Loco class
    • In the HttpAdapters
    • In the javascript

Credits

This bundle is both inspired by and is using some of the code from @damienalexandre / JoliCode and from Cliff Odijk's (@cmodijk) LocoBundle.

I would also thank Tim Whitlock (@timwhitlock) for creating Loco.