Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of the Symfony package.
Chris@0:  *
Chris@0:  * (c) Fabien Potencier <fabien@symfony.com>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Symfony\Component\Translation;
Chris@0: 
Chris@0: use Symfony\Component\Config\Resource\ResourceInterface;
Chris@0: use Symfony\Component\Translation\Exception\LogicException;
Chris@0: 
Chris@0: /**
Chris@0:  * @author Fabien Potencier <fabien@symfony.com>
Chris@0:  */
Chris@0: class MessageCatalogue implements MessageCatalogueInterface, MetadataAwareInterface
Chris@0: {
Chris@17:     private $messages = [];
Chris@17:     private $metadata = [];
Chris@17:     private $resources = [];
Chris@0:     private $locale;
Chris@0:     private $fallbackCatalogue;
Chris@0:     private $parent;
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string $locale   The locale
Chris@0:      * @param array  $messages An array of messages classified by domain
Chris@0:      */
Chris@17:     public function __construct($locale, array $messages = [])
Chris@0:     {
Chris@0:         $this->locale = $locale;
Chris@0:         $this->messages = $messages;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function getLocale()
Chris@0:     {
Chris@0:         return $this->locale;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function getDomains()
Chris@0:     {
Chris@0:         return array_keys($this->messages);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function all($domain = null)
Chris@0:     {
Chris@0:         if (null === $domain) {
Chris@0:             return $this->messages;
Chris@0:         }
Chris@0: 
Chris@17:         return isset($this->messages[$domain]) ? $this->messages[$domain] : [];
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function set($id, $translation, $domain = 'messages')
Chris@0:     {
Chris@17:         $this->add([$id => $translation], $domain);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function has($id, $domain = 'messages')
Chris@0:     {
Chris@0:         if (isset($this->messages[$domain][$id])) {
Chris@0:             return true;
Chris@0:         }
Chris@0: 
Chris@0:         if (null !== $this->fallbackCatalogue) {
Chris@0:             return $this->fallbackCatalogue->has($id, $domain);
Chris@0:         }
Chris@0: 
Chris@0:         return false;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function defines($id, $domain = 'messages')
Chris@0:     {
Chris@0:         return isset($this->messages[$domain][$id]);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function get($id, $domain = 'messages')
Chris@0:     {
Chris@0:         if (isset($this->messages[$domain][$id])) {
Chris@0:             return $this->messages[$domain][$id];
Chris@0:         }
Chris@0: 
Chris@0:         if (null !== $this->fallbackCatalogue) {
Chris@0:             return $this->fallbackCatalogue->get($id, $domain);
Chris@0:         }
Chris@0: 
Chris@0:         return $id;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function replace($messages, $domain = 'messages')
Chris@0:     {
Chris@17:         $this->messages[$domain] = [];
Chris@0: 
Chris@0:         $this->add($messages, $domain);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function add($messages, $domain = 'messages')
Chris@0:     {
Chris@0:         if (!isset($this->messages[$domain])) {
Chris@0:             $this->messages[$domain] = $messages;
Chris@0:         } else {
Chris@0:             $this->messages[$domain] = array_replace($this->messages[$domain], $messages);
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function addCatalogue(MessageCatalogueInterface $catalogue)
Chris@0:     {
Chris@0:         if ($catalogue->getLocale() !== $this->locale) {
Chris@0:             throw new LogicException(sprintf('Cannot add a catalogue for locale "%s" as the current locale for this catalogue is "%s"', $catalogue->getLocale(), $this->locale));
Chris@0:         }
Chris@0: 
Chris@0:         foreach ($catalogue->all() as $domain => $messages) {
Chris@0:             $this->add($messages, $domain);
Chris@0:         }
Chris@0: 
Chris@0:         foreach ($catalogue->getResources() as $resource) {
Chris@0:             $this->addResource($resource);
Chris@0:         }
Chris@0: 
Chris@0:         if ($catalogue instanceof MetadataAwareInterface) {
Chris@0:             $metadata = $catalogue->getMetadata('', '');
Chris@0:             $this->addMetadata($metadata);
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function addFallbackCatalogue(MessageCatalogueInterface $catalogue)
Chris@0:     {
Chris@0:         // detect circular references
Chris@0:         $c = $catalogue;
Chris@0:         while ($c = $c->getFallbackCatalogue()) {
Chris@0:             if ($c->getLocale() === $this->getLocale()) {
Chris@0:                 throw new LogicException(sprintf('Circular reference detected when adding a fallback catalogue for locale "%s".', $catalogue->getLocale()));
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         $c = $this;
Chris@0:         do {
Chris@0:             if ($c->getLocale() === $catalogue->getLocale()) {
Chris@0:                 throw new LogicException(sprintf('Circular reference detected when adding a fallback catalogue for locale "%s".', $catalogue->getLocale()));
Chris@0:             }
Chris@0: 
Chris@0:             foreach ($catalogue->getResources() as $resource) {
Chris@0:                 $c->addResource($resource);
Chris@0:             }
Chris@0:         } while ($c = $c->parent);
Chris@0: 
Chris@0:         $catalogue->parent = $this;
Chris@0:         $this->fallbackCatalogue = $catalogue;
Chris@0: 
Chris@0:         foreach ($catalogue->getResources() as $resource) {
Chris@0:             $this->addResource($resource);
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function getFallbackCatalogue()
Chris@0:     {
Chris@0:         return $this->fallbackCatalogue;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function getResources()
Chris@0:     {
Chris@0:         return array_values($this->resources);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function addResource(ResourceInterface $resource)
Chris@0:     {
Chris@0:         $this->resources[$resource->__toString()] = $resource;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function getMetadata($key = '', $domain = 'messages')
Chris@0:     {
Chris@0:         if ('' == $domain) {
Chris@0:             return $this->metadata;
Chris@0:         }
Chris@0: 
Chris@0:         if (isset($this->metadata[$domain])) {
Chris@0:             if ('' == $key) {
Chris@0:                 return $this->metadata[$domain];
Chris@0:             }
Chris@0: 
Chris@0:             if (isset($this->metadata[$domain][$key])) {
Chris@0:                 return $this->metadata[$domain][$key];
Chris@0:             }
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function setMetadata($key, $value, $domain = 'messages')
Chris@0:     {
Chris@0:         $this->metadata[$domain][$key] = $value;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function deleteMetadata($key = '', $domain = 'messages')
Chris@0:     {
Chris@0:         if ('' == $domain) {
Chris@17:             $this->metadata = [];
Chris@0:         } elseif ('' == $key) {
Chris@0:             unset($this->metadata[$domain]);
Chris@0:         } else {
Chris@0:             unset($this->metadata[$domain][$key]);
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Adds current values with the new values.
Chris@0:      *
Chris@0:      * @param array $values Values to add
Chris@0:      */
Chris@0:     private function addMetadata(array $values)
Chris@0:     {
Chris@0:         foreach ($values as $domain => $keys) {
Chris@0:             foreach ($keys as $key => $value) {
Chris@0:                 $this->setMetadata($key, $value, $domain);
Chris@0:             }
Chris@0:         }
Chris@0:     }
Chris@0: }