SubsetMessageGroup Class Reference

Message group that contains a subset of keys of another group. More...

Inheritance diagram for SubsetMessageGroup:

Public Member Functions
	__construct (string $id, string $label, string $parentId, array $subsetKeys)
	isMeta ()
	@inheritDoc
	exists ()
	@inheritDoc
	load ( $code)
	@inheritDoc
	getKeys ()
	@inheritDoc
	getDefinitions ()
	@inheritDoc
	getTags ( $type=null)
	@inheritDoc
	getMessage ( $key, $code)
	@inheritDoc
	getIcon ()
	Returns an icon for this message group if any.
Public Member Functions inherited from MessageGroupOld
	getLabel (IContextSource $context=null)
	setLabel ( $value)
	getId ()
	setId ( $value)
	getNamespace ()
	Get the namespace where all the messages of this group belong.
	setNamespace ( $ns)
	Set the namespace where all the messages of this group belong.
	getDescription (IContextSource $context=null)
	Returns a longer description about the group.
	setDescription ( $value)
	getSourceLanguage ()
	Returns language code depicting the language of source text.
	getMangler ()
	getUniqueDefinitions ()
	This function can be used for meta message groups to list their "own" messages.
	getMessageFile ( $code)
	Returns path to the file where translation of language code $code are.
	getPath ()
	getMessageFileWithPath ( $code)
	getSourceFilePath ( $code)
	initCollection ( $code, $unique=false)
	Creates a new MessageCollection for this group.
	getValidator ()
	Returns a message validator object or null.
	getMessageGroupStates ()
	Get the message group workflow state configuration.
	getTranslatableLanguages ()
	@inheritDoc
	getTranslationAids ()
	List of available message types mapped to the classes implementing them.
	getSupportConfig ()
	Gets support URL defined for the group if any.
Public Member Functions inherited from MessageGroup
	initCollection ( $code)
	Initialises a message collection with the given language code, message definitions and message tags.

Protected Member Functions
	getParentGroup ()
Protected Member Functions inherited from MessageGroupOld
	isSourceLanguage ( $code)

Additional Inherited Members
Static Public Member Functions inherited from MessageGroupOld
static	normaliseKeys ( $array)
Static Protected Member Functions inherited from MessageGroupOld
static	addContext (Message $message, IContextSource $context=null)
Protected Attributes inherited from MessageGroupOld
	$label = 'none'
	Human-readable name of this group.
	$id = 'none'
	Group-wide unique id of this group.
	$namespace = NS_MEDIAWIKI
	The namespace where all the messages of this group belong.
	$description = null
	Holds description of this group.
	$meta = false
	Meta groups consist of multiple groups or parts of other groups.
	$mangler = null
	To avoid key conflicts between groups or separated changed messages between branches one can set a message key mangler.
	$messages = []
	All the messages for this group, by language code.

Detailed Description

Message group that contains a subset of keys of another group.

Author

Niklas Laxström @license GPL-2.0-or-later

Definition at line 12 of file SubsetMessageGroup.php.

Constructor & Destructor Documentation

__construct()

SubsetMessageGroup::__construct	(	string	$id,
		string	$label,
		string	$parentId,
		array	$subsetKeys )

Definition at line 22 of file SubsetMessageGroup.php.

Member Function Documentation

exists()

SubsetMessageGroup::exists

(

)

@inheritDoc

Reimplemented from MessageGroupOld.

Definition at line 40 of file SubsetMessageGroup.php.

getDefinitions()

SubsetMessageGroup::getDefinitions

(

)

@inheritDoc

Reimplemented from MessageGroupOld.

Definition at line 73 of file SubsetMessageGroup.php.

getIcon()

SubsetMessageGroup::getIcon

(

)

Returns an icon for this message group if any.

Returns

string|null File reference in one of the supported protocols:

• file://Filename.ext - Accessible via MediaWiki functions

Since

2012-12-04

Reimplemented from MessageGroupOld.

Definition at line 123 of file SubsetMessageGroup.php.

getKeys()

SubsetMessageGroup::getKeys

(

)

@inheritDoc

Reimplemented from MessageGroupOld.

Definition at line 50 of file SubsetMessageGroup.php.

getMessage()

SubsetMessageGroup::getMessage	(		$key,
			$code )

@inheritDoc

Reimplemented from MessageGroupOld.

Definition at line 111 of file SubsetMessageGroup.php.

getParentGroup()

SubsetMessageGroup::getParentGroup ( )

protected

Definition at line 127 of file SubsetMessageGroup.php.

getTags()

SubsetMessageGroup::getTags

(

$type = null

)

@inheritDoc

Reimplemented from MessageGroupOld.

Definition at line 98 of file SubsetMessageGroup.php.

isMeta()

SubsetMessageGroup::isMeta

(

)

@inheritDoc

Reimplemented from MessageGroupOld.

Definition at line 35 of file SubsetMessageGroup.php.

load()

SubsetMessageGroup::load

(

$code

)

@inheritDoc

Reimplemented from MessageGroupOld.

Definition at line 45 of file SubsetMessageGroup.php.

---

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

• messagegroups/SubsetMessageGroup.php