You are here

interface MessageCatalogueInterface in Plug 7

MessageCatalogueInterface.

@author Fabien Potencier <fabien@symfony.com>

@api

Hierarchy

Expanded class hierarchy of MessageCatalogueInterface

All classes that implement MessageCatalogueInterface

5 files declare their use of MessageCatalogueInterface
AbstractOperation.php in lib/Symfony/translation/Catalogue/AbstractOperation.php
AbstractOperationTest.php in lib/Symfony/translation/Tests/Catalogue/AbstractOperationTest.php
DiffOperationTest.php in lib/Symfony/translation/Tests/Catalogue/DiffOperationTest.php
MergeOperationTest.php in lib/Symfony/translation/Tests/Catalogue/MergeOperationTest.php
OperationInterface.php in lib/Symfony/translation/Catalogue/OperationInterface.php

File

lib/Symfony/translation/MessageCatalogueInterface.php, line 23

Namespace

Symfony\Component\Translation
View source
interface MessageCatalogueInterface {

  /**
   * Gets the catalogue locale.
   *
   * @return string The locale
   *
   * @api
   */
  public function getLocale();

  /**
   * Gets the domains.
   *
   * @return array An array of domains
   *
   * @api
   */
  public function getDomains();

  /**
   * Gets the messages within a given domain.
   *
   * If $domain is null, it returns all messages.
   *
   * @param string $domain The domain name
   *
   * @return array An array of messages
   *
   * @api
   */
  public function all($domain = null);

  /**
   * Sets a message translation.
   *
   * @param string $id          The message id
   * @param string $translation The messages translation
   * @param string $domain      The domain name
   *
   * @api
   */
  public function set($id, $translation, $domain = 'messages');

  /**
   * Checks if a message has a translation.
   *
   * @param string $id     The message id
   * @param string $domain The domain name
   *
   * @return bool true if the message has a translation, false otherwise
   *
   * @api
   */
  public function has($id, $domain = 'messages');

  /**
   * Checks if a message has a translation (it does not take into account the fallback mechanism).
   *
   * @param string $id     The message id
   * @param string $domain The domain name
   *
   * @return bool true if the message has a translation, false otherwise
   *
   * @api
   */
  public function defines($id, $domain = 'messages');

  /**
   * Gets a message translation.
   *
   * @param string $id     The message id
   * @param string $domain The domain name
   *
   * @return string The message translation
   *
   * @api
   */
  public function get($id, $domain = 'messages');

  /**
   * Sets translations for a given domain.
   *
   * @param array  $messages An array of translations
   * @param string $domain   The domain name
   *
   * @api
   */
  public function replace($messages, $domain = 'messages');

  /**
   * Adds translations for a given domain.
   *
   * @param array  $messages An array of translations
   * @param string $domain   The domain name
   *
   * @api
   */
  public function add($messages, $domain = 'messages');

  /**
   * Merges translations from the given Catalogue into the current one.
   *
   * The two catalogues must have the same locale.
   *
   * @param MessageCatalogueInterface $catalogue A MessageCatalogueInterface instance
   *
   * @api
   */
  public function addCatalogue(MessageCatalogueInterface $catalogue);

  /**
   * Merges translations from the given Catalogue into the current one
   * only when the translation does not exist.
   *
   * This is used to provide default translations when they do not exist for the current locale.
   *
   * @param MessageCatalogueInterface $catalogue A MessageCatalogueInterface instance
   *
   * @api
   */
  public function addFallbackCatalogue(MessageCatalogueInterface $catalogue);

  /**
   * Gets the fallback catalogue.
   *
   * @return MessageCatalogueInterface|null A MessageCatalogueInterface instance or null when no fallback has been set
   *
   * @api
   */
  public function getFallbackCatalogue();

  /**
   * Returns an array of resources loaded to build this collection.
   *
   * @return ResourceInterface[] An array of resources
   *
   * @api
   */
  public function getResources();

  /**
   * Adds a resource for this collection.
   *
   * @param ResourceInterface $resource A resource instance
   *
   * @api
   */
  public function addResource(ResourceInterface $resource);

}

Members

Namesort descending Modifiers Type Description Overrides
MessageCatalogueInterface::add public function Adds translations for a given domain. 1
MessageCatalogueInterface::addCatalogue public function Merges translations from the given Catalogue into the current one. 1
MessageCatalogueInterface::addFallbackCatalogue public function Merges translations from the given Catalogue into the current one only when the translation does not exist. 1
MessageCatalogueInterface::addResource public function Adds a resource for this collection. 1
MessageCatalogueInterface::all public function Gets the messages within a given domain. 1
MessageCatalogueInterface::defines public function Checks if a message has a translation (it does not take into account the fallback mechanism). 1
MessageCatalogueInterface::get public function Gets a message translation. 1
MessageCatalogueInterface::getDomains public function Gets the domains. 1
MessageCatalogueInterface::getFallbackCatalogue public function Gets the fallback catalogue. 1
MessageCatalogueInterface::getLocale public function Gets the catalogue locale. 1
MessageCatalogueInterface::getResources public function Returns an array of resources loaded to build this collection. 1
MessageCatalogueInterface::has public function Checks if a message has a translation. 1
MessageCatalogueInterface::replace public function Sets translations for a given domain. 1
MessageCatalogueInterface::set public function Sets a message translation. 1