MediaWiki  master
ApiHelp Class Reference

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

Inheritance diagram for ApiHelp:
Collaboration diagram for ApiHelp:

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...
 
 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...
 
 getHelpUrls ()
 Return links to more detailed help pages about the module. More...
 
 isReadMode ()
 Indicates whether this module requires read rights. More...
 
 shouldCheckMaxlag ()
 Indicates if this module needs maxlag to be checked. More...
 
- 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. More...
 
 isWriteMode ()
 Indicates whether this module requires write mode. More...
 
 mustBePosted ()
 Indicates whether this module must be called with a POST request. More...
 
 isDeprecated ()
 Indicates whether this module is deprecated. More...
 
 isInternal ()
 Indicates whether this module is "internal" Internal API modules are not (yet) intended for 3rd party use and may be unstable. More...
 
 needsToken ()
 Returns the token type this module requires in order to execute. More...
 
 getConditionalRequestData ( $condition)
 Returns data for HTTP conditional request mechanisms. 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...
 
 getMain ()
 Get the main module. More...
 
 isMain ()
 Returns true if this module is the main module ($this === $this->mMainModule), false otherwise. More...
 
 getParent ()
 Get the parent of this module. More...
 
 lacksSameOriginSecurity ()
 Returns true if the current request breaks the same-origin policy. More...
 
 getModulePath ()
 Get the path to this module. More...
 
 getModuleFromPath ( $path)
 Get a module from its module path. More...
 
 getResult ()
 Get the result object. More...
 
 getErrorFormatter ()
 Get the error formatter. More...
 
 getContinuationManager ()
 Get the continuation manager. More...
 
 setContinuationManager (ApiContinuationManager $manager=null)
 Set the continuation manager. More...
 
 dynamicParameterDocumentation ()
 Indicate if the module supports dynamically-determined parameters that cannot be included in self::getAllowedParams(). More...
 
 encodeParamName ( $paramName)
 This method mangles parameter name based on the prefix supplied to the constructor. More...
 
 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. More...
 
 requireOnlyOneParameter ( $params,... $required)
 Die if none or more than one of a certain set of parameters is set and not false. More...
 
 requireMaxOneParameter ( $params,... $required)
 Die if more than one of a certain set of parameters is set and not false. More...
 
 requireAtLeastOneParameter ( $params,... $required)
 Die if none of a certain set of parameters is set and not false. More...
 
 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. More...
 
 getTitleOrPageId ( $params, $load=false)
 Get a WikiPage object from a title or pageid param, if possible. More...
 
 getTitleFromTitleOrPageId ( $params)
 Get a Title object from a title or pageid param, if possible. More...
 
 handleParamNormalization ( $paramName, $value, $rawValue)
 Handle when a parameter was Unicode-normalized. More...
 
 validateToken ( $token, array $params)
 Validate the supplied token. More...
 
 getWatchlistUser ( $params)
 Gets the user for whom to get the watchlist. More...
 
 errorArrayToStatus (array $errors, User $user=null)
 Turn an array of message keys or key+param arrays into a Status. More...
 
 addBlockInfoToStatus (StatusValue $status, User $user=null)
 Add block info to block messages in a Status. More...
 
 addWarning ( $msg, $code=null, $data=null)
 Add a warning for this module. More...
 
 addDeprecation ( $msg, $feature, $data=[])
 Add a deprecation warning for this module. More...
 
 addError ( $msg, $code=null, $data=null)
 Add an error for this module without aborting. More...
 
 addMessagesFromStatus (StatusValue $status, $types=[ 'warning', 'error'], array $filter=[])
 Add warnings and/or errors from a Status. More...
 
 dieWithError ( $msg, $code=null, $data=null, $httpCode=null)
 Abort execution with an error. More...
 
 dieWithException (Throwable $exception, array $options=[])
 Abort execution with an error derived from a throwable. More...
 
 dieBlocked (AbstractBlock $block)
 Throw an ApiUsageException, which will (if uncaught) call the main module's error handler and die with an error message including block info. More...
 
 dieStatus (StatusValue $status)
 Throw an ApiUsageException based on the Status object. More...
 
 dieReadOnly ()
 Helper function for readonly errors. More...
 
 checkUserRightsAny ( $rights, $user=null)
 Helper function for permission-denied errors. More...
 
 checkTitleUserPermissions (LinkTarget $linkTarget, $actions, array $options=[])
 Helper function for permission-denied errors. More...
 
 dieWithErrorOrDebug ( $msg, $code=null, $data=null, $httpCode=null)
 Will only set a warning instead of failing if the global $wgDebugAPI is set to true. More...
 
 logFeatureUsage ( $feature)
 Write logging information for API features to a debug log, for usage analysis. More...
 
 getFinalSummary ()
 Get final module summary. More...
 
 getFinalDescription ()
 Get final module description, 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...
 
 getFinalParamDescription ()
 Get final parameter descriptions, after hooks have had a chance to tweak it as needed. More...
 
 modifyHelp (array &$help, array $options, array &$tocData)
 Called from ApiHelp before the pieces are joined together and returned. 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 ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 

Static Public Member Functions

static fixHelpLinks ( $html, $helptitle=null, $localModules=[])
 Replace Special:ApiHelp links with links to api.php. More...
 
static getHelp (IContextSource $context, $modules, array $options)
 Generate help for the specified modules. More...
 
- Static Public Member Functions inherited from ApiBase
static makeMessage ( $msg, IContextSource $context, array $params=null)
 Create a Message from a string or array. More...
 

Protected Member Functions

 getExamplesMessages ()
 Returns usage examples for this module. More...
 
- Protected Member Functions inherited from ApiBase
 explodeMultiValue ( $value, $limit)
 Split a multi-valued parameter string, like explode() More...
 
 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. More...
 
 validateLimit ( $name, &$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 parameters of type 'timestamp'. More...
 
 getWebUITokenSalt (array $params)
 Fetch the salt used in the Web UI corresponding to this module. More...
 
 getDB ()
 Gets a default replica DB connection object. More...
 
 getPermissionManager ()
 Obtain a PermissionManager instance that subclasses may use in their authorization checks. More...
 
 getHookContainer ()
 Get a HookContainer, for running extension hooks or for hook metadata. More...
 
 getHookRunner ()
 Get an ApiHookRunner for running core API hooks. More...
 
 getParameter ( $paramName, $parseLimit=true)
 Get a value for the given parameter. More...
 
 getWatchlistValue ( $watchlist, $titleObj, $userOption=null)
 Return true if we're to watch the page, false if not, null if no change. More...
 
 getParameterFromSettings ( $name, $settings, $parseLimit)
 Using the settings determine the value for the given parameter. More...
 
 setWatch ( $watch, $titleObj, $userOption=null)
 Set a watch (or unwatch) based the based on a watchlist parameter. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 
 filterIDs ( $fields, array $ids)
 Filter out-of-range values from a list of positive integer IDs. More...
 
 dieContinueUsageIf ( $condition)
 Die with the 'badcontinue' error. More...
 
 getSummaryMessage ()
 Return the summary message. More...
 
 getExtendedDescription ()
 Return the extended help text message. More...
 
 getHelpFlags ()
 Generates the list of flags for the help screen and for action=paraminfo. More...
 
 getModuleSourceInfo ()
 Returns information about the source of this module, if known. More...
 

Static Private Member Functions

static getHelpInternal (IContextSource $context, array $modules, array $options, &$haveModules)
 Recursively-called function to actually construct the help. More...
 
static wrap (Message $msg, $class, $tag='span')
 Wrap a message in HTML with a class. More...
 

Additional Inherited Members

- Public Attributes inherited from ApiBase
string $mModulePrefix
 
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. More...
 
const LIMIT_BIG1 = 500
 Fast query, standard limit. More...
 
const LIMIT_BIG2 = 5000
 Fast query, apihighlimits limit. More...
 
const LIMIT_SML1 = 50
 Slow query, standard limit. More...
 
const LIMIT_SML2 = 500
 Slow query, apihighlimits limit. More...
 
const PARAM_DFLT = ParamValidator::PARAM_DEFAULT
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_ISMULTI = ParamValidator::PARAM_ISMULTI
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_TYPE = ParamValidator::PARAM_TYPE
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_MAX = IntegerDef::PARAM_MAX
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_MAX2 = IntegerDef::PARAM_MAX2
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_MIN = IntegerDef::PARAM_MIN
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_ALLOW_DUPLICATES = ParamValidator::PARAM_ALLOW_DUPLICATES
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_DEPRECATED = ParamValidator::PARAM_DEPRECATED
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_REQUIRED = ParamValidator::PARAM_REQUIRED
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_SUBMODULE_MAP = SubmoduleDef::PARAM_SUBMODULE_MAP
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_SUBMODULE_PARAM_PREFIX = SubmoduleDef::PARAM_SUBMODULE_PARAM_PREFIX
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_ALL = ParamValidator::PARAM_ALL
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_EXTRA_NAMESPACES = NamespaceDef::PARAM_EXTRA_NAMESPACES
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_SENSITIVE = ParamValidator::PARAM_SENSITIVE
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_DEPRECATED_VALUES = EnumDef::PARAM_DEPRECATED_VALUES
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_ISMULTI_LIMIT1 = ParamValidator::PARAM_ISMULTI_LIMIT1
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_ISMULTI_LIMIT2 = ParamValidator::PARAM_ISMULTI_LIMIT2
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_MAX_BYTES = StringDef::PARAM_MAX_BYTES
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_MAX_CHARS = StringDef::PARAM_MAX_CHARS
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_RANGE_ENFORCE = 'api-param-range-enforce'
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_HELP_MSG = 'api-param-help-msg'
 (string|array|Message) Specify an alternative i18n documentation message for this parameter. More...
 
const PARAM_HELP_MSG_APPEND = 'api-param-help-msg-append'
 ((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this parameter. More...
 
const PARAM_HELP_MSG_INFO = 'api-param-help-msg-info'
 (array) Specify additional information tags for the parameter. More...
 
const PARAM_VALUE_LINKS = 'api-param-value-links'
 Deprecated and unused. More...
 
const PARAM_HELP_MSG_PER_VALUE = 'api-param-help-msg-per-value'
 ((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg for ApiBase::makeMessage(). More...
 
const PARAM_TEMPLATE_VARS = 'param-template-vars'
 (array) Indicate that this is a templated parameter, and specify replacements. More...
 
- Static Protected Member Functions inherited from ApiBase
static dieDebug ( $method, $message)
 Internal code errors should be reported with this method. More...
 

Detailed Description

Class to output help for an API module.

Since
1.25 completely rewritten

Definition at line 34 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 35 of file ApiHelp.php.

References ContextSource\$context, $modules, $path, FormatJson\encode(), ApiBase\extractRequestParams(), ContextSource\getContext(), getHelp(), ContextSource\getLanguage(), ApiBase\getMain(), ApiBase\getModuleFromPath(), ApiBase\getModuleName(), IContextSource\getOutput(), ApiBase\getResult(), SpecialPage\getTitleFor(), ApiResult\NO_SIZE_CHECK, ApiResult\setSubelementsList(), true, and FormatJson\UTF8_OK.

◆ fixHelpLinks()

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

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

Parameters
string$html
string | null$helptitleTitle to link to rather than api.php, must contain '$1'
array$localModulesKeys are modules to link within the current page, values are ignored
Returns
string

Definition at line 191 of file ApiHelp.php.

References Title\newFromText(), 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 651 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 640 of file ApiHelp.php.

References 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 664 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$optionsFormatting options (described above)

Definition at line 114 of file ApiHelp.php.

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

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

◆ getHelpInternal()

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

◆ 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 679 of file ApiHelp.php.

◆ isReadMode()

ApiHelp::isReadMode ( )

Indicates whether this module requires read rights.

Returns
bool

Reimplemented from ApiBase.

Definition at line 636 of file ApiHelp.php.

◆ shouldCheckMaxlag()

ApiHelp::shouldCheckMaxlag ( )

Indicates if this module needs maxlag to be checked.

Returns
bool

Reimplemented from ApiBase.

Definition at line 632 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 231 of file ApiHelp.php.

References Message\parse(), and Html\rawElement().

Referenced by getHelpInternal().


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