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
	getSourceLanguage ()
	@inheritDoc
Public Member Functions inherited from MessageGroupBase
	getConfiguration ()
	getId ()
	@inheritDoc
	getLabel (?IContextSource $context=null)
	@inheritDoc
	getDescription (?IContextSource $context=null)
	@inheritDoc
	getIcon ()
	@inheritDoc
	getNamespace ()
	@inheritDoc
	isMeta ()
	@inheritDoc
	getDefinitions ()
	@inheritDoc
	getValidator ()
	@inheritDoc
	getInsertablesSuggester ()
	Returns the configured InsertablesSuggester if any.
	getMessageGroupStates ()
	@inheritDoc
	getTranslatableLanguages ()
	@inheritDoc
	getSupportConfig ()
	@inheritDoc
	getRelatedPage ()
	@inheritDoc

Public Attributes
const	UNDETERMINED_LANGUAGE_CODE = 'und'
Public Attributes inherited from MessageGroup
const	DEFAULT_LANGUAGES = null
	Return value from getTranslatableLanguages when to use defaults.

Protected Member Functions
	loadMessagesFromCache (array $groups)
Protected Member Functions inherited from MessageGroupBase
	parseTags (array $patterns)
	getRawTags (?string $type=null)
	setTags (MessageCollection $collection)
	parseNamespace ()
	isSourceLanguage (string $code)

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

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 30 of file AggregateMessageGroup.php.

getGroups()

AggregateMessageGroup::getGroups

(

)

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

Returns

MessageGroup[]

Definition at line 59 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 47 of file AggregateMessageGroup.php.

getMessage()

AggregateMessageGroup::getMessage	(		$key,
			$code )

@inheritDoc

Implements MessageGroup.

Definition at line 127 of file AggregateMessageGroup.php.

getSourceLanguage()

AggregateMessageGroup::getSourceLanguage

(

)

@inheritDoc

Implements MessageGroup.

Definition at line 184 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 36 of file AggregateMessageGroup.php.

loadMessagesFromCache()

AggregateMessageGroup::loadMessagesFromCache ( array $groups )

protected

Definition at line 90 of file AggregateMessageGroup.php.

Member Data Documentation

UNDETERMINED_LANGUAGE_CODE

const AggregateMessageGroup::UNDETERMINED_LANGUAGE_CODE = 'und'

Definition at line 25 of file AggregateMessageGroup.php.

---

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

• messagegroups/AggregateMessageGroup.php