MessageWriter Class Reference

List of all members.

Static Public Member Functions
static	makeComments ($messages, $ignored, $optional)
	Generates an array of comments for messages.
static	writeMessagesArray ($messages, $ignoredComments=false, $prefix=false, $removeUnknown=false)
	Write a messages array as a PHP text.
static	writeMessagesBlock ($blockComment, $messages, $messageComments=array(), $prefix= '')
	Write a block of messages to PHP.
static	writeMessagesToFile ($messages, $code, $write, $listUnknown, $removeUnknown, $messagesFolder=false)
	Write a messages array as a PHP text and write it to the messages file.
Static Protected Attributes
static	$blockComments
static	$ignoredComment = "do not translate or duplicate this message to other languages"
static	$ignoredMessages
static	$messageStructure
static	$optionalComment
static	$optionalMessages

---

Detailed Description

Definition at line 27 of file writeMessagesArray.inc.

---

Member Function Documentation

static MessageWriter::makeComments	(	$	messages,
		$	ignored,
		$	optional
	)		[static]

Generates an array of comments for messages.

Parameters:

$messages	Array: key of messages.
$ignored	Array: list of ingored message keys.
$optional	Array: list of optional message keys.

Returns:

array

Definition at line 189 of file writeMessagesArray.inc.

References $ignoredComment, $key, $messages, $optionalComment, array(), and as.

Referenced by writeMessagesArray().

static MessageWriter::writeMessagesArray	(	$	messages,
		$	ignoredComments = false,
		$	prefix = false,
		$	removeUnknown = false
	)		[static]

Write a messages array as a PHP text.

Parameters:

$messages	Array: the messages array.
$ignoredComments	Boolean: show comments about ignored and optional messages? (For English.)
$prefix	String: base path for messages.inc and messageTypes.inc files or false for default path (this directory)
$removeUnknown	Boolean: whether to remove unkown messages

Returns:

Array of the PHP text and the sorted messages array.

Definition at line 119 of file writeMessagesArray.inc.

References $dir, $ignoredMessages, $key, $messages, $optionalMessages, $wgBlockComments, $wgIgnoredMessages, $wgMessageStructure, $wgOptionalMessages, array(), as, makeComments(), and writeMessagesBlock().

Referenced by writeMessagesToFile().

static MessageWriter::writeMessagesBlock	(	$	blockComment,
		$	messages,
		$	messageComments = array(),
		$	prefix = ''
	)		[static]

Write a block of messages to PHP.

Parameters:

$blockComment	String: the comment of whole block.
$messages	Array: the block messages.
$messageComments	Array: optional comments for messages in this block.
$prefix	String: prefix for every line, for indenting purposes.

Returns:

string The block, formatted in PHP.

Definition at line 215 of file writeMessagesArray.inc.

References $key, $messages, $value, as, and empty.

Referenced by writeMessagesArray().

static MessageWriter::writeMessagesToFile	(	$	messages,
		$	code,
		$	write,
		$	listUnknown,
		$	removeUnknown,
		$	messagesFolder = false
	)		[static]

Write a messages array as a PHP text and write it to the messages file.

Parameters:

$messages	Array: the messages array.
$code	String: the language code.
$write	Boolean: write to the messages file?
$listUnknown	Boolean: list the unknown messages?
$removeUnknown	Boolean: whether to remove unkown messages
$messagesFolder	String: path to a folder to store the MediaWiki messages. Defaults to the current install.

Definition at line 48 of file writeMessagesArray.inc.

References $key, $messages, $messagesFolder, $value, as, empty, Language\getFileName(), Language\getMessagesFileName(), and writeMessagesArray().

Referenced by rebuildLanguage().

---

Member Data Documentation

MessageWriter::$blockComments [static, protected]

Definition at line 33 of file writeMessagesArray.inc.

MessageWriter::$ignoredComment = "do not translate or duplicate this message to other languages" [static, protected]

Definition at line 30 of file writeMessagesArray.inc.

Referenced by makeComments().

MessageWriter::$ignoredMessages [static, protected]

Definition at line 34 of file writeMessagesArray.inc.

Referenced by writeMessagesArray().

MessageWriter::$messageStructure [static, protected]

Definition at line 32 of file writeMessagesArray.inc.

MessageWriter::$optionalComment [static, protected]

Initial value:

        'only translate this message to other languages if you have to change it'

Definition at line 28 of file writeMessagesArray.inc.

Referenced by makeComments().

MessageWriter::$optionalMessages [static, protected]

Definition at line 35 of file writeMessagesArray.inc.

Referenced by writeMessagesArray().

---

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

• maintenance/language/writeMessagesArray.inc