Inheritance diagram for ApiParse:

Collaboration diagram for ApiParse:

Public Member Functions
	__construct ($main, $action)
	execute ()
	Evaluates the parameters, performs the requested query, and sets up the result.
	getAllowedParams ()
	Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.
	getDescription ()
	Returns the description string for this module.
	getExamples ()
	Returns usage examples for this module.
	getHelpUrls ()
	getParamDescription ()
	Returns an array of parameter descriptions.
	getPossibleErrors ()
	Returns a list of all possible errors returned by the module.
	getVersion ()
	Returns a string that identifies the version of the extending class.
Private Member Functions
	categoriesHtml ($categories)
	formatCategoryLinks ($links)
	formatCss ($css)
	formatHeadItems ($headItems)
	formatIWLinks ($iw)
	formatLangLinks ($links)
	formatLinks ($links)
	formatProperties ($properties)
	getParsedContent (WikiPage $page, $popts, $pageId=null, $getWikitext=false)
	getSectionContent (Content $content, $what)
	languagesHtml ($languages)
	setIndexedTagNames (&$array, $mapping)
Private Attributes
Content	$content = null
	$content *
Content	$pstContent = null
	$pstContent *
String	$section = null
	$section *

Detailed Description

Definition at line 28 of file ApiParse.php.

Constructor & Destructor Documentation

ApiParse::__construct	(	$	main,
		$	action
	)

Definition at line 36 of file ApiParse.php.

Member Function Documentation

ApiParse::categoriesHtml ( $ categories ) [private]

Definition at line 421 of file ApiParse.php.

ApiParse::execute ( )

Evaluates the parameters, performs the requested query, and sets up the result.

Concrete implementations of ApiBase must override this method to provide whatever functionality their module offers. Implementations must not produce any output on their own and are not expected to handle any errors.

The execute() method will be invoked directly by ApiMain immediately before the result of the module is output. Aside from the constructor, implementations should assume that no other methods will be called externally on the module before the result is processed.

The result data should be stored in the ApiResult object available through getResult().

Reimplemented from ApiBase.

Definition at line 40 of file ApiParse.php.

ApiParse::formatCategoryLinks ( $ links ) [private]

Definition at line 410 of file ApiParse.php.

ApiParse::formatCss ( $ css ) [private]

Definition at line 520 of file ApiParse.php.

ApiParse::formatHeadItems ( $ headItems ) [private]

Definition at line 498 of file ApiParse.php.

ApiParse::formatIWLinks ( $ iw ) [private]

Definition at line 479 of file ApiParse.php.

ApiParse::formatLangLinks ( $ links ) [private]

Definition at line 393 of file ApiParse.php.

ApiParse::formatLinks ( $ links ) [private]

Definition at line 463 of file ApiParse.php.

ApiParse::formatProperties ( $ properties ) [private]

Definition at line 509 of file ApiParse.php.

ApiParse::getAllowedParams ( )

Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.

Returns:: array|bool

Reimplemented from ApiBase.

Definition at line 539 of file ApiParse.php.

ApiParse::getDescription ( )

Returns the description string for this module.

Returns:: mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 639 of file ApiParse.php.

ApiParse::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: bool|string|array

Reimplemented from ApiBase.

Definition at line 662 of file ApiParse.php.

ApiParse::getHelpUrls ( )

Returns:: bool|string|array Returns a false if the module has no help url, else returns a (array of) string

Reimplemented from ApiBase.

Definition at line 668 of file ApiParse.php.

ApiParse::getParamDescription ( )

Returns an array of parameter descriptions.

Don't call this functon directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.

Returns:: array|bool False on no parameter descriptions

Reimplemented from ApiBase.

Definition at line 592 of file ApiParse.php.

ApiParse::getParsedContent	(	WikiPage $	page,
		$	popts,
		$	pageId = `null`,
		$	getWikitext = `false`
	)		`[private]`

Parameters:

$page	WikiPage
$popts	ParserOptions
$pageId	Int
$getWikitext	Bool

Returns:: ParserOutput

Definition at line 356 of file ApiParse.php.

ApiParse::getPossibleErrors ( )

Returns a list of all possible errors returned by the module.

Returns:: array in the format of array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )

Reimplemented from ApiBase.

Definition at line 646 of file ApiParse.php.

ApiParse::getSectionContent	(	Content $	content,
		$	what
	)		`[private]`

Definition at line 380 of file ApiParse.php.

ApiParse::getVersion ( )

Returns a string that identifies the version of the extending class.

Typically includes the class name, the svn revision, timestamp, and last author. Usually done with SVN's Id keyword

Returns:: string

Reimplemented from ApiBase.

Definition at line 672 of file ApiParse.php.

ApiParse::languagesHtml ( $ languages ) [private]

Deprecated:: since 1.18 No modern skin generates language links this way, please use language links data to generate your own HTML.

Parameters:

$languages array

Returns:: string

Definition at line 433 of file ApiParse.php.

ApiParse::setIndexedTagNames	(	&$	array,
		$	mapping
	)		`[private]`

Definition at line 531 of file ApiParse.php.

Member Data Documentation

Content ApiParse::$content = null [private]

$content *

Definition at line 32 of file ApiParse.php.

Content ApiParse::$pstContent = null [private]

$pstContent *

Definition at line 34 of file ApiParse.php.

String ApiParse::$section = null [private]

$section *

Definition at line 30 of file ApiParse.php.

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

includes/api/ApiParse.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation