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.
Public Attributes
	$pstText = null
	$text
Private Member Functions
	categoriesHtml ($categories)
	formatCategoryLinks ($links)
	formatCss ($css)
	formatHeadItems ($headItems)
	formatIWLinks ($iw)
	formatLangLinks ($links)
	formatLinks ($links)
	formatProperties ($properties)
	getParsedSectionOrText ($page, $popts, $pageId=null, $getWikitext=false)
	getSectionText ($text, $what)
	languagesHtml ($languages)
	setIndexedTagNames (&$array, $mapping)
Private Attributes
	$section

Detailed Description

Definition at line 28 of file ApiParse.php.

Constructor & Destructor Documentation

ApiParse::__construct	(	$	main,
		$	action
	)

Definition at line 31 of file ApiParse.php.

Member Function Documentation

ApiParse::categoriesHtml ( $ categories ) [private]

Definition at line 389 of file ApiParse.php.

References ContextSource\$context, ContextSource\getContext(), IContextSource\getOutput(), and IContextSource\getSkin().

Referenced by execute().

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 35 of file ApiParse.php.

References ContextSource\$context, $css, $page, $params, $result, $text, $title, $wgParser, $wgTitle, categoriesHtml(), Revision\DELETED_TEXT, ApiBase\dieUsage(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), WikiPage\factory(), Language\factory(), Revision\FOR_THIS_USER, formatCategoryLinks(), Linker\formatComment(), formatCss(), formatHeadItems(), formatIWLinks(), formatLangLinks(), formatLinks(), formatProperties(), ContextSource\getContext(), ContextSource\getLanguage(), ApiBase\getMain(), ApiBase\getModuleName(), IContextSource\getOutput(), getParsedSectionOrText(), ApiBase\getResult(), getSectionText(), IContextSource\getSkin(), ApiBase\getTitleOrPageId(), ContextSource\getUser(), languagesHtml(), Title\newFromText(), and setIndexedTagNames().

ApiParse::formatCategoryLinks ( $ links ) [private]

Definition at line 378 of file ApiParse.php.

References $result, and ApiBase\getResult().

Referenced by execute().

ApiParse::formatCss ( $ css ) [private]

Definition at line 488 of file ApiParse.php.

References $css, $file, $result, and ApiBase\getResult().

Referenced by execute().

ApiParse::formatHeadItems ( $ headItems ) [private]

Definition at line 466 of file ApiParse.php.

References $result, and ApiBase\getResult().

Referenced by execute().

ApiParse::formatIWLinks ( $ iw ) [private]

Definition at line 447 of file ApiParse.php.

References $result, $title, ApiBase\getResult(), Title\newFromText(), and wfExpandUrl().

Referenced by execute().

ApiParse::formatLangLinks ( $ links ) [private]

Definition at line 361 of file ApiParse.php.

References $result, $title, ApiBase\getResult(), Title\newFromText(), and wfExpandUrl().

Referenced by execute().

ApiParse::formatLinks ( $ links ) [private]

Definition at line 431 of file ApiParse.php.

References $result, $title, ApiBase\getResult(), and Title\makeTitle().

Referenced by execute().

ApiParse::formatProperties ( $ properties ) [private]

Definition at line 477 of file ApiParse.php.

References $result, $value, and ApiBase\getResult().

Referenced by execute().

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 507 of file ApiParse.php.

References ApiBase\PARAM_DFLT, ApiBase\PARAM_ISMULTI, and ApiBase\PARAM_TYPE.

ApiParse::getDescription ( )

Returns the description string for this module.

Returns:: mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 599 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 619 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 625 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 554 of file ApiParse.php.

References ApiBase\getModulePrefix().

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

Parameters:

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

Returns:: ParserOutput

Definition at line 328 of file ApiParse.php.

References $page, $wgParser, ApiBase\dieUsage(), and getSectionText().

Referenced by execute().

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 606 of file ApiParse.php.

ApiParse::getSectionText	(	$	text,
		$	what
	)		`[private]`

Definition at line 351 of file ApiParse.php.

References $text, $wgParser, and ApiBase\dieUsage().

Referenced by execute(), and getParsedSectionOrText().

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 629 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 401 of file ApiParse.php.

References $languages, $s, $text, $wgContLang, Html\element(), Language\fetchLanguageName(), Title\newFromText(), Html\rawElement(), wfDeprecated(), and wfMessage().

Referenced by execute().

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

Definition at line 499 of file ApiParse.php.

References ApiBase\getResult().

Referenced by execute().

Member Data Documentation

ApiParse::$pstText = null

Definition at line 29 of file ApiParse.php.

ApiParse::$section [private]

Definition at line 29 of file ApiParse.php.

ApiParse::$text

Definition at line 29 of file ApiParse.php.

Referenced by execute(), getSectionText(), and languagesHtml().

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

includes/api/ApiParse.php

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation