class MessageCatalogue in Zircon Profile 8

MessageCatalogue.

@author Fabien Potencier <[e-mail]>

Hierarchy

• class \Symfony\Component\Translation\MessageCatalogue implements MessageCatalogueInterface, MetadataAwareInterface

39 files declare their use of MessageCatalogue

AbstractOperation.php in vendor/symfony/translation/Catalogue/AbstractOperation.php

AbstractOperationTest.php in vendor/symfony/translation/Tests/Catalogue/AbstractOperationTest.php

ArrayLoader.php in vendor/symfony/translation/Loader/ArrayLoader.php

ChainExtractor.php in vendor/symfony/translation/Extractor/ChainExtractor.php

CsvFileDumper.php in vendor/symfony/translation/Dumper/CsvFileDumper.php

... See full list

File

vendor/symfony/translation/MessageCatalogue.php, line 21

Namespace

Symfony\Component\Translation

class MessageCatalogue implements MessageCatalogueInterface, MetadataAwareInterface {
  private $messages = array();
  private $metadata = array();
  private $resources = array();
  private $locale;
  private $fallbackCatalogue;
  private $parent;

  /**
   * Constructor.
   *
   * @param string $locale   The locale
   * @param array  $messages An array of messages classified by domain
   */
  public function __construct($locale, array $messages = array()) {
    $this->locale = $locale;
    $this->messages = $messages;
  }

  /**
   * {@inheritdoc}
   */
  public function getLocale() {
    return $this->locale;
  }

  /**
   * {@inheritdoc}
   */
  public function getDomains() {
    return array_keys($this->messages);
  }

  /**
   * {@inheritdoc}
   */
  public function all($domain = null) {
    if (null === $domain) {
      return $this->messages;
    }
    return isset($this->messages[$domain]) ? $this->messages[$domain] : array();
  }

  /**
   * {@inheritdoc}
   */
  public function set($id, $translation, $domain = 'messages') {
    $this
      ->add(array(
      $id => $translation,
    ), $domain);
  }

  /**
   * {@inheritdoc}
   */
  public function has($id, $domain = 'messages') {
    if (isset($this->messages[$domain][$id])) {
      return true;
    }
    if (null !== $this->fallbackCatalogue) {
      return $this->fallbackCatalogue
        ->has($id, $domain);
    }
    return false;
  }

  /**
   * {@inheritdoc}
   */
  public function defines($id, $domain = 'messages') {
    return isset($this->messages[$domain][$id]);
  }

  /**
   * {@inheritdoc}
   */
  public function get($id, $domain = 'messages') {
    if (isset($this->messages[$domain][$id])) {
      return $this->messages[$domain][$id];
    }
    if (null !== $this->fallbackCatalogue) {
      return $this->fallbackCatalogue
        ->get($id, $domain);
    }
    return $id;
  }

  /**
   * {@inheritdoc}
   */
  public function replace($messages, $domain = 'messages') {
    $this->messages[$domain] = array();
    $this
      ->add($messages, $domain);
  }

  /**
   * {@inheritdoc}
   */
  public function add($messages, $domain = 'messages') {
    if (!isset($this->messages[$domain])) {
      $this->messages[$domain] = $messages;
    }
    else {
      $this->messages[$domain] = array_replace($this->messages[$domain], $messages);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function addCatalogue(MessageCatalogueInterface $catalogue) {
    if ($catalogue
      ->getLocale() !== $this->locale) {
      throw new \LogicException(sprintf('Cannot add a catalogue for locale "%s" as the current locale for this catalogue is "%s"', $catalogue
        ->getLocale(), $this->locale));
    }
    foreach ($catalogue
      ->all() as $domain => $messages) {
      $this
        ->add($messages, $domain);
    }
    foreach ($catalogue
      ->getResources() as $resource) {
      $this
        ->addResource($resource);
    }
    if ($catalogue instanceof MetadataAwareInterface) {
      $metadata = $catalogue
        ->getMetadata('', '');
      $this
        ->addMetadata($metadata);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function addFallbackCatalogue(MessageCatalogueInterface $catalogue) {

    // detect circular references
    $c = $catalogue;
    while ($c = $c
      ->getFallbackCatalogue()) {
      if ($c
        ->getLocale() === $this
        ->getLocale()) {
        throw new \LogicException(sprintf('Circular reference detected when adding a fallback catalogue for locale "%s".', $catalogue
          ->getLocale()));
      }
    }
    $c = $this;
    do {
      if ($c
        ->getLocale() === $catalogue
        ->getLocale()) {
        throw new \LogicException(sprintf('Circular reference detected when adding a fallback catalogue for locale "%s".', $catalogue
          ->getLocale()));
      }
    } while ($c = $c->parent);
    $catalogue->parent = $this;
    $this->fallbackCatalogue = $catalogue;
    foreach ($catalogue
      ->getResources() as $resource) {
      $this
        ->addResource($resource);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getFallbackCatalogue() {
    return $this->fallbackCatalogue;
  }

  /**
   * {@inheritdoc}
   */
  public function getResources() {
    return array_values($this->resources);
  }

  /**
   * {@inheritdoc}
   */
  public function addResource(ResourceInterface $resource) {
    $this->resources[$resource
      ->__toString()] = $resource;
  }

  /**
   * {@inheritdoc}
   */
  public function getMetadata($key = '', $domain = 'messages') {
    if ('' == $domain) {
      return $this->metadata;
    }
    if (isset($this->metadata[$domain])) {
      if ('' == $key) {
        return $this->metadata[$domain];
      }
      if (isset($this->metadata[$domain][$key])) {
        return $this->metadata[$domain][$key];
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function setMetadata($key, $value, $domain = 'messages') {
    $this->metadata[$domain][$key] = $value;
  }

  /**
   * {@inheritdoc}
   */
  public function deleteMetadata($key = '', $domain = 'messages') {
    if ('' == $domain) {
      $this->metadata = array();
    }
    elseif ('' == $key) {
      unset($this->metadata[$domain]);
    }
    else {
      unset($this->metadata[$domain][$key]);
    }
  }

  /**
   * Adds current values with the new values.
   *
   * @param array $values Values to add
   */
  private function addMetadata(array $values) {
    foreach ($values as $domain => $keys) {
      foreach ($keys as $key => $value) {
        $this
          ->setMetadata($key, $value, $domain);
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MessageCatalogue::$fallbackCatalogue	private	property
MessageCatalogue::$locale	private	property
MessageCatalogue::$messages	private	property
MessageCatalogue::$metadata	private	property
MessageCatalogue::$parent	private	property
MessageCatalogue::$resources	private	property
MessageCatalogue::add	public	function	Adds translations for a given domain. Overrides MessageCatalogueInterface::add
MessageCatalogue::addCatalogue	public	function	Merges translations from the given Catalogue into the current one. Overrides MessageCatalogueInterface::addCatalogue
MessageCatalogue::addFallbackCatalogue	public	function	Merges translations from the given Catalogue into the current one only when the translation does not exist. Overrides MessageCatalogueInterface::addFallbackCatalogue
MessageCatalogue::addMetadata	private	function	Adds current values with the new values.
MessageCatalogue::addResource	public	function	Adds a resource for this collection. Overrides MessageCatalogueInterface::addResource
MessageCatalogue::all	public	function	Gets the messages within a given domain. Overrides MessageCatalogueInterface::all
MessageCatalogue::defines	public	function	Checks if a message has a translation (it does not take into account the fallback mechanism). Overrides MessageCatalogueInterface::defines
MessageCatalogue::deleteMetadata	public	function	Deletes metadata for the given key and domain. Overrides MetadataAwareInterface::deleteMetadata
MessageCatalogue::get	public	function	Gets a message translation. Overrides MessageCatalogueInterface::get
MessageCatalogue::getDomains	public	function	Gets the domains. Overrides MessageCatalogueInterface::getDomains
MessageCatalogue::getFallbackCatalogue	public	function	Gets the fallback catalogue. Overrides MessageCatalogueInterface::getFallbackCatalogue
MessageCatalogue::getLocale	public	function	Gets the catalogue locale. Overrides MessageCatalogueInterface::getLocale
MessageCatalogue::getMetadata	public	function	Gets metadata for the given domain and key. Overrides MetadataAwareInterface::getMetadata
MessageCatalogue::getResources	public	function	Returns an array of resources loaded to build this collection. Overrides MessageCatalogueInterface::getResources
MessageCatalogue::has	public	function	Checks if a message has a translation. Overrides MessageCatalogueInterface::has
MessageCatalogue::replace	public	function	Sets translations for a given domain. Overrides MessageCatalogueInterface::replace
MessageCatalogue::set	public	function	Sets a message translation. Overrides MessageCatalogueInterface::set
MessageCatalogue::setMetadata	public	function	Adds metadata to a message domain. Overrides MetadataAwareInterface::setMetadata
MessageCatalogue::__construct	public	function	Constructor.