interface MessageCatalogueInterface

MessageCatalogueInterface.

Methods

string
getLocale()

Gets the catalogue locale.

array
getDomains()

Gets the domains.

array
all(string $domain = null)

Gets the messages within a given domain.

set(string $id, string $translation, string $domain = 'messages')

Sets a message translation.

bool
has(string $id, string $domain = 'messages')

Checks if a message has a translation.

bool
defines(string $id, string $domain = 'messages')

Checks if a message has a translation (it does not take into account the fallback mechanism).

string
get(string $id, string $domain = 'messages')

Gets a message translation.

replace(array $messages, string $domain = 'messages')

Sets translations for a given domain.

add(array $messages, string $domain = 'messages')

Adds translations for a given domain.

addCatalogue(MessageCatalogueInterface $catalogue)

Merges translations from the given Catalogue into the current one.

addFallbackCatalogue(MessageCatalogueInterface $catalogue)

Merges translations from the given Catalogue into the current one only when the translation does not exist.

getFallbackCatalogue()

Gets the fallback catalogue.

getResources()

Returns an array of resources loaded to build this collection.

addResource(ResourceInterface $resource)

Adds a resource for this collection.

Details

at line line 28
string getLocale()

Gets the catalogue locale.

Return Value

string The locale

at line line 35
array getDomains()

Gets the domains.

Return Value

array An array of 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.

Parameters

string $domain The domain name

Return Value

array An array of messages

at line line 55
set(string $id, string $translation, string $domain = 'messages')

Sets a message translation.

Parameters

string $id The message id
string $translation The messages translation
string $domain The domain name

at line line 65
bool has(string $id, string $domain = 'messages')

Checks if a message has a translation.

Parameters

string $id The message id
string $domain The domain name

Return Value

bool true if the message has a translation, false otherwise

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).

Parameters

string $id The message id
string $domain The domain name

Return Value

bool true if the message has a translation, false otherwise

at line line 85
string get(string $id, string $domain = 'messages')

Gets a message translation.

Parameters

string $id The message id
string $domain The domain name

Return Value

string The message translation

at line line 93
replace(array $messages, string $domain = 'messages')

Sets translations for a given domain.

Parameters

array $messages An array of translations
string $domain The domain name

at line line 101
add(array $messages, string $domain = 'messages')

Adds translations for a given domain.

Parameters

array $messages An array of translations
string $domain The domain name

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.

Parameters

MessageCatalogueInterface $catalogue

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.

Parameters

MessageCatalogueInterface $catalogue

at line line 127
MessageCatalogueInterface|null getFallbackCatalogue()

Gets the fallback catalogue.

Return Value

MessageCatalogueInterface|null A MessageCatalogueInterface instance or null when no fallback has been set

at line line 134
ResourceInterface[] getResources()

Returns an array of resources loaded to build this collection.

Return Value

ResourceInterface[] An array of resources

at line line 141
addResource(ResourceInterface $resource)

Adds a resource for this collection.

Parameters

ResourceInterface $resource A resource instance