Classes List

Symfony\Component\Translation\MessageCatalogueInterface

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
 133 
 134 
 135 
 136 
 137 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\Translation;

use Symfony\Component\Config\Resource\ResourceInterface;

/** * MessageCatalogueInterface. * * @author Fabien Potencier <fabien@symfony.com> */
interface MessageCatalogueInterface
{
    /** * Gets the catalogue locale. * * @return string The locale */
    public function getLocale();

    /** * Gets the domains. * * @return array An array of domains */
    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 */
    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 */
    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 */
    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 */
    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 */
    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 */
    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 */
    public function add($messages$domain = 'messages');

    /** * Merges translations from the given Catalogue into the current one. * * The two catalogues must have the same locale. */
    public function addCatalogue(self $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. */
    public function addFallbackCatalogue(self $catalogue);

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

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

    /** * Adds a resource for this collection. */
    public function addResource(ResourceInterface $resource);
}