AggregateMessageGroup Class Reference

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

Inheritance diagram for AggregateMessageGroup:

Public Member Functions
	exists ()
	@inheritDoc
	load ( $code)
	@inheritDoc
	getMangler ()
	@inheritDoc
	getGroups ()
	Returns a list of message groups that this group consists of.
	initCollection ( $code)
	@inheritDoc
	getMessage ( $key, $code)
	@inheritDoc
	getTags ( $type=null)
	@inheritDoc
	getKeys ()
	@inheritDoc
Public Member Functions inherited from MessageGroupBase
	getConfiguration ()
	getId ()
	Returns the unique identifier for this group.
	getLabel (IContextSource $context=null)
	Returns the human readable label (as plain text).
	getDescription (IContextSource $context=null)
	Returns a longer description about the group.
	getIcon ()
	Returns an icon for this message group if any.
	getNamespace ()
	Returns the namespace where messages are placed.
	isMeta ()
	getSourceLanguage ()
	Returns language code depicting the language of source text.
	getDefinitions ()
	Shortcut for load( getSourceLanguage() ).
	getValidator ()
	Returns a message validator object or null.
	getInsertablesSuggester ()
	Returns the configured InsertablesSuggester if any.
	getMessageGroupStates ()
	Get the message group workflow state configuration.
	getTranslatableLanguages ()
	@inheritDoc
	getSupportConfig ()
	Gets support URL defined for the group if any.

Protected Member Functions
	loadMessagesFromCache ( $groups)
Protected Member Functions inherited from MessageGroupBase
	getFromConf ( $section, $key=null)
	parseTags ( $patterns)
	getRawTags ( $type=null)
	setTags (MessageCollection $collection)
	parseNamespace ()
	isSourceLanguage ( $code)

Additional Inherited Members
Static Public Member Functions inherited from MessageGroupBase
static	factory ( $conf)
Protected Attributes inherited from MessageGroupBase
	$conf
	$namespace
	$mangler

Detailed Description

Groups multiple message groups together as one group.

Limitations:

• Only groups in the same namespace.
• Only groups with the same source language.

Definition at line 24 of file AggregateMessageGroup.php.

Member Function Documentation

exists()

AggregateMessageGroup::exists

(

)

@inheritDoc

Implements MessageGroup.

Definition at line 29 of file AggregateMessageGroup.php.

getGroups()

AggregateMessageGroup::getGroups

(

)

Returns a list of message groups that this group consists of.

Returns

MessageGroup[]

Definition at line 58 of file AggregateMessageGroup.php.

getKeys()

AggregateMessageGroup::getKeys

(

)

@inheritDoc

Reimplemented from MessageGroupBase.

Definition at line 170 of file AggregateMessageGroup.php.

getMangler()

AggregateMessageGroup::getMangler

(

)

@inheritDoc

Reimplemented from MessageGroupBase.

Definition at line 46 of file AggregateMessageGroup.php.

getMessage()

AggregateMessageGroup::getMessage	(		$key,
			$code )

@inheritDoc

Implements MessageGroup.

Definition at line 127 of file AggregateMessageGroup.php.

getTags()

AggregateMessageGroup::getTags

(

$type = null

)

@inheritDoc

Reimplemented from MessageGroupBase.

Definition at line 159 of file AggregateMessageGroup.php.

initCollection()

AggregateMessageGroup::initCollection

(

$code

)

@inheritDoc

Implements MessageGroup.

Definition at line 115 of file AggregateMessageGroup.php.

load()

AggregateMessageGroup::load

(

$code

)

@inheritDoc

Implements MessageGroup.

Definition at line 35 of file AggregateMessageGroup.php.

loadMessagesFromCache()

AggregateMessageGroup::loadMessagesFromCache ( $groups )

protected

Definition at line 89 of file AggregateMessageGroup.php.

---

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

• messagegroups/AggregateMessageGroup.php