Translate extension for MediaWiki
 
Loading...
Searching...
No Matches
MediaWikiExtensionMessageGroup Class Reference

Message group for MediaWiki extensions. More...

Inheritance diagram for MediaWikiExtensionMessageGroup:
FileBasedMessageGroup MessageGroupBase MediaWiki\Extension\Translate\MessageGroupConfiguration\MetaYamlSchemaExtender MessageGroup

Public Member Functions

 getDescription (?IContextSource $context=null)
 MediaWiki extensions all should have key in their i18n files describing them.
 
- Public Member Functions inherited from FileBasedMessageGroup
 getFFS ()
 
 exists ()
 If this function returns false, the message group is ignored and treated like it would not be configured at all.
 
 load ( $code)
 Returns a list of messages in a given language code.
 
 parseExternal (string $code)
 
 getSourceFilePath ( $code)
 
 getTargetFilename ( $code)
 
 replaceVariables ( $pattern, $code)
 
 mapCode ( $code)
 
 getKeys ()
 @inheritDoc
 
 initCollection ( $code)
 @inheritDoc
 
 getMessage ( $key, $code)
 @inheritDoc
 
 getMessageGroupCache (string $code)
 
- Public Member Functions inherited from MessageGroupBase
 getConfiguration ()
 
 getId ()
 Returns the unique identifier for this group.
 
 getLabel (?IContextSource $context=null)
 Returns the human readable label (as plain text).
 
 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.
 
 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.
 
 getRelatedPage ()
 @inheritDoc
 

Additional Inherited Members

- Static Public Member Functions inherited from FileBasedMessageGroup
static newFromMessageGroup (MessageGroup $group, string $targetPattern='')
 Constructs a FileBasedMessageGroup from any normal message group.
 
static getExtraSchema ()
 Return a data structure that will be merged with the base schema.
 
- Static Public Member Functions inherited from MessageGroupBase
static factory ( $conf)
 
- Public Attributes inherited from FileBasedMessageGroup
const NO_FILE_FORMAT = 1
 
- Protected Member Functions inherited from MessageGroupBase
 getFromConf ( $section, $key=null)
 
 parseTags ( $patterns)
 
 getRawTags ( $type=null)
 
 setTags (MessageCollection $collection)
 
 parseNamespace ()
 
 isSourceLanguage ( $code)
 
- Protected Attributes inherited from FileBasedMessageGroup
 $reverseCodeMap
 
- Protected Attributes inherited from MessageGroupBase
 $conf
 
 $namespace
 
 $mangler
 

Detailed Description

Message group for MediaWiki extensions.

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

Definition at line 12 of file MediaWikiExtensionMessageGroup.php.

Member Function Documentation

◆ getDescription()

MediaWikiExtensionMessageGroup::getDescription ( ?IContextSource $context = null)

MediaWiki extensions all should have key in their i18n files describing them.

This override method implements the logic to retrieve them.

Parameters
IContextSource | null$context
Returns
string

Reimplemented from MessageGroupBase.

Definition at line 20 of file MediaWikiExtensionMessageGroup.php.


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