MessageCatalogueInterface
interface MessageCatalogueInterface
MessageCatalogueInterface.
Methods
Gets the catalogue locale.
Gets the domains.
Gets the messages within a given domain.
Sets a message translation.
Checks if a message has a translation.
Checks if a message has a translation (it does not take into account the fallback mechanism).
Gets a message translation.
Sets translations for a given domain.
Adds translations for a given domain.
Merges translations from the given Catalogue into the current one.
Merges translations from the given Catalogue into the current one only when the translation does not exist.
Gets the fallback catalogue.
Returns an array of resources loaded to build this collection.
Details
at line line 28
string
getLocale()
Gets the catalogue locale.
at line line 35
array
getDomains()
Gets the domains.
at line line 46
array
all(string $domain = null)
Gets the messages within a given domain.
If $domain is null, it returns all messages.
at line line 55
set(string $id, string $translation, string $domain = 'messages')
Sets a message translation.
at line line 65
bool
has(string $id, string $domain = 'messages')
Checks if a message has a translation.
at line line 75
bool
defines(string $id, string $domain = 'messages')
Checks if a message has a translation (it does not take into account the fallback mechanism).
at line line 85
string
get(string $id, string $domain = 'messages')
Gets a message translation.
at line line 93
replace(array $messages, string $domain = 'messages')
Sets translations for a given domain.
at line line 101
add(array $messages, string $domain = 'messages')
Adds translations for a given domain.
at line line 110
addCatalogue(MessageCatalogueInterface $catalogue)
Merges translations from the given Catalogue into the current one.
The two catalogues must have the same locale.
at line line 120
addFallbackCatalogue(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.
at line line 127
MessageCatalogueInterface|null
getFallbackCatalogue()
Gets the fallback catalogue.
at line line 134
ResourceInterface[]
getResources()
Returns an array of resources loaded to build this collection.
at line line 141
addResource(ResourceInterface $resource)
Adds a resource for this collection.