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 ()
	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.
	getMangler ()
	Return a message mangler or null.
	getInsertablesSuggester ()
	Returns the configured InsertablesSuggester if any.
	getKeys ()
	@inheritDoc
	getTags ( $type=null)
	Returns message tags.
	getMessageGroupStates ()
	Get the message group workflow state configuration.
	getTranslatableLanguages ()
	@inheritDoc
	getSupportConfig ()
	Gets support URL defined for the group if any.
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.

Static Public Member Functions
static	factory ( $conf)

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

Protected Attributes
	$conf
	$namespace
	$mangler

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.

See also

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

Definition at line 31 of file MessageGroupBase.php.

Constructor & Destructor Documentation

__construct()

MessageGroupBase::__construct ( )

protected

Definition at line 37 of file MessageGroupBase.php.

Member Function Documentation

factory()

static MessageGroupBase::factory ( $conf )

static

Parameters

array

$conf

Returns

MessageGroup

Definition at line 45 of file MessageGroupBase.php.

getConfiguration()

MessageGroupBase::getConfiguration

(

)

Definition at line 53 of file MessageGroupBase.php.

getDefinitions()

MessageGroupBase::getDefinitions

(

)

Shortcut for load( getSourceLanguage() ).

Returns

string[]

Implements MessageGroup.

Definition at line 87 of file MessageGroupBase.php.

getDescription()

MessageGroupBase::getDescription

(

IContextSource

$context = null

)

Returns a longer description about the group.

Description can use wikitext. Parameter $context was added in 2012-10-22.

Parameters

IContextSource | null

$context

Context can be used by subclasses to provide translated descriptions, for example.

Returns

string

Implements MessageGroup.

Reimplemented in MediaWikiExtensionMessageGroup.

Definition at line 65 of file MessageGroupBase.php.

getFromConf()

MessageGroupBase::getFromConf ( $section, $key = null )

protected

Definition at line 93 of file MessageGroupBase.php.

getIcon()

MessageGroupBase::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

Implements MessageGroup.

Definition at line 69 of file MessageGroupBase.php.

getId()

MessageGroupBase::getId

(

)

Returns the unique identifier for this group.

Returns

string

Implements MessageGroup.

Definition at line 57 of file MessageGroupBase.php.

getInsertablesSuggester()

MessageGroupBase::getInsertablesSuggester

(

)

Returns the configured InsertablesSuggester if any.

Since

2013.09

Returns

CombinedInsertablesSuggester

Definition at line 152 of file MessageGroupBase.php.

getKeys()

MessageGroupBase::getKeys

(

)

@inheritDoc

Implements MessageGroup.

Reimplemented in AggregateMessageGroup, and FileBasedMessageGroup.

Definition at line 184 of file MessageGroupBase.php.

getLabel()

MessageGroupBase::getLabel

(

IContextSource

$context = null

)

Returns the human readable label (as plain text).

Parameter $context was added in 2012-10-22.

Parameters

IContextSource | null

$context

Context can be used by subclasses to provide translated descriptions, for example.

Returns

string

Implements MessageGroup.

Definition at line 61 of file MessageGroupBase.php.

getMangler()

MessageGroupBase::getMangler

(

)

Return a message mangler or null.

Todo

Make an interface for message manglers

Returns

\MediaWiki\Extension\Translate\MessageProcessing\StringMatcher|null

Implements MessageGroup.

Reimplemented in AggregateMessageGroup.

Definition at line 124 of file MessageGroupBase.php.

getMessageGroupStates()

MessageGroupBase::getMessageGroupStates

(

)

Get the message group workflow state configuration.

Returns

MessageGroupStates

Implements MessageGroup.

Definition at line 284 of file MessageGroupBase.php.

getNamespace()

MessageGroupBase::getNamespace

(

)

Returns the namespace where messages are placed.

Returns

int

Implements MessageGroup.

Definition at line 73 of file MessageGroupBase.php.

getRawTags()

MessageGroupBase::getRawTags ( $type = null )

protected

Definition at line 236 of file MessageGroupBase.php.

getSourceLanguage()

MessageGroupBase::getSourceLanguage

(

)

Returns language code depicting the language of source text.

Returns

string

Implements MessageGroup.

Definition at line 81 of file MessageGroupBase.php.

getSupportConfig()

MessageGroupBase::getSupportConfig

(

)

Gets support URL defined for the group if any.

Returns

array|null

Implements MessageGroup.

Definition at line 348 of file MessageGroupBase.php.

getTags()

MessageGroupBase::getTags

(

$type = null

)

Returns message tags.

If type is given, only message keys with that tag are returned. Otherwise an array[tag => keys] is returned.

Parameters

string | null

$type

Returns

array

Implements MessageGroup.

Reimplemented in AggregateMessageGroup.

Definition at line 188 of file MessageGroupBase.php.

getTranslatableLanguages()

MessageGroupBase::getTranslatableLanguages

(

)

@inheritDoc

Implements MessageGroup.

Definition at line 295 of file MessageGroupBase.php.

getValidator()

MessageGroupBase::getValidator

(

)

Returns a message validator object or null.

Returns

ValidationRunner|null

Implements MessageGroup.

Definition at line 100 of file MessageGroupBase.php.

isMeta()

MessageGroupBase::isMeta

(

)

Todo

Unclear usage. Perhaps rename to isSecondary with the only purpose suppress warnings about message key conflicts.

Returns

bool

Implements MessageGroup.

Definition at line 77 of file MessageGroupBase.php.

isSourceLanguage()

MessageGroupBase::isSourceLanguage ( $code )

protected

Definition at line 276 of file MessageGroupBase.php.

parseNamespace()

MessageGroupBase::parseNamespace ( )

protected

Definition at line 255 of file MessageGroupBase.php.

parseTags()

MessageGroupBase::parseTags ( $patterns )

protected

Definition at line 202 of file MessageGroupBase.php.

setTags()

MessageGroupBase::setTags ( MessageCollection $collection )

protected

Definition at line 249 of file MessageGroupBase.php.

Member Data Documentation

$conf

MessageGroupBase::$conf

protected

Definition at line 32 of file MessageGroupBase.php.

$mangler

MessageGroupBase::$mangler

protected

Definition at line 35 of file MessageGroupBase.php.

$namespace

MessageGroupBase::$namespace

protected

Definition at line 33 of file MessageGroupBase.php.

---

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

• messagegroups/MessageGroupBase.php