jblond/twig-trans

Twig 3 translation extension

Twig Trans

Introduction

This is the replacement for the old Twig Extensions I18n / Intl / I18nExtension for the translation with po / mo gettext files.

I didn't want to install Symfony, but Twig only. Symfony seemed to be too much overhead.

This extension enables Twig templates to use |trans and {% trans %} + {% endtrans %} again

Install

composer require jblond/twig-trans

Example Use

<?php

use jblond\TwigTrans\Translation;
use Twig\Environment;
use Twig\Loader\FilesystemLoader;
use Twig\TwigFilter;

require '../vendor/autoload.php';

$langCode = 'de_DE';
putenv("LC_ALL=$langCode.UTF-8");
if (setlocale(LC_ALL, "$langCode.UTF-8") === false) {
    echo sprintf('Language Code %s not found', $langCode);
}

// set the path to the translation
bindtextdomain("Web_Content", "./locale");

// choose Domain
textdomain("Web_Content");

$twigConfig = [
    'cache' => false,
    'debug' => true,
    'auto_reload' => true
];

$twigLoader = new FilesystemLoader('./tpl/');
$twig = new Environment($twigLoader, $twigConfig);
// if you need  {{ dump() }} in the twig templates add
//$twig->addExtension(new DebugExtension());
// and use Twig\Extension\DebugExtension;  // at the top of the file

// this is for the filter |trans
$filter = new TwigFilter(
    'trans', 
    function ($context, $string) {
        return Translation::transGetText($string, $context);
    }, 
    ['needs_context' => true]
);
$twig->addFilter($filter);

// load the i18n extension for using the translation tag for twig
// {% trans %}my string{% endtrans %}
$twig->addExtension(new Translation());

try {
    $tpl = $twig->load('default.twig');
} catch (Exception $exception) {
    echo $exception->getMessage();
    die();
}

// the array parameter (context) is optional for the render function
echo $tpl->render(['key1' => 'value1', 'key2' => 'value2']);

Requirements

• PHP 7.2 or greater
• PHP Multibyte String ' gettext'
• Twig >= 3.0

Optional Requirements

• xgettext for Extract / generating po files.

License (MIT License)

see License

Tests

composer run-script php_src
composer run-script php_test
composer run-script phpunit

Contribution, wishes and bug

Raise an issue

twig-trans's Issues

Bug: Objects in $context cause error

Was hoping to use this plugin with twig 3 since the symfony translation thing does not seem to work with xgettext, but came upon a significant issue.

In Translation::replaceContext the code does not account for objects. So if my context has something like:

'reply' => (object) [
  'id' => 123,
  'body' => 'some text'
]

PHP errors out when you get to the str_replace on line 50.

Also might save considerable effort if the string were first checked for {{ to see if any vars even need replacing.

I'm going to fork and code a fix. Maybe you'll be interested in a PR then if this project is still active.

Add trans with syntax

Hi there,
is it possible for you, to add trans with {'key': value, ...} syntax for the trans tag?
So translation first and then the replace of the keys inside the string.

This optional with parameter will be very helpful. (for older projects with this syntax)

Have a nice day.

trans filter definition

Hello, I have this environment: PHP 8.2, Twig 3.5.1, jblond/twig-trans 1.1.0

Filter was defined as shown into README:

$filter = new TwigFilter(
    'trans', 
    function ($context, $string) {
        return Translation::transGetText($string, $context);
    }, 
    ['needs_context' => true]
);

Templates were generated into cache (by a script that once worked without problems) but:

• trans tags worked correctly (rendered as echo gettext("text-to-be-translated");)
• trans filters were instead rendered into cache template as $this->env->getFilter('trans')->getCallable()("text-to-be-translated");

Consequently .po files generated by xgettext did not show text to be translated with the trans filter

After digging into Twig code I came up wit the following solution:

$filter = new TwigFilter(
  'trans', 
  'gettext',
  [ 'is_safe_callback' => 'twig_escape_filter_is_safe']
);

Maybe this helps someone else stuck in the same situation
Cheers!

Generating po files from cached twig

Hello,

First, thank you for providing this, it is very helpful in my project and works as expected!

Previously, for generating translation files (.mo/.po) I used to force generation of twig cache files from templates, so that xgettext could grab the string from gettext() call and generate the .po (script link). This was possible because in v2 the cache generated code would use the gettext() function.

Now with the plugin it is not the case anymore. Example output:

echo twig_escape_filter($this->env, call_user_func_array($this->env->getFilter('trans')->getCallable(), [$context, "go back to login page"]), "html", null, true);

So do you think it would be possible to somehow be able to use this workflow again?

Please consider this issue more like a question rather than a feature request. I was able to workaround this limitation by buying the PRO version of Poedit which can extract from twig templates directly, thereby rendering the previous workflow caducous. But this might prove useful to other users I guess, so maybe it is worth investigating, I don't know.

Best,
~Nico

trans arguments are ignored

I'm leaving this in case anyone else encounters the same problem

{{ "hello_message"|trans({'username': user.name}) }}

Where hello_message is hi %username%!.

This case won't work because the third param of TwigFilter is being ignored.

To make it work i refactored the filter like this:

$filter = new TwigFilter(
        'trans',
        function ($string, $args) {
            return empty($args) ? _($string) : tprintf(_($string), $args);
        },
    );

But maybe it could be compatible with both scenarios with:

$filter = new TwigFilter(
        'trans',
        function ($context, $string, $args) {
            return \jblond\TwigTrans\Translation::transGetText($string, empty($args) ? $context : $args);
        },
        ['needs_context' => true]
    );