MediaWiki
REL1_19
|
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) | |
getParsedSectionOrText ($titleObj, $popts, $pageId=null, $getWikitext=false) | |
getSectionText ($text, $what) | |
languagesHtml ($languages) | |
setIndexedTagNames (&$array, $mapping) | |
Private Attributes | |
$section |
Definition at line 28 of file ApiParse.php.
ApiParse::__construct | ( | $ | main, |
$ | action | ||
) |
Definition at line 31 of file ApiParse.php.
ApiParse::categoriesHtml | ( | $ | categories | ) | [private] |
Definition at line 376 of file ApiParse.php.
References ContextSource\$context, and ContextSource\getContext().
Referenced by 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, $page, $result, $text, $title, $wgLang, $wgParser, $wgTitle, categoriesHtml(), Revision\DELETED_TEXT, ApiBase\dieUsage(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), Language\factory(), Revision\FOR_THIS_USER, formatCategoryLinks(), Linker\formatComment(), formatCss(), formatHeadItems(), formatIWLinks(), formatLangLinks(), formatLinks(), ContextSource\getContext(), ApiBase\getMain(), ApiBase\getModuleName(), getParsedSectionOrText(), ApiBase\getResult(), getSectionText(), ContextSource\getUser(), languagesHtml(), ParserOptions\newFromContext(), Title\newFromID(), Title\newFromText(), and setIndexedTagNames().
ApiParse::formatCategoryLinks | ( | $ | links | ) | [private] |
Definition at line 365 of file ApiParse.php.
References $result, and ApiBase\getResult().
Referenced by execute().
ApiParse::formatCss | ( | $ | css | ) | [private] |
Definition at line 464 of file ApiParse.php.
References $file, $result, and ApiBase\getResult().
Referenced by execute().
ApiParse::formatHeadItems | ( | $ | headItems | ) | [private] |
Definition at line 453 of file ApiParse.php.
References $result, and ApiBase\getResult().
Referenced by execute().
ApiParse::formatIWLinks | ( | $ | iw | ) | [private] |
Definition at line 434 of file ApiParse.php.
References $result, $title, ApiBase\getResult(), Title\newFromText(), and wfExpandUrl().
Referenced by execute().
ApiParse::formatLangLinks | ( | $ | links | ) | [private] |
Definition at line 348 of file ApiParse.php.
References $result, $title, ApiBase\getResult(), Title\newFromText(), and wfExpandUrl().
Referenced by execute().
ApiParse::formatLinks | ( | $ | links | ) | [private] |
Definition at line 418 of file ApiParse.php.
References $result, $title, ApiBase\getResult(), and Title\makeTitle().
Referenced by execute().
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.
Reimplemented from ApiBase.
Definition at line 483 of file ApiParse.php.
References ApiBase\PARAM_DFLT, ApiBase\PARAM_ISMULTI, and ApiBase\PARAM_TYPE.
Returns the description string for this module.
Reimplemented from ApiBase.
Definition at line 571 of file ApiParse.php.
Returns usage examples for this module.
Return false if no examples are available.
Reimplemented from ApiBase.
Definition at line 588 of file ApiParse.php.
Reimplemented from ApiBase.
Definition at line 594 of file ApiParse.php.
Returns an array of parameter descriptions.
Don't call this functon directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.
Reimplemented from ApiBase.
Definition at line 528 of file ApiParse.php.
References ApiBase\getModulePrefix().
ApiParse::getParsedSectionOrText | ( | $ | titleObj, |
$ | popts, | ||
$ | pageId = null , |
||
$ | getWikitext = false |
||
) | [private] |
$titleObj | Title |
$popts | ParserOptions |
$pageId | Int |
$getWikitext | Bool |
Definition at line 316 of file ApiParse.php.
References $page, $wgParser, WikiPage\factory(), and getSectionText().
Referenced by execute().
Returns a list of all possible errors returned by the module.
Reimplemented from ApiBase.
Definition at line 575 of file ApiParse.php.
ApiParse::getSectionText | ( | $ | text, |
$ | what | ||
) | [private] |
Definition at line 338 of file ApiParse.php.
References $text, $wgParser, and ApiBase\dieUsage().
Referenced by execute(), and getParsedSectionOrText().
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
Reimplemented from ApiBase.
Definition at line 598 of file ApiParse.php.
ApiParse::languagesHtml | ( | $ | languages | ) | [private] |
$languages | array |
Definition at line 388 of file ApiParse.php.
References $languages, $text, $wgContLang, $wgHideInterlanguageLinks, Html\element(), Title\newFromText(), Html\rawElement(), wfDeprecated(), wfMsg(), and wfMsgExt().
Referenced by execute().
ApiParse::setIndexedTagNames | ( | &$ | array, |
$ | mapping | ||
) | [private] |
Definition at line 475 of file ApiParse.php.
References ApiBase\getResult().
Referenced by execute().
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().