This class implements some basic functions that wrap around the YAML message group configurations. More...
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 | |
This class implements some basic functions that wrap around the YAML message group configurations.
These message groups use the FFS classes and are managed with Special:ManageMessageGroups and processMessageChanges.php.
Definition at line 30 of file MessageGroupBase.php.
|
protected |
Definition at line 36 of file MessageGroupBase.php.
|
static |
MessageGroupBase::getConfiguration | ( | ) |
Definition at line 52 of file MessageGroupBase.php.
MessageGroupBase::getDefinitions | ( | ) |
Shortcut for load( getSourceLanguage() ).
Implements MessageGroup.
Definition at line 86 of file MessageGroupBase.php.
MessageGroupBase::getDescription | ( | IContextSource | $context = null | ) |
Returns a longer description about the group.
Description can use wikitext. Parameter $context was added in 2012-10-22.
IContextSource | null | $context | Context can be used by subclasses to provide translated descriptions, for example. |
Implements MessageGroup.
Reimplemented in MediaWikiExtensionMessageGroup.
Definition at line 64 of file MessageGroupBase.php.
|
protected |
Definition at line 92 of file MessageGroupBase.php.
MessageGroupBase::getIcon | ( | ) |
Returns an icon for this message group if any.
Implements MessageGroup.
Definition at line 68 of file MessageGroupBase.php.
MessageGroupBase::getId | ( | ) |
Returns the unique identifier for this group.
Implements MessageGroup.
Definition at line 56 of file MessageGroupBase.php.
MessageGroupBase::getInsertablesSuggester | ( | ) |
Returns the configured InsertablesSuggester if any.
Definition at line 151 of file MessageGroupBase.php.
MessageGroupBase::getKeys | ( | ) |
@inheritDoc
Implements MessageGroup.
Reimplemented in AggregateMessageGroup, and FileBasedMessageGroup.
Definition at line 183 of file MessageGroupBase.php.
MessageGroupBase::getLabel | ( | IContextSource | $context = null | ) |
Returns the human readable label (as plain text).
Parameter $context was added in 2012-10-22.
IContextSource | null | $context | Context can be used by subclasses to provide translated descriptions, for example. |
Implements MessageGroup.
Definition at line 60 of file MessageGroupBase.php.
MessageGroupBase::getMangler | ( | ) |
Return a message mangler or null.
Implements MessageGroup.
Reimplemented in AggregateMessageGroup.
Definition at line 123 of file MessageGroupBase.php.
MessageGroupBase::getMessageGroupStates | ( | ) |
Get the message group workflow state configuration.
Implements MessageGroup.
Definition at line 283 of file MessageGroupBase.php.
MessageGroupBase::getNamespace | ( | ) |
Returns the namespace where messages are placed.
Implements MessageGroup.
Definition at line 72 of file MessageGroupBase.php.
|
protected |
Definition at line 235 of file MessageGroupBase.php.
MessageGroupBase::getSourceLanguage | ( | ) |
Returns language code depicting the language of source text.
Implements MessageGroup.
Definition at line 80 of file MessageGroupBase.php.
MessageGroupBase::getSupportConfig | ( | ) |
Gets support URL defined for the group if any.
Implements MessageGroup.
Definition at line 346 of file MessageGroupBase.php.
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.
string | null | $type |
Implements MessageGroup.
Reimplemented in AggregateMessageGroup.
Definition at line 187 of file MessageGroupBase.php.
MessageGroupBase::getTranslatableLanguages | ( | ) |
MessageGroupBase::getValidator | ( | ) |
Returns a message validator object or null.
Implements MessageGroup.
Definition at line 99 of file MessageGroupBase.php.
MessageGroupBase::isMeta | ( | ) |
Implements MessageGroup.
Definition at line 76 of file MessageGroupBase.php.
|
protected |
Definition at line 275 of file MessageGroupBase.php.
|
protected |
Definition at line 254 of file MessageGroupBase.php.
|
protected |
Definition at line 201 of file MessageGroupBase.php.
|
protected |
Definition at line 248 of file MessageGroupBase.php.
|
protected |
Definition at line 31 of file MessageGroupBase.php.
|
protected |
Definition at line 34 of file MessageGroupBase.php.
|
protected |
Definition at line 32 of file MessageGroupBase.php.