SMWSMWDoc Class Reference

List of all members.

Public Member Functions
	render (array $parameters)
	Renders and returns the output.
	getMessage ()
Static Public Member Functions
static	staticInit (Parser &$parser)
	No LSB in pre-5.3 PHP *sigh*.
Protected Member Functions
	getName ()
	Gets the name of the parser hook.
	getParameterInfo ($type)
	Returns an array containing the parameter info.
	getDefaultParameters ($type)
	Returns the list of default parameters.
	getParameterTable (array $parameters)
	Returns the wikitext for a table listing the provided parameters.
	getDescriptionRow (Parameter $parameter, $hasAliases)
	Returns the wikitext for a table row describing a single parameter.
	getFormatParameters ($format)
	msg ($key)
	Message function that takes into account the language parameter.
Protected Attributes
	$language

---

Detailed Description

Definition at line 15 of file SMW_SMWDoc.php.

---

Member Function Documentation

static SMWSMWDoc::staticInit

(

Parser &$

parser

)

[static]

No LSB in pre-5.3 PHP *sigh*.

This is to be refactored as soon as php >=5.3 becomes acceptable.

Definition at line 30 of file SMW_SMWDoc.php.

SMWSMWDoc::getName

(

)

[protected]

Gets the name of the parser hook.

See also:

ParserHook::getName

Since:

1.6

Returns:

string

Definition at line 43 of file SMW_SMWDoc.php.

Referenced by getParameterTable().

SMWSMWDoc::getParameterInfo

(

$

type

)

[protected]

Returns an array containing the parameter info.

See also:

ParserHook::getParameterInfo

Since:

1.6

Returns:

array

Definition at line 55 of file SMW_SMWDoc.php.

SMWSMWDoc::getDefaultParameters

(

$

type

)

[protected]

Returns the list of default parameters.

See also:

ParserHook::getDefaultParameters

Since:

1.6

Returns:

array

Definition at line 81 of file SMW_SMWDoc.php.

SMWSMWDoc::render

(

array $

parameters

)

Renders and returns the output.

See also:

ParserHook::render

Since:

1.0

Parameters:

array

$parameters

Returns:

string

Definition at line 95 of file SMW_SMWDoc.php.

References getFormatParameters(), SMWQueryProcessor::getParameters(), and getParameterTable().

SMWSMWDoc::getParameterTable

(

array $

parameters

)

[protected]

Returns the wikitext for a table listing the provided parameters.

Since:

1.6

Parameters:

array

$parameters

Returns:

string

Definition at line 120 of file SMW_SMWDoc.php.

References getDescriptionRow(), getName(), and msg().

Referenced by render().

SMWSMWDoc::getDescriptionRow	(	Parameter $	parameter,
		$	hasAliases
	)			[protected]

Returns the wikitext for a table row describing a single parameter.

Since:

1.6

Parameters:

	Parameter	$parameter
	boolean	$hasAliases

Returns:

string

Definition at line 167 of file SMW_SMWDoc.php.

References msg().

Referenced by getParameterTable().

SMWSMWDoc::getFormatParameters

(

$

format

)

[protected]

Definition at line 204 of file SMW_SMWDoc.php.

References SMWQueryProcessor::getResultPrinter().

Referenced by render().

SMWSMWDoc::getMessage

(

)

See also:

ParserHook::getMessage()

Since:

1.6.1

Definition at line 218 of file SMW_SMWDoc.php.

SMWSMWDoc::msg

(

$

key

)

[protected]

Message function that takes into account the language parameter.

Since:

1.6.1

Parameters:

	string	$key
	array	$args

Returns:

string

Definition at line 232 of file SMW_SMWDoc.php.

Referenced by getDescriptionRow(), and getParameterTable().

---

Member Data Documentation

SMWSMWDoc::$language [protected]

Definition at line 24 of file SMW_SMWDoc.php.

---

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

• SemanticMediaWiki/includes/parserhooks/SMW_SMWDoc.php