MessageCatalogueInterface

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.
MessageCatalogueInterface\|null	getFallbackCatalogue() Gets the fallback catalogue.
ResourceInterface[]	getResources() Returns an array of resources loaded to build this collection.
	addResource(ResourceInterface $resource) Adds a resource for this collection.

Details

string getLocale()

Gets the catalogue locale.

Return Value

string

The locale

array getDomains()

Gets the domains.

Return Value

array

An array of domains

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

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

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

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

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

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

Sets translations for a given domain.

Parameters

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

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

Adds translations for a given domain.

Parameters

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

addCatalogue(MessageCatalogueInterface $catalogue)

Merges translations from the given Catalogue into the current one.

The two catalogues must have the same locale.

Parameters

MessageCatalogueInterface

$catalogue

A MessageCatalogueInterface instance

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

A MessageCatalogueInterface instance