Moved translation/internationalization to Helpers\Translator class
Igor Scheller
6 years ago
parent
df6360044b
commit
427315195b
@ -1,80 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Return currently active locale
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
function locale()
|
|
||||||
{
|
|
||||||
return session()->get('locale');
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns two letter language code from currently active locale
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
function locale_short()
|
|
||||||
{
|
|
||||||
return substr(locale(), 0, 2);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Initializes gettext for internationalization and updates the sessions locale to use for translation.
|
|
||||||
*/
|
|
||||||
function gettext_init()
|
|
||||||
{
|
|
||||||
$locales = config('locales');
|
|
||||||
$request = request();
|
|
||||||
$session = session();
|
|
||||||
|
|
||||||
if ($request->has('set_locale') && isset($locales[$request->input('set_locale')])) {
|
|
||||||
$session->set('locale', $request->input('set_locale'));
|
|
||||||
} elseif (!$session->has('locale')) {
|
|
||||||
$session->set('locale', config('default_locale'));
|
|
||||||
}
|
|
||||||
|
|
||||||
gettext_locale();
|
|
||||||
bindtextdomain('default', app('path.lang'));
|
|
||||||
bind_textdomain_codeset('default', 'UTF-8');
|
|
||||||
textdomain('default');
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Swich gettext locale.
|
|
||||||
*
|
|
||||||
* @param string $locale
|
|
||||||
*/
|
|
||||||
function gettext_locale($locale = null)
|
|
||||||
{
|
|
||||||
if (empty($locale)) {
|
|
||||||
$locale = session()->get('locale');
|
|
||||||
}
|
|
||||||
|
|
||||||
putenv('LC_ALL=' . $locale);
|
|
||||||
setlocale(LC_ALL, $locale);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Renders language selection.
|
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
function make_langselect()
|
|
||||||
{
|
|
||||||
$request = app('request');
|
|
||||||
|
|
||||||
$items = [];
|
|
||||||
foreach (config('locales') as $locale => $name) {
|
|
||||||
$url = url($request->getPathInfo(), ['set_locale' => $locale]);
|
|
||||||
|
|
||||||
$items[] = toolbar_item_link(
|
|
||||||
htmlspecialchars($url),
|
|
||||||
'',
|
|
||||||
$name,
|
|
||||||
$locale == locale()
|
|
||||||
);
|
|
||||||
}
|
|
||||||
return $items;
|
|
||||||
}
|
|
||||||
@ -0,0 +1,58 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Engelsystem\Helpers;
|
||||||
|
|
||||||
|
use Engelsystem\Config\Config;
|
||||||
|
use Engelsystem\Container\ServiceProvider;
|
||||||
|
use Symfony\Component\HttpFoundation\Session\Session;
|
||||||
|
|
||||||
|
class TranslationServiceProvider extends ServiceProvider
|
||||||
|
{
|
||||||
|
public function register()
|
||||||
|
{
|
||||||
|
/** @var Config $config */
|
||||||
|
$config = $this->app->get('config');
|
||||||
|
/** @var Session $session */
|
||||||
|
$session = $this->app->get('session');
|
||||||
|
|
||||||
|
$locales = $config->get('locales');
|
||||||
|
$locale = $config->get('default_locale');
|
||||||
|
|
||||||
|
$sessionLocale = $session->get('locale', $locale);
|
||||||
|
if (isset($locales[$sessionLocale])) {
|
||||||
|
$locale = $sessionLocale;
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->initGettext();
|
||||||
|
$session->set('locale', $locale);
|
||||||
|
|
||||||
|
$translator = $this->app->make(
|
||||||
|
Translator::class,
|
||||||
|
['locale' => $locale, 'locales' => $locales, 'localeChangeCallback' => [$this, 'setLocale']]
|
||||||
|
);
|
||||||
|
$this->app->instance(Translator::class, $translator);
|
||||||
|
$this->app->instance('translator', $translator);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $textDomain
|
||||||
|
* @param string $encoding
|
||||||
|
* @codeCoverageIgnore
|
||||||
|
*/
|
||||||
|
protected function initGettext($textDomain = 'default', $encoding = 'UTF-8')
|
||||||
|
{
|
||||||
|
bindtextdomain($textDomain, $this->app->get('path.lang'));
|
||||||
|
bind_textdomain_codeset($textDomain, $encoding);
|
||||||
|
textdomain($textDomain);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $locale
|
||||||
|
* @codeCoverageIgnore
|
||||||
|
*/
|
||||||
|
public function setLocale($locale)
|
||||||
|
{
|
||||||
|
putenv('LC_ALL=' . $locale);
|
||||||
|
setlocale(LC_ALL, $locale);
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,105 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Engelsystem\Helpers;
|
||||||
|
|
||||||
|
class Translator
|
||||||
|
{
|
||||||
|
/** @var string[] */
|
||||||
|
protected $locales;
|
||||||
|
|
||||||
|
/** @var string */
|
||||||
|
protected $locale;
|
||||||
|
|
||||||
|
/** @var callable */
|
||||||
|
protected $localeChangeCallback;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Translator constructor.
|
||||||
|
*
|
||||||
|
* @param string $locale
|
||||||
|
* @param string[] $locales
|
||||||
|
* @param callable $localeChangeCallback
|
||||||
|
*/
|
||||||
|
public function __construct(string $locale, array $locales = [], callable $localeChangeCallback = null)
|
||||||
|
{
|
||||||
|
$this->localeChangeCallback = $localeChangeCallback;
|
||||||
|
|
||||||
|
$this->setLocale($locale);
|
||||||
|
$this->setLocales($locales);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the translation for a given key
|
||||||
|
*
|
||||||
|
* @param string $key
|
||||||
|
* @param array $replace
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function translate(string $key, array $replace = []): string
|
||||||
|
{
|
||||||
|
$translated = $this->translateGettext($key);
|
||||||
|
|
||||||
|
if (!empty($replace)) {
|
||||||
|
$translated = call_user_func_array('sprintf', array_merge([$translated], $replace));
|
||||||
|
}
|
||||||
|
|
||||||
|
return $translated;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Translate the key via gettext
|
||||||
|
*
|
||||||
|
* @param string $key
|
||||||
|
* @return string
|
||||||
|
* @codeCoverageIgnore
|
||||||
|
*/
|
||||||
|
protected function translateGettext(string $key): string
|
||||||
|
{
|
||||||
|
return _($key);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getLocale(): string
|
||||||
|
{
|
||||||
|
return $this->locale;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $locale
|
||||||
|
*/
|
||||||
|
public function setLocale(string $locale)
|
||||||
|
{
|
||||||
|
$this->locale = $locale;
|
||||||
|
|
||||||
|
if (is_callable($this->localeChangeCallback)) {
|
||||||
|
call_user_func_array($this->localeChangeCallback, [$locale]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string[]
|
||||||
|
*/
|
||||||
|
public function getLocales(): array
|
||||||
|
{
|
||||||
|
return $this->locales;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $locale
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public function hasLocale(string $locale): bool
|
||||||
|
{
|
||||||
|
return isset($this->locales[$locale]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string[] $locales
|
||||||
|
*/
|
||||||
|
public function setLocales(array $locales)
|
||||||
|
{
|
||||||
|
$this->locales = $locales;
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,49 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Engelsystem\Middleware;
|
||||||
|
|
||||||
|
use Engelsystem\Helpers\Translator;
|
||||||
|
use Psr\Http\Message\ResponseInterface;
|
||||||
|
use Psr\Http\Message\ServerRequestInterface;
|
||||||
|
use Psr\Http\Server\MiddlewareInterface;
|
||||||
|
use Psr\Http\Server\RequestHandlerInterface;
|
||||||
|
use Symfony\Component\HttpFoundation\Session\Session;
|
||||||
|
|
||||||
|
class SetLocale implements MiddlewareInterface
|
||||||
|
{
|
||||||
|
/** @var Translator */
|
||||||
|
protected $translator;
|
||||||
|
|
||||||
|
/** @var Session */
|
||||||
|
protected $session;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param Translator $translator
|
||||||
|
* @param Session $session
|
||||||
|
*/
|
||||||
|
public function __construct(Translator $translator, Session $session)
|
||||||
|
{
|
||||||
|
$this->translator = $translator;
|
||||||
|
$this->session = $session;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Process an incoming server request and setting the locale if required
|
||||||
|
*
|
||||||
|
* @param ServerRequestInterface $request
|
||||||
|
* @param RequestHandlerInterface $handler
|
||||||
|
* @return ResponseInterface
|
||||||
|
*/
|
||||||
|
public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
|
||||||
|
{
|
||||||
|
$query = $request->getQueryParams();
|
||||||
|
if (isset($query['set-locale']) && $this->translator->hasLocale($query['set-locale'])) {
|
||||||
|
$locale = $query['set-locale'];
|
||||||
|
|
||||||
|
$this->translator->setLocale($locale);
|
||||||
|
$this->session->set('locale', $locale);
|
||||||
|
}
|
||||||
|
|
||||||
|
return $handler->handle($request);
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,86 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Engelsystem\Test\Unit\Helpers;
|
||||||
|
|
||||||
|
use Engelsystem\Config\Config;
|
||||||
|
use Engelsystem\Helpers\TranslationServiceProvider;
|
||||||
|
use Engelsystem\Helpers\Translator;
|
||||||
|
use Engelsystem\Test\Unit\ServiceProviderTest;
|
||||||
|
use PHPUnit\Framework\MockObject\MockObject;
|
||||||
|
use Symfony\Component\HttpFoundation\Session\Session;
|
||||||
|
|
||||||
|
class TranslationServiceProviderTest extends ServiceProviderTest
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @covers \Engelsystem\Helpers\TranslationServiceProvider::register()
|
||||||
|
*/
|
||||||
|
public function testRegister()
|
||||||
|
{
|
||||||
|
$app = $this->getApp(['make', 'instance', 'get']);
|
||||||
|
/** @var Config|MockObject $config */
|
||||||
|
$config = $this->createMock(Config::class);
|
||||||
|
/** @var Session|MockObject $session */
|
||||||
|
$session = $this->createMock(Session::class);
|
||||||
|
/** @var Translator|MockObject $translator */
|
||||||
|
$translator = $this->createMock(Translator::class);
|
||||||
|
|
||||||
|
/** @var TranslationServiceProvider|MockObject $serviceProvider */
|
||||||
|
$serviceProvider = $this->getMockBuilder(TranslationServiceProvider::class)
|
||||||
|
->setConstructorArgs([$app])
|
||||||
|
->setMethods(['initGettext', 'setLocale'])
|
||||||
|
->getMock();
|
||||||
|
|
||||||
|
$serviceProvider->expects($this->once())
|
||||||
|
->method('initGettext');
|
||||||
|
|
||||||
|
$app->expects($this->exactly(2))
|
||||||
|
->method('get')
|
||||||
|
->withConsecutive(['config'], ['session'])
|
||||||
|
->willReturnOnConsecutiveCalls($config, $session);
|
||||||
|
|
||||||
|
$defaultLocale = 'fo_OO';
|
||||||
|
$locale = 'te_ST.WTF-9';
|
||||||
|
$locales = ['fo_OO' => 'Foo', 'fo_OO.BAR' => 'Foo (Bar)', 'te_ST.WTF-9' => 'WTF\'s Testing?'];
|
||||||
|
$config->expects($this->exactly(2))
|
||||||
|
->method('get')
|
||||||
|
->withConsecutive(
|
||||||
|
['locales'],
|
||||||
|
['default_locale']
|
||||||
|
)
|
||||||
|
->willReturnOnConsecutiveCalls(
|
||||||
|
$locales,
|
||||||
|
$defaultLocale
|
||||||
|
);
|
||||||
|
|
||||||
|
$session->expects($this->once())
|
||||||
|
->method('get')
|
||||||
|
->with('locale', $defaultLocale)
|
||||||
|
->willReturn($locale);
|
||||||
|
$session->expects($this->once())
|
||||||
|
->method('set')
|
||||||
|
->with('locale', $locale);
|
||||||
|
|
||||||
|
$app->expects($this->once())
|
||||||
|
->method('make')
|
||||||
|
->with(
|
||||||
|
Translator::class,
|
||||||
|
[
|
||||||
|
'locale' => $locale,
|
||||||
|
'locales' => $locales,
|
||||||
|
'localeChangeCallback' => [$serviceProvider, 'setLocale']
|
||||||
|
]
|
||||||
|
)
|
||||||
|
->willReturn($translator);
|
||||||
|
|
||||||
|
$app->expects($this->exactly(2))
|
||||||
|
->method('instance')
|
||||||
|
->withConsecutive(
|
||||||
|
[Translator::class, $translator],
|
||||||
|
['translator', $translator]
|
||||||
|
);
|
||||||
|
|
||||||
|
$serviceProvider->register();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
@ -0,0 +1,69 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Engelsystem\Test\Unit\Helpers;
|
||||||
|
|
||||||
|
use Engelsystem\Helpers\Translator;
|
||||||
|
use Engelsystem\Test\Unit\ServiceProviderTest;
|
||||||
|
use PHPUnit\Framework\MockObject\MockObject;
|
||||||
|
use stdClass;
|
||||||
|
|
||||||
|
class TranslatorTest extends ServiceProviderTest
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @covers \Engelsystem\Helpers\Translator::__construct()
|
||||||
|
* @covers \Engelsystem\Helpers\Translator::setLocale()
|
||||||
|
* @covers \Engelsystem\Helpers\Translator::setLocales()
|
||||||
|
* @covers \Engelsystem\Helpers\Translator::getLocale()
|
||||||
|
* @covers \Engelsystem\Helpers\Translator::getLocales()
|
||||||
|
* @covers \Engelsystem\Helpers\Translator::hasLocale()
|
||||||
|
*/
|
||||||
|
public function testInit()
|
||||||
|
{
|
||||||
|
$locales = ['te_ST.ER-01' => 'Tests', 'fo_OO' => 'SomeFOO'];
|
||||||
|
$locale = 'te_ST.ER-01';
|
||||||
|
|
||||||
|
/** @var callable|MockObject $callable */
|
||||||
|
$callable = $this->getMockBuilder(stdClass::class)
|
||||||
|
->setMethods(['__invoke'])
|
||||||
|
->getMock();
|
||||||
|
$callable->expects($this->exactly(2))
|
||||||
|
->method('__invoke')
|
||||||
|
->withConsecutive(['te_ST.ER-01'], ['fo_OO']);
|
||||||
|
|
||||||
|
$translator = new Translator($locale, $locales, $callable);
|
||||||
|
|
||||||
|
$this->assertEquals($locales, $translator->getLocales());
|
||||||
|
$this->assertEquals($locale, $translator->getLocale());
|
||||||
|
|
||||||
|
$translator->setLocale('fo_OO');
|
||||||
|
$this->assertEquals('fo_OO', $translator->getLocale());
|
||||||
|
|
||||||
|
$newLocales = ['lo_RM' => 'Lorem', 'ip_SU-M' => 'Ipsum'];
|
||||||
|
$translator->setLocales($newLocales);
|
||||||
|
$this->assertEquals($newLocales, $translator->getLocales());
|
||||||
|
|
||||||
|
$this->assertTrue($translator->hasLocale('ip_SU-M'));
|
||||||
|
$this->assertFalse($translator->hasLocale('te_ST.ER-01'));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers \Engelsystem\Helpers\Translator::translate()
|
||||||
|
*/
|
||||||
|
public function testTranslate()
|
||||||
|
{
|
||||||
|
/** @var Translator|MockObject $translator */
|
||||||
|
$translator = $this->getMockBuilder(Translator::class)
|
||||||
|
->setConstructorArgs(['de_DE.UTF-8', ['de_DE.UTF-8' => 'Deutsch']])
|
||||||
|
->setMethods(['translateGettext'])
|
||||||
|
->getMock();
|
||||||
|
$translator->expects($this->once())
|
||||||
|
->method('translateGettext')
|
||||||
|
->with('My favourite number is %u!')
|
||||||
|
->willReturn('Meine Lieblingszahl ist die %u!');
|
||||||
|
|
||||||
|
$return = $translator->translate('My favourite number is %u!', [3]);
|
||||||
|
$this->assertEquals('Meine Lieblingszahl ist die 3!', $return);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
@ -0,0 +1,71 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Engelsystem\Test\Unit\Middleware;
|
||||||
|
|
||||||
|
use Engelsystem\Helpers\Translator;
|
||||||
|
use Engelsystem\Middleware\SetLocale;
|
||||||
|
use PHPUnit\Framework\TestCase;
|
||||||
|
use PHPUnit_Framework_MockObject_MockObject as MockObject;
|
||||||
|
use Psr\Http\Message\ResponseInterface;
|
||||||
|
use Psr\Http\Message\ServerRequestInterface;
|
||||||
|
use Psr\Http\Server\RequestHandlerInterface;
|
||||||
|
use Symfony\Component\HttpFoundation\Session\Session;
|
||||||
|
|
||||||
|
class SetLocaleTest extends TestCase
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @covers \Engelsystem\Middleware\SetLocale::__construct
|
||||||
|
* @covers \Engelsystem\Middleware\SetLocale::process
|
||||||
|
*/
|
||||||
|
public function testRegister()
|
||||||
|
{
|
||||||
|
/** @var Translator|MockObject $translator */
|
||||||
|
$translator = $this->createMock(Translator::class);
|
||||||
|
/** @var Session|MockObject $session */
|
||||||
|
$session = $this->createMock(Session::class);
|
||||||
|
/** @var ServerRequestInterface|MockObject $request */
|
||||||
|
$request = $this->getMockForAbstractClass(ServerRequestInterface::class);
|
||||||
|
/** @var RequestHandlerInterface|MockObject $handler */
|
||||||
|
$handler = $this->getMockForAbstractClass(RequestHandlerInterface::class);
|
||||||
|
/** @var ResponseInterface|MockObject $response */
|
||||||
|
$response = $this->getMockForAbstractClass(ResponseInterface::class);
|
||||||
|
|
||||||
|
$locale = 'te_ST.UTF8';
|
||||||
|
|
||||||
|
$request->expects($this->exactly(3))
|
||||||
|
->method('getQueryParams')
|
||||||
|
->willReturnOnConsecutiveCalls(
|
||||||
|
[],
|
||||||
|
['set-locale' => 'en_US.UTF8'],
|
||||||
|
['set-locale' => $locale]
|
||||||
|
);
|
||||||
|
|
||||||
|
$translator->expects($this->exactly(2))
|
||||||
|
->method('hasLocale')
|
||||||
|
->withConsecutive(
|
||||||
|
['en_US.UTF8'],
|
||||||
|
[$locale]
|
||||||
|
)
|
||||||
|
->willReturnOnConsecutiveCalls(
|
||||||
|
false,
|
||||||
|
true
|
||||||
|
);
|
||||||
|
$translator->expects($this->once())
|
||||||
|
->method('setLocale')
|
||||||
|
->with($locale);
|
||||||
|
|
||||||
|
$session->expects($this->once())
|
||||||
|
->method('set')
|
||||||
|
->with('locale', $locale);
|
||||||
|
|
||||||
|
$handler->expects($this->exactly(3))
|
||||||
|
->method('handle')
|
||||||
|
->with($request)
|
||||||
|
->willReturn($response);
|
||||||
|
|
||||||
|
$middleware = new SetLocale($translator, $session);
|
||||||
|
$middleware->process($request, $handler);
|
||||||
|
$middleware->process($request, $handler);
|
||||||
|
$middleware->process($request, $handler);
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue