vendor/symfony/translation/MessageCatalogue.php line 58

  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\Component\Translation;
  14. use Symfony\Component\Config\Resource\ResourceInterface;
  15. use Symfony\Component\Translation\Exception\LogicException;
  17. /**
  18.  * @author Fabien Potencier <fabien@symfony.com>
  19.  */
  20. class MessageCatalogue implements MessageCatalogueInterface, MetadataAwareInterface, CatalogueMetadataAwareInterface
  21. {
  22.     private array $messages = [];
  23.     private array $metadata = [];
  24.     private array $catalogueMetadata = [];
  25.     private array $resources = [];
  26.     private string $locale;
  27.     private ?MessageCatalogueInterface $fallbackCatalogue = null;
  28.     private ?self $parent = null;
  30.     /**
  31.      * @param array $messages An array of messages classified by domain
  32.      */
  33.     public function __construct(string $locale, array $messages = [])
  34.     {
  35.         $this->locale = $locale;
  36.         $this->messages = $messages;
  37.     }
  39.     public function getLocale(): string
  40.     {
  41.         return $this->locale;
  42.     }
  44.     public function getDomains(): array
  45.     {
  46.         $domains = [];
  48.         foreach ($this->messages as $domain => $messages) {
  49.             if (str_ends_with($domain, self::INTL_DOMAIN_SUFFIX)) {
  50.                 $domain = substr($domain, 0, -\strlen(self::INTL_DOMAIN_SUFFIX));
  51.             }
  52.             $domains[$domain] = $domain;
  53.         }
  55.         return array_values($domains);
  56.     }
  58.     public function all(string $domain = null): array
  59.     {
  60.         if (null !== $domain) {
  61.             // skip messages merge if intl-icu requested explicitly
  62.             if (str_ends_with($domain, self::INTL_DOMAIN_SUFFIX)) {
  63.                 return $this->messages[$domain] ?? [];
  64.             }
  66.             return ($this->messages[$domain.self::INTL_DOMAIN_SUFFIX] ?? []) + ($this->messages[$domain] ?? []);
  67.         }
  69.         $allMessages = [];
  71.         foreach ($this->messages as $domain => $messages) {
  72.             if (str_ends_with($domain, self::INTL_DOMAIN_SUFFIX)) {
  73.                 $domain = substr($domain, 0, -\strlen(self::INTL_DOMAIN_SUFFIX));
  74.                 $allMessages[$domain] = $messages + ($allMessages[$domain] ?? []);
  75.             } else {
  76.                 $allMessages[$domain] = ($allMessages[$domain] ?? []) + $messages;
  77.             }
  78.         }
  80.         return $allMessages;
  81.     }
  83.     public function set(string $id, string $translation, string $domain = 'messages')
  84.     {
  85.         $this->add([$id => $translation], $domain);
  86.     }
  88.     public function has(string $id, string $domain = 'messages'): bool
  89.     {
  90.         if (isset($this->messages[$domain][$id]) || isset($this->messages[$domain.self::INTL_DOMAIN_SUFFIX][$id])) {
  91.             return true;
  92.         }
  94.         if (null !== $this->fallbackCatalogue) {
  95.             return $this->fallbackCatalogue->has($id, $domain);
  96.         }
  98.         return false;
  99.     }
  101.     public function defines(string $id, string $domain = 'messages'): bool
  102.     {
  103.         return isset($this->messages[$domain][$id]) || isset($this->messages[$domain.self::INTL_DOMAIN_SUFFIX][$id]);
  104.     }
  106.     public function get(string $id, string $domain = 'messages'): string
  107.     {
  108.         if (isset($this->messages[$domain.self::INTL_DOMAIN_SUFFIX][$id])) {
  109.             return $this->messages[$domain.self::INTL_DOMAIN_SUFFIX][$id];
  110.         }
  112.         if (isset($this->messages[$domain][$id])) {
  113.             return $this->messages[$domain][$id];
  114.         }
  116.         if (null !== $this->fallbackCatalogue) {
  117.             return $this->fallbackCatalogue->get($id, $domain);
  118.         }
  120.         return $id;
  121.     }
  123.     public function replace(array $messages, string $domain = 'messages')
  124.     {
  125.         unset($this->messages[$domain], $this->messages[$domain.self::INTL_DOMAIN_SUFFIX]);
  127.         $this->add($messages, $domain);
  128.     }
  130.     public function add(array $messages, string $domain = 'messages')
  131.     {
  132.         $altDomain = str_ends_with($domain, self::INTL_DOMAIN_SUFFIX) ? substr($domain, 0, -\strlen(self::INTL_DOMAIN_SUFFIX)) : $domain.self::INTL_DOMAIN_SUFFIX;
  133.         foreach ($messages as $id => $message) {
  134.             unset($this->messages[$altDomain][$id]);
  135.             $this->messages[$domain][$id] = $message;
  136.         }
  138.         if ([] === ($this->messages[$altDomain] ?? null)) {
  139.             unset($this->messages[$altDomain]);
  140.         }
  141.     }
  143.     public function addCatalogue(MessageCatalogueInterface $catalogue)
  144.     {
  145.         if ($catalogue->getLocale() !== $this->locale) {
  146.             throw new LogicException(sprintf('Cannot add a catalogue for locale "%s" as the current locale for this catalogue is "%s".', $catalogue->getLocale(), $this->locale));
  147.         }
  149.         foreach ($catalogue->all() as $domain => $messages) {
  150.             if ($intlMessages = $catalogue->all($domain.self::INTL_DOMAIN_SUFFIX)) {
  151.                 $this->add($intlMessages, $domain.self::INTL_DOMAIN_SUFFIX);
  152.                 $messages = array_diff_key($messages, $intlMessages);
  153.             }
  154.             $this->add($messages, $domain);
  155.         }
  157.         foreach ($catalogue->getResources() as $resource) {
  158.             $this->addResource($resource);
  159.         }
  161.         if ($catalogue instanceof MetadataAwareInterface) {
  162.             $metadata = $catalogue->getMetadata('', '');
  163.             $this->addMetadata($metadata);
  164.         }
  166.         if ($catalogue instanceof CatalogueMetadataAwareInterface) {
  167.             $catalogueMetadata = $catalogue->getCatalogueMetadata('', '');
  168.             $this->addCatalogueMetadata($catalogueMetadata);
  169.         }
  170.     }
  172.     public function addFallbackCatalogue(MessageCatalogueInterface $catalogue)
  173.     {
  174.         // detect circular references
  175.         $c = $catalogue;
  176.         while ($c = $c->getFallbackCatalogue()) {
  177.             if ($c->getLocale() === $this->getLocale()) {
  178.                 throw new LogicException(sprintf('Circular reference detected when adding a fallback catalogue for locale "%s".', $catalogue->getLocale()));
  179.             }
  180.         }
  182.         $c = $this;
  183.         do {
  184.             if ($c->getLocale() === $catalogue->getLocale()) {
  185.                 throw new LogicException(sprintf('Circular reference detected when adding a fallback catalogue for locale "%s".', $catalogue->getLocale()));
  186.             }
  188.             foreach ($catalogue->getResources() as $resource) {
  189.                 $c->addResource($resource);
  190.             }
  191.         } while ($c = $c->parent);
  193.         $catalogue->parent = $this;
  194.         $this->fallbackCatalogue = $catalogue;
  196.         foreach ($catalogue->getResources() as $resource) {
  197.             $this->addResource($resource);
  198.         }
  199.     }
  201.     public function getFallbackCatalogue(): ?MessageCatalogueInterface
  202.     {
  203.         return $this->fallbackCatalogue;
  204.     }
  206.     public function getResources(): array
  207.     {
  208.         return array_values($this->resources);
  209.     }
  211.     public function addResource(ResourceInterface $resource)
  212.     {
  213.         $this->resources[$resource->__toString()] = $resource;
  214.     }
  216.     public function getMetadata(string $key = '', string $domain = 'messages'): mixed
  217.     {
  218.         if ('' == $domain) {
  219.             return $this->metadata;
  220.         }
  222.         if (isset($this->metadata[$domain])) {
  223.             if ('' == $key) {
  224.                 return $this->metadata[$domain];
  225.             }
  227.             if (isset($this->metadata[$domain][$key])) {
  228.                 return $this->metadata[$domain][$key];
  229.             }
  230.         }
  232.         return null;
  233.     }
  235.     public function setMetadata(string $key, mixed $value, string $domain = 'messages')
  236.     {
  237.         $this->metadata[$domain][$key] = $value;
  238.     }
  240.     public function deleteMetadata(string $key = '', string $domain = 'messages')
  241.     {
  242.         if ('' == $domain) {
  243.             $this->metadata = [];
  244.         } elseif ('' == $key) {
  245.             unset($this->metadata[$domain]);
  246.         } else {
  247.             unset($this->metadata[$domain][$key]);
  248.         }
  249.     }
  251.     public function getCatalogueMetadata(string $key = '', string $domain = 'messages'): mixed
  252.     {
  253.         if (!$domain) {
  254.             return $this->catalogueMetadata;
  255.         }
  257.         if (isset($this->catalogueMetadata[$domain])) {
  258.             if (!$key) {
  259.                 return $this->catalogueMetadata[$domain];
  260.             }
  262.             if (isset($this->catalogueMetadata[$domain][$key])) {
  263.                 return $this->catalogueMetadata[$domain][$key];
  264.             }
  265.         }
  267.         return null;
  268.     }
  270.     public function setCatalogueMetadata(string $key, mixed $value, string $domain = 'messages')
  271.     {
  272.         $this->catalogueMetadata[$domain][$key] = $value;
  273.     }
  275.     public function deleteCatalogueMetadata(string $key = '', string $domain = 'messages')
  276.     {
  277.         if (!$domain) {
  278.             $this->catalogueMetadata = [];
  279.         } elseif (!$key) {
  280.             unset($this->catalogueMetadata[$domain]);
  281.         } else {
  282.             unset($this->catalogueMetadata[$domain][$key]);
  283.         }
  284.     }
  286.     /**
  287.      * Adds current values with the new values.
  288.      *
  289.      * @param array $values Values to add
  290.      */
  291.     private function addMetadata(array $values)
  292.     {
  293.         foreach ($values as $domain => $keys) {
  294.             foreach ($keys as $key => $value) {
  295.                 $this->setMetadata($key, $value, $domain);
  296.             }
  297.         }
  298.     }
  300.     private function addCatalogueMetadata(array $values)
  301.     {
  302.         foreach ($values as $domain => $keys) {
  303.             foreach ($keys as $key => $value) {
  304.                 $this->setCatalogueMetadata($key, $value, $domain);
  305.             }
  306.         }
  307.     }
  308. }