Wraps the translatable page sections into a message group. More...

Inheritance diagram for WikiPageMessageGroup:

Public Member Functions
	__construct ( $id, $title)

	getSourceLanguage ()
	Returns language code depicting the language of source text.

	getTitle ()

	getDefinitions ()

	makeGroupKeys (array $keys)

	getLabel (IContextSource $context=null)
	Overriding the getLabel method and deriving the label from the title.

	clearCaches ()
	Clear caches to avoid stale data.

	load ( $code)
	Returns a list of messages in a given language code.

	getMessage ( $key, $code, $flags=IDBAccessObject::READ_LATEST)
	Returns of stored translation of message specified by the $key in language code $code.

	getValidator ()

	getInsertablesSuggester ()

	getDescription (IContextSource $context=null)
	Returns a longer description about the group.

Public Member Functions inherited from MessageGroupOld
	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.

	setDescription ( $value)

	getIcon ()
	Returns an icon for this message group if any.

	isMeta ()

	getMangler ()

	getUniqueDefinitions ()
	This function can be used for meta message groups to list their "own" messages.

	getKeys ()
	@inheritDoc

	getMessage ( $key, $code)
	Returns of stored translation of message specified by the $key in language code $code.

	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.

	exists ()
	Can be overwritten to return false if something is wrong.

	getTags ( $type=null)
	Returns message tags.

	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 Attributes
	$title

	$namespace = NS_TRANSLATIONS

	$definitions
	Only used for caching to avoid repeating database queries for example during message index rebuild.

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.

Additional Inherited Members
Static Public Member Functions inherited from MessageGroupOld
static	normaliseKeys ( $array)

Protected Member Functions inherited from MessageGroupOld
	isSourceLanguage ( $code)

Static Protected Member Functions inherited from MessageGroupOld
static	addContext (Message $message, IContextSource $context=null)

Detailed Description

Wraps the translatable page sections into a message group.

Definition at line 24 of file WikiPageMessageGroup.php.

Constructor & Destructor Documentation

◆ __construct()

WikiPageMessageGroup::__construct	(		$id,
			$title )

Parameters

string	$id
Title \| string	$title

Definition at line 34 of file WikiPageMessageGroup.php.

Member Function Documentation

◆ clearCaches()

WikiPageMessageGroup::clearCaches ( )

Clear caches to avoid stale data.

For example JobQueue can run for a longer time, and stale definitions would cause the total number of messages to be incorrect.

Since: 2016.04

Definition at line 122 of file WikiPageMessageGroup.php.

◆ getDefinitions()

WikiPageMessageGroup::getDefinitions ( )

Returns: string[]

Reimplemented from MessageGroupOld.

Definition at line 59 of file WikiPageMessageGroup.php.

◆ getDescription()

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

Reimplemented from MessageGroupOld.

Definition at line 190 of file WikiPageMessageGroup.php.

◆ getInsertablesSuggester()

WikiPageMessageGroup::getInsertablesSuggester ( )

Definition at line 186 of file WikiPageMessageGroup.php.

◆ getLabel()

WikiPageMessageGroup::getLabel ( IContextSource $context = null )

Overriding the getLabel method and deriving the label from the title.

Mainly to reduce the amount of data stored in the cache.

Parameters

IContextSource | null $context

Returns: string

Reimplemented from MessageGroupOld.

Definition at line 110 of file WikiPageMessageGroup.php.

◆ getMessage()

WikiPageMessageGroup::getMessage	(	$key,
		$code,
		$flags = IDBAccessObject::READ_LATEST )

Returns of stored translation of message specified by the $key in language code $code.

Parameters

string	$key	Message key
string	$code	Language code
int	$flags	READ_* class constant bitfield

Returns: string|null Stored translation or null.

Definition at line 143 of file WikiPageMessageGroup.php.

◆ getSourceLanguage()

WikiPageMessageGroup::getSourceLanguage ( )

Returns language code depicting the language of source text.

Returns: string

Reimplemented from MessageGroupOld.

Definition at line 39 of file WikiPageMessageGroup.php.

◆ getTitle()

WikiPageMessageGroup::getTitle ( )

Returns: Title

Definition at line 44 of file WikiPageMessageGroup.php.

◆ getValidator()

WikiPageMessageGroup::getValidator ( )

Returns: ValidationRunner

Reimplemented from MessageGroupOld.

Definition at line 176 of file WikiPageMessageGroup.php.

◆ load()

WikiPageMessageGroup::load ( $code )

Returns a list of messages in a given language code.

For some groups that list may be identical with the translation in the wiki. For other groups the messages may be loaded from a file (and differ from the current translations or definitions).

Parameters

string $code

Returns: string[]

Reimplemented from MessageGroupOld.

Definition at line 126 of file WikiPageMessageGroup.php.

◆ makeGroupKeys()

WikiPageMessageGroup::makeGroupKeys ( array $keys )

Parameters

string[] $keys

Returns: string[]

Definition at line 96 of file WikiPageMessageGroup.php.

Member Data Documentation

◆ $definitions

WikiPageMessageGroup::$definitions

protected

Only used for caching to avoid repeating database queries for example during message index rebuild.

Definition at line 56 of file WikiPageMessageGroup.php.

◆ $namespace

WikiPageMessageGroup::$namespace = NS_TRANSLATIONS

protected

Definition at line 28 of file WikiPageMessageGroup.php.

◆ $title

WikiPageMessageGroup::$title

protected

Definition at line 26 of file WikiPageMessageGroup.php.

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

messagegroups/WikiPageMessageGroup.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ clearCaches()

◆ getDefinitions()

◆ getDescription()

◆ getInsertablesSuggester()

◆ getLabel()

◆ getMessage()

◆ getSourceLanguage()

◆ getTitle()

◆ getValidator()

◆ load()

◆ makeGroupKeys()

Member Data Documentation

◆ $definitions

◆ $namespace

◆ $title