MediaWiki\Extension\Translate\MessageLoading\Message Class Reference

Interface for message objects used by MessageCollection. More...

Inheritance diagram for MediaWiki\Extension\Translate\MessageLoading\Message:

Public Member Functions
	__construct (string $key, ?string $definition)
	Creates new message object.
	key ()
	Get the message key.
	definition ()
	Get the message definition.
	translation ()
	Get the message translation.
	setInfile (string $text)
	Set the committed translation.
	infile ()
	Returns the committed translation.
	addTag (string $tag)
	Add a tag for this message.
	hasTag (string $tag)
	Check if this message has a given tag.
	getTags ()
	Return all tags for this message.
	setProperty (string $key, $value)
	appendProperty (string $key, $value)
	getProperty (string $key)
	getPropertyNames ()
	Get all the available property names.

Protected Attributes
string	$key
	Message display key.
string	$definition
	Message definition.
string	$infile = null
	Committed in-file translation.
array	$tags = []
array	$props = []
	Message properties.
array	$reviewers = []

Detailed Description

Interface for message objects used by MessageCollection.

Author

Niklas Laxström

Copyright

Copyright © 2008-2010, Niklas Laxström @license GPL-2.0-or-later

Definition at line 13 of file Message.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Extension\Translate\MessageLoading\Message::__construct	(	string	$key,
		?string	$definition )

Creates new message object.

Parameters

string	$key	Unique key identifying this message.
string | null	$definition	The authoritave definition of this message.

Definition at line 33 of file Message.php.

Member Function Documentation

addTag()

MediaWiki\Extension\Translate\MessageLoading\Message::addTag

(

string

$tag

)

Add a tag for this message.

Definition at line 66 of file Message.php.

appendProperty()

MediaWiki\Extension\Translate\MessageLoading\Message::appendProperty	(	string	$key,
			$value )

Parameters

string	$key
mixed	$value

Definition at line 95 of file Message.php.

definition()

MediaWiki\Extension\Translate\MessageLoading\Message::definition

(

)

Get the message definition.

Message definition should not be empty, but sometimes is. See: https://phabricator.wikimedia.org/T285830

Definition at line 48 of file Message.php.

getProperty()

MediaWiki\Extension\Translate\MessageLoading\Message::getProperty

(

string

$key

)

Returns

mixed

Reimplemented in MediaWiki\Extension\Translate\MessageLoading\ThinMessage.

Definition at line 103 of file Message.php.

getPropertyNames()

MediaWiki\Extension\Translate\MessageLoading\Message::getPropertyNames

(

)

Get all the available property names.

Reimplemented in MediaWiki\Extension\Translate\MessageLoading\ThinMessage.

Definition at line 108 of file Message.php.

getTags()

MediaWiki\Extension\Translate\MessageLoading\Message::getTags

(

)

Return all tags for this message.

Returns

string[]

Definition at line 79 of file Message.php.

hasTag()

MediaWiki\Extension\Translate\MessageLoading\Message::hasTag

(

string

$tag

)

Check if this message has a given tag.

Definition at line 71 of file Message.php.

infile()

MediaWiki\Extension\Translate\MessageLoading\Message::infile

(

)

Returns the committed translation.

Definition at line 61 of file Message.php.

key()

MediaWiki\Extension\Translate\MessageLoading\Message::key

(

)

Get the message key.

Definition at line 39 of file Message.php.

setInfile()

MediaWiki\Extension\Translate\MessageLoading\Message::setInfile

(

string

$text

)

Set the committed translation.

Definition at line 56 of file Message.php.

setProperty()

MediaWiki\Extension\Translate\MessageLoading\Message::setProperty	(	string	$key,
			$value )

Parameters

string	$key
mixed	$value

Definition at line 87 of file Message.php.

translation()

MediaWiki\Extension\Translate\MessageLoading\Message::translation ( )

abstract

Get the message translation.

Reimplemented in MediaWiki\Extension\Translate\MessageLoading\FatMessage, and MediaWiki\Extension\Translate\MessageLoading\ThinMessage.

Member Data Documentation

$definition

string MediaWiki\Extension\Translate\MessageLoading\Message::$definition

protected

Message definition.

Definition at line 17 of file Message.php.

$infile

string MediaWiki\Extension\Translate\MessageLoading\Message::$infile = null

protected

Committed in-file translation.

Definition at line 19 of file Message.php.

$key

string MediaWiki\Extension\Translate\MessageLoading\Message::$key

protected

Message display key.

Definition at line 15 of file Message.php.

$props

array MediaWiki\Extension\Translate\MessageLoading\Message::$props = []

protected

Message properties.

Definition at line 23 of file Message.php.

$reviewers

array MediaWiki\Extension\Translate\MessageLoading\Message::$reviewers = []

protected

Definition at line 25 of file Message.php.

$tags

array MediaWiki\Extension\Translate\MessageLoading\Message::$tags = []

protected

Definition at line 21 of file Message.php.

---

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

• src/MessageLoading/Message.php