php-i18n-l10n's Introduction

php-I18n-L10n

PHP library/api to provide Internationalisation and Localisation

License

About

We use the phpmyadmin/twig-i18n-extension for the Twig extension.

How to use

composer require wdes/php-i18n-l10n

Have a look at example file example/simple.php

Example without a MO file

<?php

declare(strict_types = 1);

// Can be removed :)

require_once __DIR__ . '/../vendor/autoload.php';

use Wdes\phpI18nL10n\plugins\MoReader;
use Wdes\phpI18nL10n\Launcher;
use Wdes\phpI18nL10n\Twig\Extension\I18n as ExtensionI18n;
use Twig\Environment as TwigEnvironment;
use Twig\Loader\ArrayLoader as TwigLoader;

$moReader = new MoReader();
$moReader->setTranslations(
    [
        'Homepage' => 'Page d\'accueil',
    ]
);
// Load the translation plugin
Launcher::setPlugin($moReader);

$twig = new TwigEnvironment(new TwigLoader());
$twig->addExtension(new ExtensionI18n());
// You can use a file instead, see the example using a mo file
$templateContents = <<<HTML
<html>
    <title>{% trans %}Homepage{% endtrans %}</title>
    <body>
        {% trans %}Homepage{% endtrans %}
    </body>
</html>
HTML;
echo $twig->createTemplate($templateContents)->render([]);

Example with a MO file

<?php

declare(strict_types = 1);

// Can be removed :)

require_once __DIR__ . '/../vendor/autoload.php';

use Wdes\phpI18nL10n\plugins\MoReader;
use Wdes\phpI18nL10n\Launcher;
use Wdes\phpI18nL10n\Twig\Extension\I18n as ExtensionI18n;
use Twig\Environment as TwigEnvironment;
use Twig\Loader\FilesystemLoader as TwigLoaderFilesystem;

$dataDir  = __DIR__ . '/locale/';
$moReader = new MoReader();
$moReader->readFile($dataDir . 'fr.mo'); // Load the file you want (a specific language for example)
// Load the translation plugin
Launcher::setPlugin($moReader);

$loader = new TwigLoaderFilesystem([ __DIR__ . '/templates/' ]); // Load all templates from the dir
$twig   = new TwigEnvironment($loader);

$twig->addExtension(new ExtensionI18n());
echo $twig->render(
    'homepage.twig', // Can be found in the templates directory
    [
        'keyForTwig' => 'theValue', // Just an example line ;)
        'say' => 'Hello world'
    ]
);

Scripts

This package includes some scripts that can be usefull scripts/tools

Here is an example to use them : scripts/update-example.sh

php-i18n-l10n's People

Contributors

Stargazers

Watchers

php-i18n-l10n's Issues

\Twig\Environment::createTemplate will return \Twig\TemplateWrapper, not \Twig_Template

As title, the Twig will change return instance in this \Twig\Environment::createTemplate method when Twig version is v2.11.0.

The failed Travis CI build log is available here.

The previous Travis CI build log is fine because the package used the Twig version is v2.6.0.

And it also effects the preg_match_all behavior inside MemoryCache::extractDoDisplayFromCache method.

References

Script to create initial po files

Searching into /home/jaspe/Documents/wdes/doctum/build/twigcache for *.php, output Doctum.pot into /home/jaspe/Documents/wdes/doctum/locale
PoDir: /home/jaspe/Documents/wdes/doctum/locale/
File: /home/jaspe/Documents/wdes/doctum/locale/fr.po
msgfmt: /home/jaspe/Documents/wdes/doctum/locale/fr.po: AVERTISSEMENT : l'en-tête du fichier .po est absent ou invalide
                                                        AVERTISSEMENT : la conversion d'encodage ne fonctionnera pas
msgfmt: 1 erreur fatale trouvée