MessageGroupBase Class Reference

This class implements some basic functions that wrap around the YAML message group configurations. More...

Inheritance diagram for MessageGroupBase:

Public Member Functions
	getConfiguration ()
	getId ()
	@inheritDoc
	getLabel (?IContextSource $context=null)
	@inheritDoc
	getDescription (?IContextSource $context=null)
	@inheritDoc
	getIcon ()
	@inheritDoc
	getNamespace ()
	@inheritDoc
	isMeta ()
	@inheritDoc
	getDefinitions ()
	@inheritDoc
	getValidator ()
	@inheritDoc
	getMangler ()
	@inheritDoc
	getInsertablesSuggester ()
	Returns the configured InsertablesSuggester if any.
	getKeys ()
	@inheritDoc
	getTags ( $type=null)
	@inheritDoc
	getMessageGroupStates ()
	@inheritDoc
	getTranslatableLanguages ()
	@inheritDoc
	getSupportConfig ()
	@inheritDoc
	getRelatedPage ()
	@inheritDoc
Public Member Functions inherited from MessageGroup
	exists ()
	If this function returns false, the message group is ignored and treated like it would not be configured at all.
	initCollection ( $code)
	Initialises a message collection with the given language code, message definitions and message tags.
	load ( $code)
	Returns a list of messages in a given language code.
	getMessage ( $key, $code)
	Returns the definition or translation for given message key in given language code.
	getSourceLanguage ()
	Returns language code depicting the language of source text.

Static Public Member Functions
static	factory (array $conf)

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

Protected Attributes
array	$conf
int	$namespace
StringMatcher	$mangler = null

Additional Inherited Members
Public Attributes inherited from MessageGroup
const	DEFAULT_LANGUAGES = null
	Return value from getTranslatableLanguages when to use defaults.

Detailed Description

This class implements some basic functions that wrap around the YAML message group configurations.

These message groups use the file format classes and are managed with Special:ManageMessageGroups and importExternalTranslations.php.

Author

Niklas Laxström

Copyright

Copyright © 2010-2013, Niklas Laxström @license GPL-2.0-or-later

See also

https://www.mediawiki.org/wiki/Help:Extension:Translate/Group_configuration

Definition at line 29 of file MessageGroupBase.php.

Constructor & Destructor Documentation

__construct()

MessageGroupBase::__construct ( )

protected

Definition at line 34 of file MessageGroupBase.php.

Member Function Documentation

factory()

static MessageGroupBase::factory ( array $conf )

static

Definition at line 37 of file MessageGroupBase.php.

getConfiguration()

MessageGroupBase::getConfiguration

(

)

Definition at line 46 of file MessageGroupBase.php.

getDefinitions()

MessageGroupBase::getDefinitions

(

)

@inheritDoc

Implements MessageGroup.

Definition at line 81 of file MessageGroupBase.php.

getDescription()

MessageGroupBase::getDescription

(

?IContextSource

$context = null

)

@inheritDoc

Implements MessageGroup.

Reimplemented in MediaWikiExtensionMessageGroup.

Definition at line 61 of file MessageGroupBase.php.

getIcon()

MessageGroupBase::getIcon

(

)

@inheritDoc

Implements MessageGroup.

Definition at line 66 of file MessageGroupBase.php.

getId()

MessageGroupBase::getId

(

)

@inheritDoc

Implements MessageGroup.

Definition at line 51 of file MessageGroupBase.php.

getInsertablesSuggester()

MessageGroupBase::getInsertablesSuggester

(

)

Returns the configured InsertablesSuggester if any.

Since

2013.09

Returns

CombinedInsertablesSuggester

Definition at line 137 of file MessageGroupBase.php.

getKeys()

MessageGroupBase::getKeys

(

)

@inheritDoc

Implements MessageGroup.

Reimplemented in AggregateMessageGroup, and FileBasedMessageGroup.

Definition at line 169 of file MessageGroupBase.php.

getLabel()

MessageGroupBase::getLabel

(

?IContextSource

$context = null

)

@inheritDoc

Implements MessageGroup.

Definition at line 56 of file MessageGroupBase.php.

getMangler()

MessageGroupBase::getMangler

(

)

@inheritDoc

Implements MessageGroup.

Reimplemented in AggregateMessageGroup.

Definition at line 111 of file MessageGroupBase.php.

getMessageGroupStates()

MessageGroupBase::getMessageGroupStates

(

)

@inheritDoc

Implements MessageGroup.

Definition at line 254 of file MessageGroupBase.php.

getNamespace()

MessageGroupBase::getNamespace

(

)

@inheritDoc

Implements MessageGroup.

Definition at line 71 of file MessageGroupBase.php.

getRawTags()

MessageGroupBase::getRawTags ( ?string $type = null )

protected

Definition at line 213 of file MessageGroupBase.php.

getRelatedPage()

MessageGroupBase::getRelatedPage

(

)

@inheritDoc

Implements MessageGroup.

Definition at line 323 of file MessageGroupBase.php.

getSupportConfig()

MessageGroupBase::getSupportConfig

(

)

@inheritDoc

Implements MessageGroup.

Definition at line 318 of file MessageGroupBase.php.

getTags()

MessageGroupBase::getTags

(

$type = null

)

@inheritDoc

Implements MessageGroup.

Reimplemented in AggregateMessageGroup.

Definition at line 174 of file MessageGroupBase.php.

getTranslatableLanguages()

MessageGroupBase::getTranslatableLanguages

(

)

@inheritDoc

Implements MessageGroup.

Definition at line 265 of file MessageGroupBase.php.

getValidator()

MessageGroupBase::getValidator

(

)

@inheritDoc

Implements MessageGroup.

Definition at line 86 of file MessageGroupBase.php.

isMeta()

MessageGroupBase::isMeta

(

)

@inheritDoc

Implements MessageGroup.

Definition at line 76 of file MessageGroupBase.php.

isSourceLanguage()

MessageGroupBase::isSourceLanguage ( string $code )

protected

Definition at line 249 of file MessageGroupBase.php.

parseNamespace()

MessageGroupBase::parseNamespace ( )

protected

Definition at line 228 of file MessageGroupBase.php.

parseTags()

MessageGroupBase::parseTags ( array $patterns )

protected

Definition at line 185 of file MessageGroupBase.php.

setTags()

MessageGroupBase::setTags ( MessageCollection $collection )

protected

Definition at line 222 of file MessageGroupBase.php.

Member Data Documentation

$conf

array MessageGroupBase::$conf

protected

Definition at line 30 of file MessageGroupBase.php.

$mangler

StringMatcher MessageGroupBase::$mangler = null

protected

Definition at line 32 of file MessageGroupBase.php.

$namespace

int MessageGroupBase::$namespace

protected

Definition at line 31 of file MessageGroupBase.php.

---

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

• messagegroups/MessageGroupBase.php