AggregateMessageGroup Class Reference
[Message group]

Groups multiple message groups together as one big group. More...

Inheritance diagram for AggregateMessageGroup:

[legend]

Collaboration diagram for AggregateMessageGroup:

[legend]

List of all members.

Public Member Functions
	exists ()
	If this function returns false, the message group is ignored and treated like it would not be configured at all.
	getMangler ()
	Return a message mangler or null.
	getGroups ()
	initCollection ($code)
	Initialises a message collection with the given language code, message definitions and message tags.
	getMessage ($key, $code)
	Returns the definition or translation for given message key in given language code.
Protected Member Functions
	loadMessagesFromCache ($groups)

---

Detailed Description

Groups multiple message groups together as one big group.

Limitations:

• Only groups in the same namespace.

Definition at line 18 of file AggregateMessageGroup.php.

---

Member Function Documentation

AggregateMessageGroup::exists

(

)

If this function returns false, the message group is ignored and treated like it would not be configured at all.

Useful for graceful degradation. Try to keep the check fast to avoid performance problems.

Returns:

bool

Implements MessageGroup.

Definition at line 19 of file AggregateMessageGroup.php.

AggregateMessageGroup::getGroups

(

)

Definition at line 47 of file AggregateMessageGroup.php.

Referenced by initCollection(), and MessageGroups::subGroups().

Here is the call graph for this function:

AggregateMessageGroup::getMangler

(

)

Return a message mangler or null.

Todo:

Make an interface for message manglers

Returns:

StringMatcher or null

Reimplemented from MessageGroupBase.

Definition at line 39 of file AggregateMessageGroup.php.

AggregateMessageGroup::getMessage	(	$	key,
		$	code
	)

Returns the definition or translation for given message key in given language code.

Parameters:

	$key	string
	$code	string

Returns:

string|null

Reimplemented from MessageGroupBase.

Definition at line 113 of file AggregateMessageGroup.php.

Here is the call graph for this function:

AggregateMessageGroup::initCollection

(

$

code

)

Initialises a message collection with the given language code, message definitions and message tags.

Parameters:

$code

Returns:

MessageCollection

Reimplemented from MessageGroupBase.

Definition at line 102 of file AggregateMessageGroup.php.

Here is the call graph for this function:

AggregateMessageGroup::loadMessagesFromCache

(

$

groups

)

[protected]

Definition at line 78 of file AggregateMessageGroup.php.

Referenced by initCollection().

---

The documentation for this class was generated from the following file:

• Translate/messagegroups/AggregateMessageGroup.php