SandboxMessageGroup Class Reference
[Message group]

Inheritance diagram for SandboxMessageGroup:
Inheritance graph
[legend]
Collaboration diagram for SandboxMessageGroup:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 __construct ()
 setLanguage must be called before calling getDefinitions.
 setLanguage ($code)
 getId ()
 getLabel (IContextSource $context=null)
 getDescription (IContextSource $context=null)
 Returns a longer description about the group.
 getDefinitions ()
 Fetch definitions from database.
 getChecker ()
 Returns a message checker object or null.
 getMessageContent (MessageHandle $handle)
 Subpage language code, if any in the title, is ignored.

Protected Attributes

 $namespace = false
 The namespace where all the messages of this group belong.
 $language

Detailed Description

Since:
2013.06

Definition at line 14 of file SandboxMessageGroup.php.


Constructor & Destructor Documentation

SandboxMessageGroup::__construct (  ) 

setLanguage must be called before calling getDefinitions.

Reimplemented from MessageGroupOld.

Definition at line 26 of file SandboxMessageGroup.php.


Member Function Documentation

SandboxMessageGroup::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 141 of file SandboxMessageGroup.php.

SandboxMessageGroup::getDefinitions (  ) 

Fetch definitions from database.

Returns:
array Array of messages keys with definitions.

Reimplemented from WikiMessageGroup.

Definition at line 47 of file SandboxMessageGroup.php.

Here is the call graph for this function:

SandboxMessageGroup::getDescription ( IContextSource $  context = null  ) 

Returns a longer description about the group.

Description can use wikitext. Parameter $context was added in 2012-10-22.

Parameters:
IContextSource $context Context can be used by subclasses to provide translated descriptions, for example.
Returns:
string

Reimplemented from MessageGroupOld.

Definition at line 42 of file SandboxMessageGroup.php.

SandboxMessageGroup::getId (  ) 
Returns:
string

Reimplemented from MessageGroupOld.

Definition at line 33 of file SandboxMessageGroup.php.

SandboxMessageGroup::getLabel ( IContextSource $  context = null  ) 
Parameters:
IContextSource $context
Returns:
string

Reimplemented from MessageGroupOld.

Definition at line 37 of file SandboxMessageGroup.php.

SandboxMessageGroup::getMessageContent ( MessageHandle handle  ) 

Subpage language code, if any in the title, is ignored.

Definition at line 148 of file SandboxMessageGroup.php.

Referenced by getDefinitions().

Here is the call graph for this function:

SandboxMessageGroup::setLanguage ( code  ) 

Definition at line 29 of file SandboxMessageGroup.php.


Member Data Documentation

SandboxMessageGroup::$language [protected]

Definition at line 21 of file SandboxMessageGroup.php.

SandboxMessageGroup::$namespace = false [protected]

The namespace where all the messages of this group belong.

If the group has messages from multiple namespaces, set this to false and look how RecentMessageGroup implements the definitions.

Reimplemented from MessageGroupOld.

Definition at line 19 of file SandboxMessageGroup.php.


The documentation for this class was generated from the following file:
Generated on Tue Oct 29 00:00:52 2013 for MediaWiki Translate Extension by  doxygen 1.6.3