Class to output help for an API module. More...

Inheritance diagram for ApiHelp:

[legend]

Collaboration diagram for ApiHelp:

[legend]

Public Member Functions
	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.

	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.

	getHelpUrls ()
	Return links to more detailed help pages about the module.

	isReadMode ()
	Indicates whether this module requires read rights.

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

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

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

	isWriteMode ()
	Indicates whether this module requires write mode.

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

	isDeprecated ()
	Indicates whether this module is deprecated.

	isInternal ()
	Indicates whether this module is "internal" Internal API modules are not (yet) intended for 3rd party use and may be unstable.

	needsToken ()
	Returns the token type this module requires in order to execute.

	getConditionalRequestData ( $condition)
	Returns data for HTTP conditional request mechanisms.

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

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

	getMain ()
	Get the main module.

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

	getParent ()
	Get the parent of this module.

	lacksSameOriginSecurity ()
	Returns true if the current request breaks the same-origin policy.

	getModulePath ()
	Get the path to this module.

	getModuleFromPath ( $path)
	Get a module from its module path.

	getResult ()
	Get the result object.

	getErrorFormatter ()
	Get the error formatter.

	getContinuationManager ()
	Get the continuation manager.

	setContinuationManager (ApiContinuationManager $manager=null)
	Set the continuation manager.

	dynamicParameterDocumentation ()
	Indicate if the module supports dynamically-determined parameters that cannot be included in self::getAllowedParams().

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

	extractRequestParams ( $options=[])
	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.

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

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

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

	requirePostedParameters ( $params, $prefix='prefix')
	Die if any of the specified parameters were found in the query part of the URL rather than the post body.

	getTitleOrPageId ( $params, $load=false)
	Get a WikiPage object from a title or pageid param, if possible.

	getTitleFromTitleOrPageId ( $params)
	Get a Title object from a title or pageid param, if possible.

	validateToken ( $token, array $params)
	Validate the supplied token.

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

	errorArrayToStatus (array $errors, User $user=null)
	Turn an array of message keys or key+param arrays into a Status.

	addWarning ( $msg, $code=null, $data=null)
	Add a warning for this module.

	addDeprecation ( $msg, $feature, $data=[])
	Add a deprecation warning for this module.

	addError ( $msg, $code=null, $data=null)
	Add an error for this module without aborting.

	addMessagesFromStatus (StatusValue $status, $types=[ 'warning', 'error'], array $filter=[])
	Add warnings and/or errors from a Status.

	dieWithError ( $msg, $code=null, $data=null, $httpCode=null)
	Abort execution with an error.

	dieWithException ( $exception, array $options=[])
	Abort execution with an error derived from an exception.

	dieBlocked (Block $block)
	Throw an ApiUsageException, which will (if uncaught) call the main module's error handler and die with an error message including block info.

	dieStatus (StatusValue $status)
	Throw an ApiUsageException based on the Status object.

	dieReadOnly ()
	Helper function for readonly errors.

	checkUserRightsAny ( $rights, $user=null)
	Helper function for permission-denied errors.

	checkTitleUserPermissions (Title $title, $actions, $user=null)
	Helper function for permission-denied errors.

	dieWithErrorOrDebug ( $msg, $code=null, $data=null, $httpCode=null)
	Will only set a warning instead of failing if the global $wgDebugAPI is set to true.

	logFeatureUsage ( $feature)
	Write logging information for API features to a debug log, for usage analysis.

	getFinalSummary ()
	Get final module summary.

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

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

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

	modifyHelp (array &$help, array $options, array &$tocData)
	Called from ApiHelp before the pieces are joined together and returned.

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

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

	getConfig ()

	getContext ()
	Get the base IContextSource object.

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getStats ()

	getTiming ()

	getTitle ()

	getUser ()

	getWikiPage ()
	Get the WikiPage object.

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

	setContext (IContextSource $context)

Static Public Member Functions
static	fixHelpLinks ( $html, $helptitle=null, $localModules=[])
	Replace Special:ApiHelp links with links to api.php.

static	getHelp (IContextSource $context, $modules, array $options)
	Generate help for the specified modules.

Static Public Member Functions inherited from ApiBase
static	makeMessage ( $msg, IContextSource $context, array $params=null)
	Create a Message from a string or array.

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

Protected Member Functions
	getExamplesMessages ()
	Returns usage examples for this module.

Protected Member Functions inherited from ApiBase
	getWebUITokenSalt (array $params)
	Fetch the salt used in the Web UI corresponding to this module.

	getDB ()
	Gets a default replica DB connection object.

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

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

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

	handleParamNormalization ( $paramName, $value, $rawValue)
	Handle when a parameter was Unicode-normalized.

	explodeMultiValue ( $value, $limit)
	Split a multi-valued parameter string, like explode()

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

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

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

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

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

	dieContinueUsageIf ( $condition)
	Die with the 'badcontinue' error.

	getSummaryMessage ()
	Return the summary message.

	getExtendedDescription ()
	Return the extended help text message.

	getHelpFlags ()
	Generates the list of flags for the help screen and for action=paraminfo.

	getModuleSourceInfo ()
	Returns information about the source of this module, if known.

	getDescription ()
	Returns the description string for this module.

	getParamDescription ()
	Returns an array of parameter descriptions.

	getExamples ()
	Returns usage examples for this module.

	getDescriptionMessage ()
	Return the description message.

Static Private Member Functions
static	getHelpInternal (IContextSource $context, array $modules, array $options, &$haveModules)
	Recursively-called function to actually construct the help.

static	wrap (Message $msg, $class, $tag='span')
	Wrap a message in HTML with a class.

Additional Inherited Members
Public Attributes inherited from ApiBase
const	ALL_DEFAULT_STRING = '*'

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

const	LIMIT_BIG1 = 500
	Fast query, standard limit.

const	LIMIT_BIG2 = 5000
	Fast query, apihighlimits limit.

const	LIMIT_SML1 = 50
	Slow query, standard limit.

const	LIMIT_SML2 = 500
	Slow query, apihighlimits limit.

const	PARAM_DFLT = 0
	(null\|boolean\|integer\|string) Default value of the parameter.

const	PARAM_ISMULTI = 1
	(boolean) Accept multiple pipe-separated values for this parameter (e.g.

const	PARAM_TYPE = 2
	(string\|string[]) Either an array of allowed value strings, or a string type as described below.

const	PARAM_MAX = 3
	(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.

const	PARAM_MAX2 = 4
	(integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE 'limit'.

const	PARAM_MIN = 5
	(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.

const	PARAM_ALLOW_DUPLICATES = 6
	(boolean) Allow the same value to be set more than once when PARAM_ISMULTI is true?

const	PARAM_DEPRECATED = 7
	(boolean) Is the parameter deprecated (will show a warning)?

const	PARAM_REQUIRED = 8
	(boolean) Is the parameter required?

const	PARAM_RANGE_ENFORCE = 9
	(boolean) For PARAM_TYPE 'integer', enforce PARAM_MIN and PARAM_MAX?

const	PARAM_HELP_MSG = 10
	(string\|array\|Message) Specify an alternative i18n documentation message for this parameter.

const	PARAM_HELP_MSG_APPEND = 11
	((string\|array\|Message)[]) Specify additional i18n messages to append to the normal message for this parameter.

const	PARAM_HELP_MSG_INFO = 12
	(array) Specify additional information tags for the parameter.

const	PARAM_VALUE_LINKS = 13
	(string[]) When PARAM_TYPE is an array, this may be an array mapping those values to page titles which will be linked in the help.

const	PARAM_HELP_MSG_PER_VALUE = 14
	((string\|array\|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg for ApiBase::makeMessage().

const	PARAM_SUBMODULE_MAP = 15
	(string[]) When PARAM_TYPE is 'submodule', map parameter values to submodule paths.

const	PARAM_SUBMODULE_PARAM_PREFIX = 16
	(string) When PARAM_TYPE is 'submodule', used to indicate the 'g' prefix added by ApiQueryGeneratorBase (and similar if anything else ever does that).

const	PARAM_ALL = 17
	(boolean\|string) When PARAM_TYPE has a defined set of values and PARAM_ISMULTI is true, this allows for an asterisk ('*') to be passed in place of a pipe-separated list of every possible value.

const	PARAM_EXTRA_NAMESPACES = 18
	(int[]) When PARAM_TYPE is 'namespace', include these as additional possible values.

const	PARAM_SENSITIVE = 19
	(boolean) Is the parameter sensitive? Note 'password'-type fields are always sensitive regardless of the value of this field.

const	PARAM_DEPRECATED_VALUES = 20
	(array) When PARAM_TYPE is an array, this indicates which of the values are deprecated.

const	PARAM_ISMULTI_LIMIT1 = 21
	(integer) Maximum number of values, for normal users.

const	PARAM_ISMULTI_LIMIT2 = 22
	(integer) Maximum number of values, for users with the apihighimits right.

const	PARAM_MAX_BYTES = 23
	(integer) Maximum length of a string in bytes (in UTF-8 encoding).

const	PARAM_MAX_CHARS = 24
	(integer) Maximum length of a string in characters (unicode codepoints).

const	PARAM_TEMPLATE_VARS = 25
	(array) Indicate that this is a templated parameter, and specify replacements.

Static Protected Member Functions inherited from ApiBase
static	dieDebug ( $method, $message)
	Internal code errors should be reported with this method.

Detailed Description

Class to output help for an API module.

Since: 1.25 completely rewritten

Definition at line 32 of file ApiHelp.php.

Member Function Documentation

◆ execute()

ApiHelp::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 33 of file ApiHelp.php.

References ContextSource\$context, $html, $modules, $out, $params, $path, as, ApiBase\extractRequestParams(), ContextSource\getContext(), getHelp(), ContextSource\getLanguage(), ApiBase\getMain(), ApiBase\getModuleFromPath(), ApiBase\getModuleName(), IContextSource\getOutput(), ApiBase\getResult(), ApiResult\NO_SIZE_CHECK, and ApiResult\setSubelementsList().

◆ fixHelpLinks()

static ApiHelp::fixHelpLinks	(	$html,
		$helptitle = `null`,
		$localModules = `[]`
	)

static

Replace Special:ApiHelp links with links to api.php.

Parameters

string	$html
string \| null	$helptitle	Title to link to rather than api.php, must contain '$1'
array	$localModules	Keys are modules to link within the current page, values are ignored

Returns: string

Definition at line 172 of file ApiHelp.php.

References $html, as, wfAppendQuery(), and wfScript().

Referenced by ApiFormatBase\closePrinter(), and getHelp().

◆ getAllowedParams()

ApiHelp::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

Reimplemented from ApiBase.

Definition at line 874 of file ApiHelp.php.

References ApiBase\PARAM_DFLT, and ApiBase\PARAM_ISMULTI.

◆ getCustomPrinter()

ApiHelp::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.

A value of null means the default format will be used.

Note: Do not use this just because you don't want to support non-json formats. This should be used only when there is a fundamental requirement for a specific format.

Returns: mixed Instance of a derived class of ApiFormatBase, or null

Reimplemented from ApiBase.

Definition at line 863 of file ApiHelp.php.

References $params, ApiBase\extractRequestParams(), and ApiBase\getMain().

◆ getExamplesMessages()

ApiHelp::getExamplesMessages ( )

protected

Returns usage examples for this module.

Return value has query strings as keys, with values being either strings (message key), arrays (message key + parameter), or Message objects.

Do not call this base class implementation when overriding this method.

Since: 1.25

Returns: array

Reimplemented from ApiBase.

Definition at line 887 of file ApiHelp.php.

◆ getHelp()

static ApiHelp::getHelp	(	IContextSource	$context,
			$modules,
		array	$options
	)

static

Generate help for the specified modules.

Help is placed into the OutputPage object returned by $context->getOutput().

Recognized options include:

headerlevel: (int) Header tag level
nolead: (bool) Skip the inclusion of api-help-lead
noheader: (bool) Skip the inclusion of the top-level section headers
submodules: (bool) Include help for submodules of the current module
recursivesubmodules: (bool) Include help for submodules recursively
helptitle: (string) Title to link for additional modules' help. Should contain $1.
toc: (bool) Include a table of contents

Parameters

IContextSource	$context
ApiBase[] \| ApiBase	$modules
array	$options	Formatting options (described above)

Definition at line 94 of file ApiHelp.php.

References $cache, ContextSource\$context, $html, $modules, $options, $out, $services, fixHelpLinks(), Linker\generateTOC(), IContextSource\getConfig(), getHelpInternal(), IContextSource\getLanguage(), ApiBase\getModulePath(), IContextSource\getOutput(), SpecialVersion\getVersion(), and MessageLocalizer\msg().

Referenced by SpecialApiHelp\execute(), and execute().

◆ getHelpInternal()

static ApiHelp::getHelpInternal	(	IContextSource	$context,
		array	$modules,
		array	$options,
		&	$haveModules
	)

staticprivate

Recursively-called function to actually construct the help.

Parameters

IContextSource	$context
ApiBase[]	$modules
array	$options
array	&$haveModules

Returns: string

Definition at line 226 of file ApiHelp.php.

References ContextSource\$context, $help, $link, $modules, $name, $namespaces, $options, $out, $params, $path, $ret, $type, $urls, $vars, ApiBase\ALL_DEFAULT_STRING, as, ApiBase\GET_VALUES_FOR_HELP, SpecialVersion\getExtLicenseFileName(), getHelpInternal(), IContextSource\getLanguage(), ApiBase\LIMIT_SML1, ApiBase\LIMIT_SML2, ApiBase\makeMessage(), MessageLocalizer\msg(), ApiBase\PARAM_ALL, ApiBase\PARAM_DEPRECATED, ApiBase\PARAM_DEPRECATED_VALUES, ApiBase\PARAM_DFLT, ApiBase\PARAM_EXTRA_NAMESPACES, ApiBase\PARAM_HELP_MSG_INFO, ApiBase\PARAM_ISMULTI, ApiBase\PARAM_ISMULTI_LIMIT1, ApiBase\PARAM_ISMULTI_LIMIT2, ApiBase\PARAM_MAX, ApiBase\PARAM_MAX2, ApiBase\PARAM_MIN, ApiBase\PARAM_REQUIRED, ApiBase\PARAM_SUBMODULE_MAP, ApiBase\PARAM_TEMPLATE_VARS, ApiBase\PARAM_TYPE, ApiBase\PARAM_VALUE_LINKS, use, wfAppendQuery(), wfScript(), and wrap().

Referenced by getHelp(), and getHelpInternal().

◆ getHelpUrls()

ApiHelp::getHelpUrls ( )

Return links to more detailed help pages about the module.

Since: 1.25, returning boolean false is deprecated

Returns: string|array

Reimplemented from ApiBase.

Definition at line 902 of file ApiHelp.php.

◆ isReadMode()

ApiHelp::isReadMode ( )

Indicates whether this module requires read rights.

Returns: bool

Reimplemented from ApiBase.

Definition at line 859 of file ApiHelp.php.

◆ shouldCheckMaxlag()

ApiHelp::shouldCheckMaxlag ( )

Indicates if this module needs maxlag to be checked.

Returns: bool

Reimplemented from ApiBase.

Definition at line 855 of file ApiHelp.php.

◆ wrap()

static ApiHelp::wrap	(	Message	$msg,
			$class,
			$tag = `'span'`
	)

staticprivate

Wrap a message in HTML with a class.

Parameters

Message	$msg
string	$class
string	$tag

Returns: string

Definition at line 211 of file ApiHelp.php.

References Message\parse().

Referenced by getHelpInternal().

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

includes/api/ApiHelp.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ execute()

◆ fixHelpLinks()

◆ getAllowedParams()

◆ getCustomPrinter()

◆ getExamplesMessages()

◆ getHelp()

◆ getHelpInternal()

◆ getHelpUrls()

◆ isReadMode()

◆ shouldCheckMaxlag()

◆ wrap()