MessageWriter Class Reference
[MaintenanceLanguage]

List of all members.

Static Public Member Functions

static writeMessagesToFile ($messages, $code, $write, $listUnknown, $removeUnknown)
 Write a messages array as a PHP text and write it to the messages file.
static writeMessagesArray ($messages, $ignoredComments=false, $prefix=false, $removeUnknown=false)
 Write a messages array as a PHP text.
static makeComments ($messages, $comments, $ignored, $optional)
 Generates an array of comments for messages.
static writeMessagesBlock ($blockComment, $messages, $messageComments=array(), $prefix= '')
 Write a block of messages to PHP.

Static Public Attributes

static $optionalComment = 'only translate this message to other languages if you have to change it'
static $ignoredComment = "do not translate or duplicate this message to other languages"
static $messageStructure
static $blockComments
static $messageComments
static $ignoredMessages
static $optionalMessages


Detailed Description

Definition at line 12 of file writeMessagesArray.inc.


Member Function Documentation

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

Generates an array of comments for messages.

Parameters:
$messages Key of messages.
$comments Comments for messages, indexed by key.
$ignored List of ingored message keys.
$optional List of optional message keys.

Definition at line 141 of file writeMessagesArray.inc.

References $key, and $messages.

Referenced by writeMessagesArray().

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

Write a messages array as a PHP text.

Parameters:
$messages The messages array.
$ignoredComments Show comments about ignored and optional messages? (For English.)
Returns:
Array of the PHP text and the sorted messages array.

Definition at line 75 of file writeMessagesArray.inc.

References $key, $messages, $prefix, $wgBlockComments, $wgIgnoredMessages, $wgMessageComments, $wgMessageStructure, $wgOptionalMessages, makeComments(), and writeMessagesBlock().

Referenced by writeMessagesToFile().

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

Write a block of messages to PHP.

Parameters:
$blockComment The comment of whole block.
$messages The block messages.
$messageComments Optional comments for messages in this block.
$prefix Prefix for every line, for indenting purposes.
Returns:
The block, formatted in PHP.

Definition at line 180 of file writeMessagesArray.inc.

References $key, $messageComments, and $messages.

Referenced by writeMessagesArray().

static MessageWriter::writeMessagesToFile ( messages,
code,
write,
listUnknown,
removeUnknown 
) [static]

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

Parameters:
$messages The messages array.
$code The language code.
$write Write to the messages file?
$listUnknown List the unknown messages?

Definition at line 30 of file writeMessagesArray.inc.

References $code, $filename, $key, $messages, Language::getMessagesFileName(), and writeMessagesArray().

Referenced by rebuildLanguage().


Member Data Documentation

MessageWriter::$blockComments [static]

Definition at line 17 of file writeMessagesArray.inc.

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

Definition at line 14 of file writeMessagesArray.inc.

MessageWriter::$ignoredMessages [static]

Definition at line 19 of file writeMessagesArray.inc.

MessageWriter::$messageComments [static]

Definition at line 18 of file writeMessagesArray.inc.

Referenced by writeMessagesBlock().

MessageWriter::$messageStructure [static]

Definition at line 16 of file writeMessagesArray.inc.

MessageWriter::$optionalComment = 'only translate this message to other languages if you have to change it' [static]

Definition at line 13 of file writeMessagesArray.inc.

MessageWriter::$optionalMessages [static]

Definition at line 20 of file writeMessagesArray.inc.


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

Generated on Sat Sep 5 02:08:42 2009 for MediaWiki by  doxygen 1.5.9