vendor/symfony/framework-bundle/Translation/Translator.php line 129

  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\Config\Resource\DirectoryResource;
  16. use Symfony\Component\Config\Resource\FileExistenceResource;
  17. use Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface;
  18. use Symfony\Component\Translation\Exception\InvalidArgumentException;
  19. use Symfony\Component\Translation\Formatter\MessageFormatterInterface;
  20. use Symfony\Component\Translation\Translator as BaseTranslator;
  22. /**
  23.  * @author Fabien Potencier <fabien@symfony.com>
  24.  */
  25. class Translator extends BaseTranslator implements WarmableInterface
  26. {
  27.     protected $container;
  28.     protected $loaderIds;
  30.     protected $options = [
  31.         'cache_dir' => null,
  32.         'debug' => false,
  33.         'resource_files' => [],
  34.         'scanned_directories' => [],
  35.         'cache_vary' => [],
  36.     ];
  38.     /**
  39.      * @var list<string>
  40.      */
  41.     private array $resourceLocales;
  43.     /**
  44.      * Holds parameters from addResource() calls so we can defer the actual
  45.      * parent::addResource() calls until initialize() is executed.
  46.      *
  47.      * @var array[]
  48.      */
  49.     private array $resources = [];
  51.     /**
  52.      * @var string[][]
  53.      */
  54.     private array $resourceFiles;
  56.     /**
  57.      * @var string[]
  58.      */
  59.     private array $scannedDirectories;
  61.     /**
  62.      * @var string[]
  63.      */
  64.     private array $enabledLocales;
  66.     /**
  67.      * Constructor.
  68.      *
  69.      * Available options:
  70.      *
  71.      *   * cache_dir:      The cache directory (or null to disable caching)
  72.      *   * debug:          Whether to enable debugging or not (false by default)
  73.      *   * resource_files: List of translation resources available grouped by locale.
  74.      *   * cache_vary:     An array of data that is serialized to generate the cached catalogue name.
  75.      *
  76.      * @throws InvalidArgumentException
  77.      */
  78.     public function __construct(ContainerInterface $container, MessageFormatterInterface $formatter, string $defaultLocale, array $loaderIds = [], array $options = [], array $enabledLocales = [])
  79.     {
  80.         $this->container = $container;
  81.         $this->loaderIds = $loaderIds;
  82.         $this->enabledLocales = $enabledLocales;
  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->resourceFiles = $this->options['resource_files'];
  92.         $this->scannedDirectories = $this->options['scanned_directories'];
  94.         parent::__construct($defaultLocale, $formatter, $this->options['cache_dir'], $this->options['debug'], $this->options['cache_vary']);
  95.     }
  97.     /**
  98.      * @return string[]
  99.      */
  100.     public function warmUp(string $cacheDir): array
  101.     {
  102.         // skip warmUp when translator doesn't use cache
  103.         if (null === $this->options['cache_dir']) {
  104.             return [];
  105.         }
  107.         $localesToWarmUp = $this->enabledLocales ?: array_merge($this->getFallbackLocales(), [$this->getLocale()], $this->resourceLocales);
  109.         foreach (array_unique($localesToWarmUp) as $locale) {
  110.             // reset catalogue in case it's already loaded during the dump of the other locales.
  111.             if (isset($this->catalogues[$locale])) {
  112.                 unset($this->catalogues[$locale]);
  113.             }
  115.             $this->loadCatalogue($locale);
  116.         }
  118.         return [];
  119.     }
  121.     public function addResource(string $format, mixed $resource, string $locale, string $domain = null)
  122.     {
  123.         if ($this->resourceFiles) {
  124.             $this->addResourceFiles();
  125.         }
  126.         $this->resources[] = [$format, $resource, $locale, $domain];
  127.     }
  129.     protected function initializeCatalogue(string $locale)
  130.     {
  131.         $this->initialize();
  132.         parent::initializeCatalogue($locale);
  133.     }
  135.     /**
  136.      * @internal
  137.      */
  138.     protected function doLoadCatalogue(string $locale): void
  139.     {
  140.         parent::doLoadCatalogue($locale);
  142.         foreach ($this->scannedDirectories as $directory) {
  143.             $resourceClass = file_exists($directory) ? DirectoryResource::class : FileExistenceResource::class;
  144.             $this->catalogues[$locale]->addResource(new $resourceClass($directory));
  145.         }
  146.     }
  148.     protected function initialize()
  149.     {
  150.         if ($this->resourceFiles) {
  151.             $this->addResourceFiles();
  152.         }
  153.         foreach ($this->resources as $params) {
  154.             [$format, $resource, $locale, $domain] = $params;
  155.             parent::addResource($format, $resource, $locale, $domain);
  156.         }
  157.         $this->resources = [];
  159.         foreach ($this->loaderIds as $id => $aliases) {
  160.             foreach ($aliases as $alias) {
  161.                 $this->addLoader($alias, $this->container->get($id));
  162.             }
  163.         }
  164.     }
  166.     private function addResourceFiles(): void
  167.     {
  168.         $filesByLocale = $this->resourceFiles;
  169.         $this->resourceFiles = [];
  171.         foreach ($filesByLocale as $files) {
  172.             foreach ($files as $file) {
  173.                 // filename is domain.locale.format
  174.                 $fileNameParts = explode('.', basename($file));
  175.                 $format = array_pop($fileNameParts);
  176.                 $locale = array_pop($fileNameParts);
  177.                 $domain = implode('.', $fileNameParts);
  178.                 $this->addResource($format, $file, $locale, $domain);
  179.             }
  180.         }
  181.     }
  182. }