vendor/symfony/symfony/src/Symfony/Bundle/FrameworkBundle/Translation/Translator.php line 128

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Bundle\FrameworkBundle\Translation;
  14. use Psr\Container\ContainerInterface;
  15. use Symfony\Component\DependencyInjection\ContainerInterface as SymfonyContainerInterface;
  16. use Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface;
  17. use Symfony\Component\Translation\Translator as BaseTranslator;
  18. use Symfony\Component\Translation\Exception\InvalidArgumentException;
  19. use Symfony\Component\Translation\Formatter\MessageFormatterInterface;
  21. /**
  22.  * Translator.
  23.  *
  24.  * @author Fabien Potencier <fabien@symfony.com>
  25.  */
  26. class Translator extends BaseTranslator implements WarmableInterface
  27. {
  28.     protected $container;
  29.     protected $loaderIds;
  31.     protected $options = array(
  32.         'cache_dir' => null,
  33.         'debug' => false,
  34.         'resource_files' => array(),
  35.     );
  37.     /**
  38.      * @var array
  39.      */
  40.     private $resourceLocales;
  42.     /**
  43.      * Holds parameters from addResource() calls so we can defer the actual
  44.      * parent::addResource() calls until initialize() is executed.
  45.      *
  46.      * @var array
  47.      */
  48.     private $resources = array();
  50.     /**
  51.      * Constructor.
  52.      *
  53.      * Available options:
  54.      *
  55.      *   * cache_dir: The cache directory (or null to disable caching)
  56.      *   * debug:     Whether to enable debugging or not (false by default)
  57.      *   * resource_files: List of translation resources available grouped by locale.
  58.      *
  59.      * @param ContainerInterface        $container     A ContainerInterface instance
  60.      * @param MessageFormatterInterface $formatter     The message formatter
  61.      * @param string                    $defaultLocale
  62.      * @param array                     $loaderIds     An array of loader Ids
  63.      * @param array                     $options       An array of options
  64.      *
  65.      * @throws InvalidArgumentException
  66.      */
  67.     public function __construct(ContainerInterface $container, $formatter, $defaultLocale = null, array $loaderIds = array(), array $options = array())
  68.     {
  69.         // BC 3.x, to be removed in 4.0 along with the $defaultLocale default value
  70.         if (is_array($defaultLocale) || 3 > func_num_args()) {
  71.             if (!$container instanceof SymfonyContainerInterface) {
  72.                 throw new \InvalidArgumentException('Missing third $defaultLocale argument.');
  73.             }
  75.             $options = $loaderIds;
  76.             $loaderIds = $defaultLocale;
  77.             $defaultLocale = $container->getParameter('kernel.default_locale');
  78.             @trigger_error(sprintf('Method %s() takes the default locale as 3rd argument since Symfony 3.3. Not passing it is deprecated and will trigger an error in 4.0.', __METHOD__), E_USER_DEPRECATED);
  79.         }
  81.         $this->container = $container;
  82.         $this->loaderIds = $loaderIds;
  84.         // check option names
  85.         if ($diff = array_diff(array_keys($options), array_keys($this->options))) {
  86.             throw new InvalidArgumentException(sprintf('The Translator does not support the following options: \'%s\'.', implode('\', \'', $diff)));
  87.         }
  89.         $this->options = array_merge($this->options, $options);
  90.         $this->resourceLocales = array_keys($this->options['resource_files']);
  91.         $this->addResourceFiles($this->options['resource_files']);
  93.         parent::__construct($defaultLocale, $formatter, $this->options['cache_dir'], $this->options['debug']);
  94.     }
  96.     /**
  97.      * {@inheritdoc}
  98.      */
  99.     public function warmUp($cacheDir)
  100.     {
  101.         // skip warmUp when translator doesn't use cache
  102.         if (null === $this->options['cache_dir']) {
  103.             return;
  104.         }
  106.         $locales = array_merge($this->getFallbackLocales(), array($this->getLocale()), $this->resourceLocales);
  107.         foreach (array_unique($locales) as $locale) {
  108.             // reset catalogue in case it's already loaded during the dump of the other locales.
  109.             if (isset($this->catalogues[$locale])) {
  110.                 unset($this->catalogues[$locale]);
  111.             }
  113.             $this->loadCatalogue($locale);
  114.         }
  115.     }
  117.     public function addResource($format, $resource, $locale, $domain = null)
  118.     {
  119.         $this->resources[] = array($format, $resource, $locale, $domain);
  120.     }
  122.     /**
  123.      * {@inheritdoc}
  124.      */
  125.     protected function initializeCatalogue($locale)
  126.     {
  127.         $this->initialize();
  128.         parent::initializeCatalogue($locale);
  129.     }
  131.     protected function initialize()
  132.     {
  133.         foreach ($this->resources as $key => $params) {
  134.             list($format, $resource, $locale, $domain) = $params;
  135.             parent::addResource($format, $resource, $locale, $domain);
  136.         }
  137.         $this->resources = array();
  139.         foreach ($this->loaderIds as $id => $aliases) {
  140.             foreach ($aliases as $alias) {
  141.                 $this->addLoader($alias, $this->container->get($id));
  142.             }
  143.         }
  144.     }
  146.     private function addResourceFiles($filesByLocale)
  147.     {
  148.         foreach ($filesByLocale as $locale => $files) {
  149.             foreach ($files as $key => $file) {
  150.                 // filename is domain.locale.format
  151.                 list($domain, $locale, $format) = explode('.', basename($file), 3);
  152.                 $this->addResource($format, $file, $locale, $domain);
  153.             }
  154.         }
  155.     }
  156. }