CoreMessageGroup Class Reference
[Message group]

This group supports the MediaWiki messages. More...

Inheritance diagram for CoreMessageGroup:

[legend]

Collaboration diagram for CoreMessageGroup:

[legend]

List of all members.

Public Member Functions
	__construct ()
	getPrefix ()
	setPrefix ($value)
	getMetaDataPrefix ()
	setMetaDataPrefix ($value)
	setIcon ($icon)
	getIcon ()
	Returns an icon for this message group if any.
	getUniqueDefinitions ()
	This function can be used for meta message groups to list their "own" messages.
	getMessageFile ($code)
	Returns path to the file where translation of language code $code are.
	getPath ()
	getReader ($code)
	getWriter ()
	getTags ($type=null)
	Returns message tags.
	load ($code)
	Returns a list of messages in a given language code.
	getChecker ()
	Returns a message checker object or null.
	getInsertablesSuggester ()
Static Public Member Functions
static	factory ($label, $id)
Public Attributes
	$parentId = null
Protected Attributes
	$label = 'MediaWiki'
	Human-readable name of this group.
	$id = 'core'
	Group-wide unique id of this group.
	$type = 'mediawiki'
	$description = '{{int:translate-group-desc-mediawikicore}}'
	Holds descripton of this group.
	$icon
	$prefix = ''
	$metaDataPrefix = ''

---

Detailed Description

This group supports the MediaWiki messages.

Todo:

Move to the new interface.

Definition at line 17 of file CoreMessageGroup.php.

---

Constructor & Destructor Documentation

CoreMessageGroup::__construct

(

)

Reimplemented from MessageGroupOld.

Definition at line 24 of file CoreMessageGroup.php.

---

Member Function Documentation

static CoreMessageGroup::factory	(	$	label,
		$	id
	)			[static]

Definition at line 55 of file CoreMessageGroup.php.

CoreMessageGroup::getChecker

(

)

Returns a message checker object or null.

Todo:

Make an interface for message checkers.

Returns:

MessageChecker or null

Reimplemented from MessageGroupOld.

Definition at line 135 of file CoreMessageGroup.php.

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

Reimplemented from MessageGroupOld.

Definition at line 68 of file CoreMessageGroup.php.

CoreMessageGroup::getInsertablesSuggester

(

)

Definition at line 151 of file CoreMessageGroup.php.

CoreMessageGroup::getMessageFile

(

$

code

)

Returns path to the file where translation of language code $code are.

Parameters:

string

$code

Returns:

string Path to the file or false if not applicable.

Reimplemented from MessageGroupOld.

Definition at line 89 of file CoreMessageGroup.php.

CoreMessageGroup::getMetaDataPrefix

(

)

Definition at line 45 of file CoreMessageGroup.php.

Referenced by getTags().

CoreMessageGroup::getPath

(

)

Reimplemented from MessageGroupOld.

Definition at line 95 of file CoreMessageGroup.php.

CoreMessageGroup::getPrefix

(

)

Definition at line 35 of file CoreMessageGroup.php.

CoreMessageGroup::getReader

(

$

code

)

Reimplemented from MessageGroupOld.

Definition at line 99 of file CoreMessageGroup.php.

Here is the call graph for this function:

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

$type

string

Returns:

array

Reimplemented from MessageGroupOld.

Definition at line 107 of file CoreMessageGroup.php.

Here is the call graph for this function:

CoreMessageGroup::getUniqueDefinitions

(

)

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

For example branched message groups can exclude the messages they share with each other.

Returns:

array

Reimplemented from MessageGroupOld.

Definition at line 72 of file CoreMessageGroup.php.

Here is the call graph for this function:

CoreMessageGroup::getWriter

(

)

Returns:

SimpleFormatWriter

Reimplemented from MessageGroupOld.

Definition at line 103 of file CoreMessageGroup.php.

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

$code

Returns:

array

Reimplemented from MessageGroupOld.

Definition at line 116 of file CoreMessageGroup.php.

Here is the call graph for this function:

CoreMessageGroup::setIcon

(

$

icon

)

See also:

MessageGroup::getIcon

Definition at line 64 of file CoreMessageGroup.php.

CoreMessageGroup::setMetaDataPrefix

(

$

value

)

Definition at line 49 of file CoreMessageGroup.php.

CoreMessageGroup::setPrefix

(

$

value

)

Definition at line 39 of file CoreMessageGroup.php.

---

Member Data Documentation

CoreMessageGroup::$description = '{{int:translate-group-desc-mediawikicore}}' [protected]

Holds descripton of this group.

Description is a wiki text snippet that gives information about this group to translators.

Reimplemented from MessageGroupOld.

Reimplemented in CoreMostUsedMessageGroup.

Definition at line 21 of file CoreMessageGroup.php.

CoreMessageGroup::$icon [protected]

Definition at line 22 of file CoreMessageGroup.php.

Referenced by setIcon().

CoreMessageGroup::$id = 'core' [protected]

Group-wide unique id of this group.

Used also for sorting.

Reimplemented from MessageGroupOld.

Reimplemented in CoreMostUsedMessageGroup.

Definition at line 19 of file CoreMessageGroup.php.

Referenced by factory().

CoreMessageGroup::$label = 'MediaWiki' [protected]

Human-readable name of this group.

Reimplemented from MessageGroupOld.

Reimplemented in CoreMostUsedMessageGroup.

Definition at line 18 of file CoreMessageGroup.php.

Referenced by factory().

CoreMessageGroup::$metaDataPrefix = '' [protected]

Definition at line 43 of file CoreMessageGroup.php.

CoreMessageGroup::$parentId = null

Definition at line 53 of file CoreMessageGroup.php.

CoreMessageGroup::$prefix = '' [protected]

Definition at line 33 of file CoreMessageGroup.php.

CoreMessageGroup::$type = 'mediawiki' [protected]

Definition at line 20 of file CoreMessageGroup.php.

Referenced by getTags().

---

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

• Translate/messagegroups/CoreMessageGroup.php