Catalogue
2 years ago
Command
2 years ago
DataCollector
2 years ago
DependencyInjection
2 years ago
Dumper
2 years ago
Exception
2 years ago
Extractor
2 years ago
Formatter
2 years ago
Loader
2 years ago
Provider
2 years ago
Reader
2 years ago
Resources
2 years ago
Test
2 years ago
Util
2 years ago
Writer
2 years ago
DataCollectorTranslator.php
2 years ago
IdentityTranslator.php
2 years ago
LoggingTranslator.php
2 years ago
MessageCatalogue.php
2 years ago
MessageCatalogueInterface.php
2 years ago
MetadataAwareInterface.php
2 years ago
PseudoLocalizationTranslator.php
2 years ago
TranslatableMessage.php
2 years ago
Translator.php
2 years ago
TranslatorBag.php
2 years ago
TranslatorBagInterface.php
2 years ago
MessageCatalogueInterface.php
124 lines
| 1 | <?php |
| 2 | |
| 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 | */ |
| 11 | namespace IAWPSCOPED\Symfony\Component\Translation; |
| 12 | |
| 13 | use IAWPSCOPED\Symfony\Component\Config\Resource\ResourceInterface; |
| 14 | /** |
| 15 | * MessageCatalogueInterface. |
| 16 | * |
| 17 | * @author Fabien Potencier <fabien@symfony.com> |
| 18 | * @internal |
| 19 | */ |
| 20 | interface MessageCatalogueInterface |
| 21 | { |
| 22 | public const INTL_DOMAIN_SUFFIX = '+intl-icu'; |
| 23 | /** |
| 24 | * Gets the catalogue locale. |
| 25 | * |
| 26 | * @return string |
| 27 | */ |
| 28 | public function getLocale(); |
| 29 | /** |
| 30 | * Gets the domains. |
| 31 | * |
| 32 | * @return array |
| 33 | */ |
| 34 | public function getDomains(); |
| 35 | /** |
| 36 | * Gets the messages within a given domain. |
| 37 | * |
| 38 | * If $domain is null, it returns all messages. |
| 39 | * |
| 40 | * @param string|null $domain The domain name |
| 41 | * |
| 42 | * @return array |
| 43 | */ |
| 44 | public function all(?string $domain = null); |
| 45 | /** |
| 46 | * Sets a message translation. |
| 47 | * |
| 48 | * @param string $id The message id |
| 49 | * @param string $translation The messages translation |
| 50 | * @param string $domain The domain name |
| 51 | */ |
| 52 | public function set(string $id, string $translation, string $domain = 'messages'); |
| 53 | /** |
| 54 | * Checks if a message has a translation. |
| 55 | * |
| 56 | * @param string $id The message id |
| 57 | * @param string $domain The domain name |
| 58 | * |
| 59 | * @return bool |
| 60 | */ |
| 61 | public function has(string $id, string $domain = 'messages'); |
| 62 | /** |
| 63 | * Checks if a message has a translation (it does not take into account the fallback mechanism). |
| 64 | * |
| 65 | * @param string $id The message id |
| 66 | * @param string $domain The domain name |
| 67 | * |
| 68 | * @return bool |
| 69 | */ |
| 70 | public function defines(string $id, string $domain = 'messages'); |
| 71 | /** |
| 72 | * Gets a message translation. |
| 73 | * |
| 74 | * @param string $id The message id |
| 75 | * @param string $domain The domain name |
| 76 | * |
| 77 | * @return string |
| 78 | */ |
| 79 | public function get(string $id, string $domain = 'messages'); |
| 80 | /** |
| 81 | * Sets translations for a given domain. |
| 82 | * |
| 83 | * @param array $messages An array of translations |
| 84 | * @param string $domain The domain name |
| 85 | */ |
| 86 | public function replace(array $messages, string $domain = 'messages'); |
| 87 | /** |
| 88 | * Adds translations for a given domain. |
| 89 | * |
| 90 | * @param array $messages An array of translations |
| 91 | * @param string $domain The domain name |
| 92 | */ |
| 93 | public function add(array $messages, string $domain = 'messages'); |
| 94 | /** |
| 95 | * Merges translations from the given Catalogue into the current one. |
| 96 | * |
| 97 | * The two catalogues must have the same locale. |
| 98 | */ |
| 99 | public function addCatalogue(self $catalogue); |
| 100 | /** |
| 101 | * Merges translations from the given Catalogue into the current one |
| 102 | * only when the translation does not exist. |
| 103 | * |
| 104 | * This is used to provide default translations when they do not exist for the current locale. |
| 105 | */ |
| 106 | public function addFallbackCatalogue(self $catalogue); |
| 107 | /** |
| 108 | * Gets the fallback catalogue. |
| 109 | * |
| 110 | * @return self|null |
| 111 | */ |
| 112 | public function getFallbackCatalogue(); |
| 113 | /** |
| 114 | * Returns an array of resources loaded to build this collection. |
| 115 | * |
| 116 | * @return ResourceInterface[] |
| 117 | */ |
| 118 | public function getResources(); |
| 119 | /** |
| 120 | * Adds a resource for this collection. |
| 121 | */ |
| 122 | public function addResource(ResourceInterface $resource); |
| 123 | } |
| 124 |