ComplexMessages Class Reference

Base class which implements handling and translation interface of non-message MediaWiki items. More...

Inheritance diagram for ComplexMessages:

Public Member Functions
	__construct ($langCode)
	getTitle ()
	getGroups ()
	cleanData ($defs, $current)
	mergeMagic ($defs, $current)
	getData (&$group, $savedData)
	loadFromRequest (WebRequest $request)
	Gets data from request.
	header ($title)
	output ()
	getButtons ()
	formatElement ($element)
	getKeyForEdit ($key)
	editElement ($key, $contents)
	getKeyForSave ()
	formatForSave (WebRequest $request)
	save ($request)
	validate (&$errors=array(), $filter=false)
	export ($filter=false)
	highlight ($key, $values)
Static Public Member Functions
static	arrayMapRecursive ($callback, $data)
Public Attributes
const	LANG_MASTER = 0
const	LANG_CHAIN = 1
const	LANG_CURRENT = 2
Protected Member Functions
	getSavedData ()
	Gets saved data from Mediawiki namespace.
	parse ($data)
	getIterator ($group)
	Return an array of keys that can be used to iterate over all keys.
	val ($group, $type, $key)
	readVariable ($group, $code)
	validateEach (&$errors=array(), $group, &$used)
	exportEach ($group, $data)
	normalize ($data)
	Returns string with quotes that should be valid php.
Protected Attributes
	$language = null
	$targetDir = null
	$id = '__BUG__'
	$variable = '__BUG__'
	$data = array()
	$elementsInArray = true
	$databaseMsg = '__BUG__'
	$chainable = false
	$firstMagic = false
	$constants = array()
	$tableAttributes
	$init = false

Detailed Description

Base class which implements handling and translation interface of non-message MediaWiki items.

Todo:: Needs documentation.

Definition at line 16 of file MediaWikiComplexMessages.php.

Constructor & Destructor Documentation

ComplexMessages::__construct ( $ langCode )

Reimplemented in SpecialPageAliasesCM, MagicWordsCM, and NamespaceCM.

Definition at line 40 of file MediaWikiComplexMessages.php.

Member Function Documentation

static ComplexMessages::arrayMapRecursive	(	$	callback,
		$	data
	)			`[static]`

Definition at line 240 of file MediaWikiComplexMessages.php.

Referenced by readVariable().

ComplexMessages::cleanData	(	$	defs,
		$	current
	)

Definition at line 70 of file MediaWikiComplexMessages.php.

Referenced by getData().

ComplexMessages::editElement	(	$	key,
		$	contents
	)

Definition at line 360 of file MediaWikiComplexMessages.php.

Referenced by output().

Here is the call graph for this function:

ComplexMessages::export ( $ filter = false )

Definition at line 476 of file MediaWikiComplexMessages.php.

Here is the call graph for this function:

ComplexMessages::exportEach	(	$	group,
		$	data
	)			`[protected]`

Definition at line 493 of file MediaWikiComplexMessages.php.

Referenced by export().

Here is the call graph for this function:

ComplexMessages::formatElement ( $ element )

Definition at line 343 of file MediaWikiComplexMessages.php.

Referenced by output().

ComplexMessages::formatForSave ( WebRequest $ request )

Parameters:

WebRequest

$request

Returns:: string

Definition at line 383 of file MediaWikiComplexMessages.php.

Referenced by loadFromRequest(), and save().

Here is the call graph for this function:

ComplexMessages::getButtons ( )

Definition at line 331 of file MediaWikiComplexMessages.php.

Referenced by output().

ComplexMessages::getData	(	&$	group,
		$	savedData
	)

Definition at line 100 of file MediaWikiComplexMessages.php.

Referenced by getGroups(), and loadFromRequest().

Here is the call graph for this function:

ComplexMessages::getGroups ( )

Definition at line 58 of file MediaWikiComplexMessages.php.

Referenced by export(), getIterator(), and val().

Here is the call graph for this function:

ComplexMessages::getIterator ( $ group ) [protected]

Return an array of keys that can be used to iterate over all keys.

Parameters:

$group

Returns:: Array of keys for data

Definition at line 185 of file MediaWikiComplexMessages.php.

Referenced by exportEach(), formatForSave(), output(), NamespaceCM::validateEach(), SpecialPageAliasesCM::validateEach(), and validateEach().

Here is the call graph for this function:

ComplexMessages::getKeyForEdit ( $ key )

Definition at line 356 of file MediaWikiComplexMessages.php.

Referenced by editElement(), and formatForSave().

ComplexMessages::getKeyForSave ( )

Definition at line 375 of file MediaWikiComplexMessages.php.

Referenced by save().

ComplexMessages::getSavedData ( ) [protected]

Gets saved data from Mediawiki namespace.

Returns:: Array

Definition at line 146 of file MediaWikiComplexMessages.php.

Referenced by getGroups().

Here is the call graph for this function:

ComplexMessages::getTitle ( )

Definition at line 47 of file MediaWikiComplexMessages.php.

Referenced by header().

ComplexMessages::header ( $ title )

Definition at line 259 of file MediaWikiComplexMessages.php.

Referenced by output().

Here is the call graph for this function:

ComplexMessages::highlight	(	$	key,
		$	values
	)

Reimplemented in SpecialPageAliasesCM, and MagicWordsCM.

Definition at line 586 of file MediaWikiComplexMessages.php.

Referenced by output().

ComplexMessages::loadFromRequest ( WebRequest $ request )

Gets data from request.

Needs to be run before the form is displayed and validation. Not needed for export, which uses request directly.

Parameters:

$request

WebRequest

Definition at line 135 of file MediaWikiComplexMessages.php.

Here is the call graph for this function:

ComplexMessages::mergeMagic	(	$	defs,
		$	current
	)

Definition at line 90 of file MediaWikiComplexMessages.php.

Referenced by getData().

ComplexMessages::normalize ( $ data ) [protected]

Returns string with quotes that should be valid php.

Parameters:

$data

string

Exceptions:

MWException

Returns:: string

Definition at line 573 of file MediaWikiComplexMessages.php.

ComplexMessages::output ( )

Definition at line 270 of file MediaWikiComplexMessages.php.

Here is the call graph for this function:

ComplexMessages::parse ( $ data ) [protected]

Definition at line 156 of file MediaWikiComplexMessages.php.

Referenced by getSavedData(), and loadFromRequest().

ComplexMessages::readVariable	(	$	group,
		$	code
	)			`[protected]`

Parameters:

	$group
	$code

Returns:: array

Definition at line 218 of file MediaWikiComplexMessages.php.

Referenced by getData().

Here is the call graph for this function:

ComplexMessages::save ( $ request )

Definition at line 411 of file MediaWikiComplexMessages.php.

Here is the call graph for this function:

ComplexMessages::val	(	$	group,
		$	type,
		$	key
	)			`[protected]`

Definition at line 191 of file MediaWikiComplexMessages.php.

Referenced by exportEach(), output(), NamespaceCM::validateEach(), SpecialPageAliasesCM::validateEach(), and validateEach().

Here is the call graph for this function:

ComplexMessages::validate	(	&$	errors = `array()`,
		$	filter = `false`
	)

Definition at line 439 of file MediaWikiComplexMessages.php.

Referenced by export().

Here is the call graph for this function:

ComplexMessages::validateEach	(	&$	errors = `array()`,
		$	group,
		&$	used
	)			`[protected]`

Reimplemented in SpecialPageAliasesCM, and NamespaceCM.

Definition at line 450 of file MediaWikiComplexMessages.php.

Referenced by validate().

Here is the call graph for this function:

Member Data Documentation

ComplexMessages::$chainable = false [protected]

Reimplemented in SpecialPageAliasesCM, and MagicWordsCM.

Definition at line 28 of file MediaWikiComplexMessages.php.

ComplexMessages::$constants = array() [protected]

Reimplemented in NamespaceCM.

Definition at line 30 of file MediaWikiComplexMessages.php.

ComplexMessages::$data = array() [protected]

Definition at line 25 of file MediaWikiComplexMessages.php.

Referenced by arrayMapRecursive(), export(), exportEach(), formatForSave(), getData(), getSavedData(), normalize(), parse(), readVariable(), and save().

ComplexMessages::$databaseMsg = '__BUG__' [protected]

Reimplemented in SpecialPageAliasesCM, MagicWordsCM, and NamespaceCM.

Definition at line 27 of file MediaWikiComplexMessages.php.

ComplexMessages::$elementsInArray = true [protected]

Reimplemented in NamespaceCM.

Definition at line 26 of file MediaWikiComplexMessages.php.

ComplexMessages::$firstMagic = false [protected]

Reimplemented in MagicWordsCM.

Definition at line 29 of file MediaWikiComplexMessages.php.

ComplexMessages::$id = '__BUG__' [protected]

Reimplemented in SpecialPageAliasesCM, MagicWordsCM, and NamespaceCM.

Definition at line 23 of file MediaWikiComplexMessages.php.

ComplexMessages::$init = false [protected]

Definition at line 56 of file MediaWikiComplexMessages.php.

ComplexMessages::$language = null [protected]

Definition at line 21 of file MediaWikiComplexMessages.php.

Referenced by __construct().

ComplexMessages::$tableAttributes [protected]

Initial value:

 array(
        'class' => 'wikitable',
        'border' => '2',
        'cellpadding' => '4',
        'cellspacing' => '0',
        'style' => 'background-color: #F9F9F9; border: 1px #AAAAAA solid; border-collapse: collapse;',
    )

Definition at line 32 of file MediaWikiComplexMessages.php.

ComplexMessages::$targetDir = null [protected]

Definition at line 22 of file MediaWikiComplexMessages.php.

ComplexMessages::$variable = '__BUG__' [protected]

Definition at line 24 of file MediaWikiComplexMessages.php.

const ComplexMessages::LANG_CHAIN = 1

Definition at line 18 of file MediaWikiComplexMessages.php.

const ComplexMessages::LANG_CURRENT = 2

Definition at line 19 of file MediaWikiComplexMessages.php.

const ComplexMessages::LANG_MASTER = 0

Definition at line 17 of file MediaWikiComplexMessages.php.

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