Inheritance diagram for ApiParse:

[legend]

Collaboration diagram for ApiParse:

[legend]

Public Member Functions
	execute ()
	Evaluates the parameters, performs the requested query, and sets up the result. More...

	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. More...

	getDescription ()
	Returns the description string for this module. More...

	getExamples ()
	Returns usage examples for this module. More...

	getHelpUrls ()

	getParamDescription ()
	Returns an array of parameter descriptions. More...

	getPossibleErrors ()
	Returns a list of all possible errors returned by the module. More...

Public Member Functions inherited from ApiBase
	__construct ( $mainModule, $moduleName, $modulePrefix='')
	Constructor. More...

	createContext ()
	Create a new RequestContext object to use e.g. More...

	dieReadOnly ()
	Helper function for readonly errors. More...

	dieStatus ( $status)
	Throw a UsageException based on the errors in the Status object. More...

	dieUsage ( $description, $errorCode, $httpRespCode=0, $extradata=null)
	Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an error message. More...

	dieUsageMsg ( $error)
	Output the error message related to a certain array. More...

	dieUsageMsgOrDebug ( $error)
	Will only set a warning instead of failing if the global $wgDebugAPI is set to true. More...

	encodeParamName ( $paramName)
	This method mangles parameter name based on the prefix supplied to the constructor. More...

	extractRequestParams ( $parseLimit=true)
	Using getAllowedParams(), this function makes an array of the values provided by the user, with key being the name of the variable, and value - validated value from user or default. More...

	getCustomPrinter ()
	If the module may only be used with a certain format module, it should override this method to return an instance of that formatter. More...

	getErrorFromStatus ( $status)
	Get error (as code, string) from a Status object. More...

	getFinalDescription ()
	Get final module description, after hooks have had a chance to tweak it as needed. More...

	getFinalParamDescription ()
	Get final parameter descriptions, after hooks have had a chance to tweak it as needed. More...

	getFinalParams ( $flags=0)
	Get final list of parameters, after hooks have had a chance to tweak it as needed. More...

	getFinalPossibleErrors ()
	Get final list of possible errors, after hooks have had a chance to tweak it as needed. More...

	getFinalResultProperties ()
	Get final possible result properties, after hooks have had a chance to tweak it as needed. More...

	getMain ()
	Get the main module. More...

	getModuleManager ()
	Get the module manager, or null if this module has no sub-modules. More...

	getModuleName ()
	Get the name of the module being executed by this instance. More...

	getModulePrefix ()
	Get parameter prefix (usually two letters or an empty string). More...

	getModuleProfileName ( $db=false)
	Get the name of the module as shown in the profiler log. More...

	getProfileDBTime ()
	Total time the module used the database. More...

	getProfileTime ()
	Total time the module was executed. More...

	getRequireAtLeastOneParameterErrorMessages ( $params)
	Generates the possible errors requireAtLeastOneParameter() can die with. More...

	getRequireMaxOneParameterErrorMessages ( $params)
	Generates the possible error requireMaxOneParameter() can die with. More...

	getRequireOnlyOneParameterErrorMessages ( $params)
	Generates the possible errors requireOnlyOneParameter() can die with. More...

	getResult ()
	Get the result object. More...

	getResultData ()
	Get the result data array (read-only) More...

	getTitleOrPageId ( $params, $load=false)

	getTitleOrPageIdErrorMessage ()

	getTokenSalt ()
	Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the module doesn't need a token You have also to override needsToken() Value is passed to User::getEditToken. More...

	getVersion ()
	Returns a string that identifies the version of the extending class. More...

	getWatchlistUser ( $params)
	Gets the user for whom to get the watchlist. More...

	isMain ()
	Returns true if this module is the main module ($this === $this->mMainModule), false otherwise. More...

	isReadMode ()
	Indicates whether this module requires read rights. More...

	isWriteMode ()
	Indicates whether this module requires write mode. More...

	makeHelpMsg ()
	Generates help message for this module, or false if there is no description. More...

	makeHelpMsgParameters ()
	Generates the parameter descriptions for this module, to be displayed in the module's help. More...

	mustBePosted ()
	Indicates whether this module must be called with a POST request. More...

	needsToken ()
	Returns whether this module requires a token to execute It is used to show possible errors in action=paraminfo see bug 25248. More...

	parseErrors ( $errors)
	Parses a list of errors into a standardised format. More...

	parseMsg ( $error)
	Return the error message related to a certain array. More...

	profileDBIn ()
	Start module profiling. More...

	profileDBOut ()
	End database profiling. More...

	profileIn ()
	Start module profiling. More...

	profileOut ()
	End module profiling. More...

	requireAtLeastOneParameter ( $params)
	Die if none of a certain set of parameters is set and not false. More...

	requireMaxOneParameter ( $params)
	Die if more than one of a certain set of parameters is set and not false. More...

	requireOnlyOneParameter ( $params)
	Die if none or more than one of a certain set of parameters is set and not false. More...

	safeProfileOut ()
	When modules crash, sometimes it is needed to do a profileOut() regardless of the profiling state the module was in. More...

	setWarning ( $warning)
	Set warning section for this module. More...

	shouldCheckMaxlag ()
	Indicates if this module needs maxlag to be checked. More...

	validateLimit ( $paramName, &$value, $min, $max, $botMax=null, $enforceLimits=false)
	Validate the value against the minimum and user/bot maximum limits. More...

	validateTimestamp ( $value, $encParamName)
	Validate and normalize of parameters of type 'timestamp'. More...

Public Member Functions inherited from ContextSource
	canUseWikiPage ()
	Check whether a WikiPage object can be get with getWikiPage(). More...

	exportSession ()
	Export the resolved user IP, HTTP headers, user ID, and session ID. More...

	getConfig ()
	Get the Config object. More...

	getContext ()
	Get the RequestContext object. More...

	getLang ()
	Get the Language object. More...

	getLanguage ()
	Get the Language object. More...

	getOutput ()
	Get the OutputPage object. More...

	getRequest ()
	Get the WebRequest object. More...

	getSkin ()
	Get the Skin object. More...

	getTitle ()
	Get the Title object. More...

	getUser ()
	Get the User object. More...

	getWikiPage ()
	Get the WikiPage object. More...

	msg ()
	Get a Message object with context set Parameters are the same as wfMessage() More...

	setContext (IContextSource $context)
	Set the IContextSource object. More...

Protected Member Functions
	makeParserOptions (WikiPage $pageObj, array $params)
	Constructs a ParserOptions object. More...

Protected Member Functions inherited from ApiBase
	dieContinueUsageIf ( $condition)
	Die with the $prefix. More...

	getDB ()
	Gets a default slave database connection object. More...

	getParameter ( $paramName, $parseLimit=true)
	Get a value for the given parameter. More...

	getParameterFromSettings ( $paramName, $paramSettings, $parseLimit)
	Using the settings determine the value for the given parameter. More...

	getResultProperties ()
	Returns possible properties in the result, grouped by the value of the prop parameter that shows them. More...

	getWatchlistValue ( $watchlist, $titleObj, $userOption=null)
	Return true if we're to watch the page, false if not, null if no change. More...

	makeHelpArrayToString ( $prefix, $title, $input)

	parseMultiValue ( $valueName, $value, $allowMultiple, $allowedValues)
	Return an array of values that were given in a 'a\|b\|c' notation, after it optionally validates them against the list allowed values. More...

	setWatch ( $watch, $titleObj, $userOption=null)
	Set a watch (or unwatch) based the based on a watchlist parameter. More...

Private Member Functions
	categoriesHtml ( $categories)

	formatCategoryLinks ( $links)

	formatCss ( $css)

	formatHeadItems ( $headItems)

	formatIWLinks ( $iw)

	formatLangLinks ( $links)

	formatLimitReportData ( $limitReportData)

	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 * More...

Content	$pstContent = null
	$pstContent * More...

String	$section = null
	$section * More...

Additional Inherited Members
Static Public Member Functions inherited from ApiBase
static	debugPrint ( $value, $name='unknown', $backtrace=false)
	Debugging function that prints a value and an optional backtrace. More...

static	truncateArray (&$arr, $limit)
	Truncate an array to a certain length. More...

Public Attributes inherited from ApiBase
	$mDBTime = 0

	$mModuleName

	$mModulePrefix

	$mModuleTime = 0

const	GET_VALUES_FOR_HELP = 1
	getAllowedParams() flag: When set, the result could take longer to generate, but should be more thorough. More...

const	LIMIT_BIG1 = 500

const	LIMIT_BIG2 = 5000

const	LIMIT_SML1 = 50

const	LIMIT_SML2 = 500

const	PARAM_ALLOW_DUPLICATES = 6

const	PARAM_DEPRECATED = 7

const	PARAM_DFLT = 0

const	PARAM_ISMULTI = 1

const	PARAM_MAX = 3

const	PARAM_MAX2 = 4

const	PARAM_MIN = 5

const	PARAM_RANGE_ENFORCE = 9

const	PARAM_REQUIRED = 8

const	PARAM_TYPE = 2

const	PROP_LIST = 'LIST'

const	PROP_NULLABLE = 1

const	PROP_ROOT = 'ROOT'

const	PROP_TYPE = 0

Static Public Attributes inherited from ApiBase
static	$messageMap
	Array that maps message keys to error messages. More...

Static Protected Member Functions inherited from ApiBase
static	addTokenProperties (&$props, $tokenFunctions)
	Add token properties to the array used by getResultProperties, based on a token functions mapping. More...

static	dieDebug ( $method, $message)
	Internal code errors should be reported with this method. More...

Detailed Description

Definition at line 28 of file ApiParse.php.

Member Function Documentation

◆ categoriesHtml()

ApiParse::categoriesHtml ( $categories )

private

Definition at line 539 of file ApiParse.php.

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

Referenced by execute().

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

References $article, ContextSource\$context, $css, $params, $rev, $title, $wgParser, $wgTitle, array(), as, categoriesHtml(), content, CONTENT_MODEL_WIKITEXT, Revision\DELETED_TEXT, ApiBase\dieUsage(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), WikiPage\factory(), Language\factory(), Revision\FOR_THIS_USER, formatCategoryLinks(), Linker\formatComment(), formatCss(), formatHeadItems(), formatIWLinks(), formatLangLinks(), formatLimitReportData(), formatLinks(), formatProperties(), ContextSource\getContext(), ContextSource\getLanguage(), ApiBase\getMain(), ApiBase\getModuleName(), IContextSource\getOutput(), getParsedContent(), ApiBase\getResult(), getSectionContent(), IContextSource\getSkin(), ApiBase\getTitleOrPageId(), ContextSource\getUser(), global, languagesHtml(), ContentHandler\makeContent(), makeParserOptions(), Title\newFromText(), Article\newFromTitle(), OT_PREPROCESS, section, ApiResult\setContent(), setIndexedTagNames(), ApiBase\setWarning(), and wfRunHooks().

◆ formatCategoryLinks()

ApiParse::formatCategoryLinks ( $links )

private

Definition at line 499 of file ApiParse.php.

References $lb, $link, $res, array(), as, ApiBase\getDB(), NS_CATEGORY, and ApiResult\setContent().

Referenced by execute().

◆ formatCss()

ApiParse::formatCss ( $css )

private

Definition at line 647 of file ApiParse.php.

References $css, $file, $link, array(), as, and ApiResult\setContent().

Referenced by execute().

◆ formatHeadItems()

ApiParse::formatHeadItems ( $headItems )

private

Definition at line 623 of file ApiParse.php.

References $content, array(), as, and ApiResult\setContent().

Referenced by execute().

◆ formatIWLinks()

ApiParse::formatIWLinks ( $iw )

private

Definition at line 603 of file ApiParse.php.

References $title, $titles, array(), as, Title\newFromText(), PROTO_CURRENT, ApiResult\setContent(), and wfExpandUrl().

Referenced by execute().

◆ formatLangLinks()

ApiParse::formatLangLinks ( $links )

private

Definition at line 477 of file ApiParse.php.

References $link, $title, array(), as, Language\fetchLanguageName(), ContextSource\getLanguage(), Title\newFromText(), PROTO_CURRENT, ApiResult\setContent(), and wfExpandUrl().

Referenced by execute().

◆ formatLimitReportData()

ApiParse::formatLimitReportData ( $limitReportData )

private

Definition at line 659 of file ApiParse.php.

References $name, $value, array(), as, and ApiBase\getResult().

Referenced by execute().

◆ formatLinks()

ApiParse::formatLinks ( $links )

private

Definition at line 586 of file ApiParse.php.

References $title, array(), as, Title\makeTitle(), and ApiResult\setContent().

Referenced by execute().

◆ formatProperties()

ApiParse::formatProperties ( $properties )

private

Definition at line 635 of file ApiParse.php.

References $name, $value, array(), as, and ApiResult\setContent().

Referenced by execute().

◆ getAllowedParams()

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.

Some derived classes may choose to handle an integer $flags parameter in the overriding methods. Callers of this method can pass zero or more OR-ed flags like GET_VALUES_FOR_HELP.

Returns: array|bool

Reimplemented from ApiBase.

Definition at line 686 of file ApiParse.php.

References array(), ContentHandler\getAllContentFormats(), ContentHandler\getContentModels(), ApiBase\PARAM_DFLT, ApiBase\PARAM_ISMULTI, and ApiBase\PARAM_TYPE.

◆ getDescription()

ApiParse::getDescription ( )

Returns the description string for this module.

Returns: mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 814 of file ApiParse.php.

References array(), and ApiBase\getModulePrefix().

◆ getExamples()

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

References array().

◆ getHelpUrls()

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

◆ getParamDescription()

ApiParse::getParamDescription ( )

Returns an array of parameter descriptions.

Don't call this function 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 744 of file ApiParse.php.

References array(), CONTENT_MODEL_WIKITEXT, and ApiBase\getModulePrefix().

◆ getParsedContent()

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

private

Parameters

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

Returns: ParserOutput

Definition at line 437 of file ApiParse.php.

References content, ApiBase\dieUsage(), WikiPage\getContent(), WikiPage\getParserOutput(), getSectionContent(), WikiPage\getTitle(), Revision\RAW, and section.

Referenced by execute().

◆ getPossibleErrors()

ApiParse::getPossibleErrors ( )

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

Don't call this function directly: use getFinalPossibleErrors() to allow hooks to modify parameters as needed.

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

Reimplemented from ApiBase.

Definition at line 828 of file ApiParse.php.

References array().

◆ getSectionContent()

ApiParse::getSectionContent	(	Content	$content,
			$what
	)

private

Definition at line 463 of file ApiParse.php.

References $content, $section, ApiBase\dieUsage(), Content\getSection(), and section.

Referenced by execute(), and getParsedContent().

◆ languagesHtml()

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

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

Referenced by execute().

◆ makeParserOptions()

ApiParse::makeParserOptions	(	WikiPage	$pageObj,
		array	$params
	)

protected

Constructs a ParserOptions object.

Parameters

WikiPage	$pageObj
array	$params

Returns: ParserOptions

Definition at line 417 of file ApiParse.php.

References $params, ContextSource\getContext(), WikiPage\makeParserOptions(), wfProfileIn(), and wfProfileOut().

Referenced by execute().

◆ setIndexedTagNames()

ApiParse::setIndexedTagNames	(	&	$array,
			$mapping
	)

private

Definition at line 678 of file ApiParse.php.

References $name, as, and ApiBase\getResult().

Referenced by execute().

Member Data Documentation

◆ $content

Content ApiParse::$content = null

private

$content *

Definition at line 32 of file ApiParse.php.

Referenced by formatHeadItems(), and getSectionContent().

◆ $pstContent

Content ApiParse::$pstContent = null

private

$pstContent *

Definition at line 34 of file ApiParse.php.

◆ $section

String ApiParse::$section = null

private

$section *

Definition at line 30 of file ApiParse.php.

Referenced by getSectionContent().

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

includes/api/ApiParse.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ categoriesHtml()

◆ execute()

◆ formatCategoryLinks()

◆ formatCss()

◆ formatHeadItems()

◆ formatIWLinks()

◆ formatLangLinks()

◆ formatLimitReportData()

◆ formatLinks()

◆ formatProperties()

◆ getAllowedParams()

◆ getDescription()

◆ getExamples()

◆ getHelpUrls()

◆ getParamDescription()

◆ getParsedContent()

◆ getPossibleErrors()

◆ getSectionContent()

◆ languagesHtml()

◆ makeParserOptions()

◆ setIndexedTagNames()

Member Data Documentation

◆ $content

◆ $pstContent

◆ $section