Skip to content

[Translation] Remove TranslatorBagInterface to allow for optimized caching in 3.0 #14530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 14 commits into from
Closed

[Translation] Remove TranslatorBagInterface to allow for optimized caching in 3.0 #14530

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
65962c3
Add FallbackLocaleAwareInterface to obtain the locale actually used f…
mpdude May 3, 2015
2688b09
Keep test methods around as long as we still implement the interface
mpdude May 3, 2015
3077d80
Add note for future me.
mpdude May 3, 2015
fa055ec
For BC, use an adapter class to implement FallbackLocaleAwareInterfac…
mpdude Sep 24, 2015
e4bba37
Add deprecation notices to docblocks
mpdude Sep 24, 2015
372c247
Avoid unnecessary code change
mpdude Sep 24, 2015
98b1a74
use strict comparison
mpdude Sep 24, 2015
89df6f5
Use `if` instead of `elseif` because the `if` returns
mpdude Sep 24, 2015
24f0830
Update legacy tests
mpdude Sep 24, 2015
1364559
Improve deprecation notice
mpdude Sep 24, 2015
c0f6bf0
Improve docblock
mpdude Sep 24, 2015
4df5021
Fabbot
mpdude Sep 24, 2015
2a72a09
We must not require clients to implement a deprecated interface
mpdude Sep 25, 2015
ad53737
Typo pointed out by FabBot
mpdude Sep 27, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
For BC, use an adapter class to implement FallbackLocaleAwareInterfac… 
…e on top of TranslatorBagInterface
  • Loading branch information
@mpdude
mpdude committed Oct 3, 2015
commit fa055ec4d0b0de6a62ea4ba41a40eb35d778802e
17 changes: 14 additions & 3 deletions src/Symfony/Component/Translation/DataCollectorTranslator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,24 @@ class DataCollectorTranslator implements TranslatorInterface, TranslatorBagInter
*/
private $messages = array();

/**
* @var FallbackLocaleAwareInterface
*/
private $fallbackLocaleAware;

/**
* @param TranslatorInterface $translator The translator must implement TranslatorBagInterface
*/
public function __construct(TranslatorInterface $translator)
{
if (!($translator instanceof TranslatorBagInterface && $translator instanceof FallbackLocaleAwareInterface)) {
throw new \InvalidArgumentException(sprintf('The Translator "%s" must implement TranslatorInterface, TranslatorBagInterface and FallbackLocaleAwareInterface.', get_class($translator)));
if (!($translator instanceof TranslatorBagInterface)) {
throw new \InvalidArgumentException(sprintf('The Translator "%s" must implement TranslatorInterface and TranslatorBagInterface.', get_class($translator)));
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to fix that. The interface is deprecated and must not be required.

}

if (!($translator instanceof FallbackLocaleAwareInterface)) {
$this->fallbackLocaleAware = new TranslatorBagToFallbackLocaleAwareAdapter($translator);
} else {
$this->fallbackLocaleAware = $translator;
}

$this->translator = $translator;
Expand Down Expand Up @@ -69,7 +80,7 @@ public function transChoice($id, $number, array $parameters = array(), $domain =
*/
public function resolveLocale($id, $domain = null, $locale = null)
{
return $this->translator->resolveLocale($id, $domain, $locale);
return $this->fallbackLocaleAware->resolveLocale($id, $domain, $locale);
}

/**
Expand Down
17 changes: 14 additions & 3 deletions src/Symfony/Component/Translation/LoggingTranslator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,25 @@ class LoggingTranslator implements TranslatorInterface, TranslatorBagInterface,
*/
private $logger;

/**
* @var FallbackLocaleAwareInterface
*/
private $fallbackLocaleAware;

/**
* @param TranslatorInterface $translator The translator must implement TranslatorBagInterface
* @param LoggerInterface $logger
*/
public function __construct(TranslatorInterface $translator, LoggerInterface $logger)
{
if (!($translator instanceof TranslatorBagInterface && $translator instanceof FallbackLocaleAwareInterface)) {
throw new \InvalidArgumentException(sprintf('The Translator "%s" must implement TranslatorInterface, TranslatorBagInterface and FallbackLocaleAwareInterface.', get_class($translator)));
if (!($translator instanceof TranslatorBagInterface)) {
throw new \InvalidArgumentException(sprintf('The Translator "%s" must implement TranslatorInterface and TranslatorBagInterface.', get_class($translator)));
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here

}

if (!($translator instanceof FallbackLocaleAwareInterface)) {
$this->fallbackLocaleAware = new TranslatorBagToFallbackLocaleAwareAdapter($translator);
} else {
$this->fallbackLocaleAware = $translator;
}

$this->translator = $translator;
Expand Down Expand Up @@ -69,7 +80,7 @@ public function transChoice($id, $number, array $parameters = array(), $domain =
*/
public function resolveLocale($id, $domain = null, $locale = null)
{
return $this->translator->resolveLocale($id, $domain, $locale);
return $this->fallbackLocaleAware->resolveLocale($id, $domain, $locale);
}

/**
Expand Down
55 changes: 55 additions & 0 deletions src/Symfony/Component/Translation/TranslatorBagToFallbackLocaleAwareAdapter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Symfony\Component\Translation;

/**
* Implements the FallbackLocaleAwareInterface by using the
* TranslatorBagInterface.
*
* It will iterate along the catalogue chain in order to find the
* first locale that contains a given message.
*
* Needed for a BC transition from Symfony 2.8 to 3.0. To be removed
* Symfony 3.0.
*
* @deprecated
*/
class TranslatorBagToFallbackLocaleAwareAdapter implements FallbackLocaleAwareInterface
{
private $translatorBag;

public function __construct(TranslatorBagInterface $translatorBag)
{
$this->translatorBag = $translatorBag;
}

/**
* {@inheritdoc}
*/
public function resolveLocale($id, $domain = null, $locale = null)
{
$id = (string)$id;
$catalogue = $this->translatorBag->getCatalogue($locale);
$locale = $catalogue->getLocale();

while (!$catalogue->defines($id, $domain)) {
if ($cat = $catalogue->getFallbackCatalogue()) {
$catalogue = $cat;
$locale = $catalogue->getLocale();
} else {
return null;
}
}

return $locale;
}
}