sergeil/extjslocalization-bundle

Adds localization support for ExtJs classes to Symfony2

v1.2.3 2019-12-12 11:10 UTC

Requires

• php: >=5.6
• symfony/framework-bundle: ^2.8|^3.4|^4.0
• symfony/translation: ^2.8|^3.4|^4.0

Requires (Dev)

• phpunit/phpunit: ~5.0

MIT

• Sergei Lissovski

• translation
• l10n
• extjs

README

This bundles makes it possible to extract translation tokens from ExtJs classes, let you translate them and then have your ExtJs classes localized.

This is how a sample ExtJs may look like that this bundle is able to parse:

Ext.define('Company.foo.bar.MyClass', {
    // l10n
    firstnameText: 'Firstname',
    lastnameText: 'Lastname',

    doSomething: function() {
        // ...
    }
});

Shortly, in order the task to detect your extjs class it must comply with the following rules:

• Before the very first translation token this comment must be placed - // l10n
• Translation tokens must be suffixed with "Text", for example - firstnameText
• One blank line must follow after translation tokens and other class members (other properties, methods etc)
• Do not add any blank lines between translation tokens (you might be tempted to do this to group your tokens semantically)

Usage

Most of the time all you need to do in order to start translating your project's extjs classes is to execute the following command:

php app/console sli:update-extjs-translation fr AcmeDemoBundle --output-format=xlf

After executing the command, given that you have AcmeDemoBundle installed in your project and the bundle has "Resources/public/js/" directory ( and some classes inside it ), then the command will parse the files inside this directory and generate Resources/translations/extjs.fr.xlf file.

Once you have some translation catalogues in place, in your templates you can use either this:

<script type="text/javascript" src="{{ path('sli_extjs_route', { locale: 'fr' }) }}"></script>

or this:

<script type="text/javascript">
  {{ render(url('sli_extjs_route', { locale: 'fr' })) }}}
</script>

to have them loaded. The only difference between these two examples is that in the second one, the generated by bundle javascript code will be embedded into the template.

If you need to change URL that is used to generate extjs-localization code then you can override value of sli_ext_js_localization.route service container configuration parameter.

Installation

Add this dependency to your composer.json:

"sergeil/extjslocalization-bundle": "dev-develop"

Update your AppKernel class and add this:

new \Sli\ExtJsLocalizationBundle\SliExtJsLocalizationBundle(),

Licensing

This bundle is under the MIT license. See the complete license in the bundle: Resources/meta/LICENSE