MediaWiki REL1_37
ApiParse Class Reference
Inheritance diagram for ApiParse:
Collaboration diagram for ApiParse:

Public Member Functions

 __construct (ApiMain $main, $action, RevisionLookup $revisionLookup, SkinFactory $skinFactory, LanguageNameUtils $languageNameUtils, LinkBatchFactory $linkBatchFactory, LinkCache $linkCache, IContentHandlerFactory $contentHandlerFactory, Parser $parser, WikiPageFactory $wikiPageFactory, ContentTransformer $contentTransformer)
 
 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.
 
 getHelpUrls ()
 Return links to more detailed help pages about the module.
 
- 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.
 
 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.
 
 shouldCheckMaxlag ()
 Indicates if this module needs maxlag to be checked.
 
 isReadMode ()
 Indicates whether this module requires read rights.
 
 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 ()
 
 getContinuationManager ()
 
 setContinuationManager (ApiContinuationManager $manager=null)
 
 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.
 
 handleParamNormalization ( $paramName, $value, $rawValue)
 Handle when a parameter was Unicode-normalized.
 
 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.
 
 addBlockInfoToStatus (StatusValue $status, Authority $user=null)
 Add block info to block messages in 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=0)
 Abort execution with an error.
 
 dieWithException (Throwable $exception, array $options=[])
 Abort execution with an error derived from a throwable.
 
 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 ( $pageIdentity, $actions, array $options=[])
 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.
 
 getAuthority ()
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object.
 
 getCsrfTokenSet ()
 Get a repository to obtain and match CSRF tokens.
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object.
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage()
 
 setContext (IContextSource $context)
 

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.
 
 getPermissionManager ()
 Obtain a PermissionManager instance that subclasses may use in their authorization checks.
 
 getHookContainer ()
 Get a HookContainer, for running extension hooks or for hook metadata.
 
 getHookRunner ()
 Get an ApiHookRunner for running core API hooks.
 
 getParameter ( $paramName, $parseLimit=true)
 Get a value for the given parameter.
 
 getParameterFromSettings ( $name, $settings, $parseLimit)
 Using the settings determine the value for the given parameter.
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed.
 
 filterIDs ( $fields, array $ids)
 Filter out-of-range values from a list of positive integer IDs.
 
 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.
 

Private Member Functions

 formatCategoryLinks ( $links)
 
 formatHeadItems ( $headItems)
 
 formatIWLinks ( $iw)
 
 formatLangLinks ( $links)
 
 formatLimitReportData ( $limitReportData)
 
 formatLinks ( $links)
 
 formatSummary ( $title, $params)
 This mimicks the behavior of EditPage in formatting a summary.
 
 getContentParserOutput (Content $content, Title $title, $revId, ParserOptions $popts)
 
 getPageParserOutput (WikiPage $page, $revId, ParserOptions $popts, bool $suppressCache)
 
 getParsedContent (WikiPage $page, $popts, $suppressCache, $pageId, $rev, $getContent)
 
 getPoolKey ()
 
 getSectionContent (Content $content, $what)
 Extract the requested section from the given Content.
 
 makeParserOptions (WikiPage $pageObj, array $params)
 Constructs a ParserOptions object.
 
 setIndexedTagNames (&$array, $mapping)
 
 tweakParserOptions (ParserOptions $popts, Title $title, array $params)
 Tweaks a ParserOptions object.
 

Private Attributes

Content null $content = null
 
IContentHandlerFactory $contentHandlerFactory
 
bool $contentIsDeleted = false
 
bool $contentIsSuppressed = false
 
ContentTransformer $contentTransformer
 
LanguageNameUtils $languageNameUtils
 
LinkBatchFactory $linkBatchFactory
 
LinkCache $linkCache
 
Parser $parser
 
Content null $pstContent = null
 
RevisionLookup $revisionLookup
 
string false null $section = null
 
SkinFactory $skinFactory
 
WikiPageFactory $wikiPageFactory
 

Additional Inherited Members

- Static Public Member Functions inherited from ApiBase
static makeMessage ( $msg, IContextSource $context, array $params=null)
 Create a Message from a string or array.
 
- Public Attributes inherited from ApiBase
const PARAM_RANGE_ENFORCE = 'api-param-range-enforce'
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
 
const PARAM_DFLT = ParamValidator::PARAM_DEFAULT
 
const PARAM_ISMULTI = ParamValidator::PARAM_ISMULTI
 
const PARAM_TYPE = ParamValidator::PARAM_TYPE
 
const PARAM_MAX = IntegerDef::PARAM_MAX
 
const PARAM_MAX2 = IntegerDef::PARAM_MAX2
 
const PARAM_MIN = IntegerDef::PARAM_MIN
 
const PARAM_ALLOW_DUPLICATES = ParamValidator::PARAM_ALLOW_DUPLICATES
 
const PARAM_DEPRECATED = ParamValidator::PARAM_DEPRECATED
 
const PARAM_REQUIRED = ParamValidator::PARAM_REQUIRED
 
const PARAM_SUBMODULE_MAP = SubmoduleDef::PARAM_SUBMODULE_MAP
 
const PARAM_SUBMODULE_PARAM_PREFIX = SubmoduleDef::PARAM_SUBMODULE_PARAM_PREFIX
 
const PARAM_ALL = ParamValidator::PARAM_ALL
 
const PARAM_EXTRA_NAMESPACES = NamespaceDef::PARAM_EXTRA_NAMESPACES
 
const PARAM_SENSITIVE = ParamValidator::PARAM_SENSITIVE
 
const PARAM_DEPRECATED_VALUES = EnumDef::PARAM_DEPRECATED_VALUES
 
const PARAM_ISMULTI_LIMIT1 = ParamValidator::PARAM_ISMULTI_LIMIT1
 
const PARAM_ISMULTI_LIMIT2 = ParamValidator::PARAM_ISMULTI_LIMIT2
 
const PARAM_MAX_BYTES = StringDef::PARAM_MAX_BYTES
 
const PARAM_MAX_CHARS = StringDef::PARAM_MAX_CHARS
 
const PARAM_HELP_MSG = 'api-param-help-msg'
 (string|array|Message) Specify an alternative i18n documentation message for this parameter.
 
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.
 
const PARAM_HELP_MSG_INFO = 'api-param-help-msg-info'
 (array) Specify additional information tags for the parameter.
 
const PARAM_VALUE_LINKS = 'api-param-value-links'
 Deprecated and unused.
 
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().
 
const PARAM_TEMPLATE_VARS = 'param-template-vars'
 (array) Indicate that this is a templated parameter, and specify replacements.
 
const ALL_DEFAULT_STRING = '*'
 (string|array|Message) Specify an alternative i18n documentation message for this parameter.
 
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 GET_VALUES_FOR_HELP = 1
 getAllowedParams() flag: When set, the result could take longer to generate, but should be more thorough.
 
- Static Protected Member Functions inherited from ApiBase
static dieDebug ( $method, $message)
 Internal code errors should be reported with this method.
 

Detailed Description

Definition at line 35 of file ApiParse.php.

Constructor & Destructor Documentation

◆ __construct()

ApiParse::__construct ( ApiMain  $main,
  $action,
RevisionLookup  $revisionLookup,
SkinFactory  $skinFactory,
LanguageNameUtils  $languageNameUtils,
LinkBatchFactory  $linkBatchFactory,
LinkCache  $linkCache,
IContentHandlerFactory  $contentHandlerFactory,
Parser  $parser,
WikiPageFactory  $wikiPageFactory,
ContentTransformer  $contentTransformer 
)
Parameters
ApiMain$main
string$action
RevisionLookup$revisionLookup
SkinFactory$skinFactory
LanguageNameUtils$languageNameUtils
LinkBatchFactory$linkBatchFactory
LinkCache$linkCache
IContentHandlerFactory$contentHandlerFactory
Parser$parser
WikiPageFactory$wikiPageFactory
ContentTransformer$contentTransformer

Definition at line 89 of file ApiParse.php.

References $contentHandlerFactory, $contentTransformer, $languageNameUtils, $linkBatchFactory, $linkCache, $parser, $revisionLookup, $skinFactory, and $wikiPageFactory.

Member Function Documentation

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

References $title, $wgTitle, CONTENT_MODEL_WIKITEXT, getContext(), EditPage\getPreviewLimitReport(), Parser\OT_PREPROCESS, and wfEscapeWikiText().

◆ formatCategoryLinks()

ApiParse::formatCategoryLinks (   $links)
private

Definition at line 844 of file ApiParse.php.

References $res, $title, getDB(), and NS_CATEGORY.

◆ formatHeadItems()

ApiParse::formatHeadItems (   $headItems)
private

Definition at line 928 of file ApiParse.php.

References $content.

◆ formatIWLinks()

ApiParse::formatIWLinks (   $iw)
private

Definition at line 908 of file ApiParse.php.

References $title, PROTO_CURRENT, and wfExpandUrl().

◆ formatLangLinks()

ApiParse::formatLangLinks (   $links)
private

Definition at line 818 of file ApiParse.php.

References $title, PROTO_CURRENT, and wfExpandUrl().

◆ formatLimitReportData()

ApiParse::formatLimitReportData (   $limitReportData)
private

Definition at line 940 of file ApiParse.php.

◆ formatLinks()

ApiParse::formatLinks (   $links)
private

Definition at line 893 of file ApiParse.php.

References $title.

◆ formatSummary()

ApiParse::formatSummary (   $title,
  $params 
)
private

This mimicks the behavior of EditPage in formatting a summary.

Parameters
Title$titleof the page being parsed
array$paramsThe API parameters of the request
Returns
string HTML

Definition at line 801 of file ApiParse.php.

References $title, Linker\formatComment(), and wfMessage().

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

Stability: stable
to override
Returns
array

Reimplemented from ApiBase.

Definition at line 965 of file ApiParse.php.

References CONTENT_MODEL_WIKITEXT, ApiBase\PARAM_DEPRECATED, ApiBase\PARAM_DEPRECATED_VALUES, ApiBase\PARAM_DFLT, ApiBase\PARAM_HELP_MSG, ApiBase\PARAM_HELP_MSG_PER_VALUE, ApiBase\PARAM_ISMULTI, and ApiBase\PARAM_TYPE.

◆ getContentParserOutput()

ApiParse::getContentParserOutput ( Content  $content,
Title  $title,
  $revId,
ParserOptions  $popts 
)
private

Definition at line 124 of file ApiParse.php.

References $content, $title, and PoolCounterWork\execute().

◆ getExamplesMessages()

ApiParse::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
Stability: stable
to override
Returns
array

Reimplemented from ApiBase.

Definition at line 1063 of file ApiParse.php.

◆ getHelpUrls()

ApiParse::getHelpUrls ( )

Return links to more detailed help pages about the module.

Since
1.25, returning boolean false is deprecated
Stability: stable
to override
Returns
string|array

Reimplemented from ApiBase.

Definition at line 1076 of file ApiParse.php.

◆ getPageParserOutput()

ApiParse::getPageParserOutput ( WikiPage  $page,
  $revId,
ParserOptions  $popts,
bool  $suppressCache 
)
private

Definition at line 143 of file ApiParse.php.

References PoolCounterWork\execute(), and WikiPage\getParserOutput().

◆ getParsedContent()

ApiParse::getParsedContent ( WikiPage  $page,
  $popts,
  $suppressCache,
  $pageId,
  $rev,
  $getContent 
)
private
Parameters
WikiPage$page
ParserOptions$popts
bool$suppressCache
int$pageId
RevisionRecord | null$rev
bool$getContent
Returns
ParserOutput

Definition at line 724 of file ApiParse.php.

References WikiPage\getContent(), WikiPage\getId(), WikiPage\getLatest(), and WikiPage\getTitle().

◆ getPoolKey()

ApiParse::getPoolKey ( )
private

Definition at line 114 of file ApiParse.php.

References ContextSource\getUser().

◆ getSectionContent()

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

Extract the requested section from the given Content.

Parameters
Content$content
string | Message$whatIdentifies the content in error messages, e.g. page title.
Returns
Content

Definition at line 781 of file ApiParse.php.

References $content.

◆ makeParserOptions()

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

Constructs a ParserOptions object.

Parameters
WikiPage$pageObj
array$params
Returns
array [ ParserOptions, ScopedCallback, bool $suppressCache ]

Definition at line 684 of file ApiParse.php.

References getContext(), WikiPage\getTitle(), and WikiPage\makeParserOptions().

◆ setIndexedTagNames()

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

Definition at line 957 of file ApiParse.php.

◆ tweakParserOptions()

ApiParse::tweakParserOptions ( ParserOptions  $popts,
Title  $title,
array  $params 
)
private

Tweaks a ParserOptions object.

Parameters
ParserOptions$popts
Title$title
array$params
Returns
array [ ParserOptions, ScopedCallback, bool $suppressCache ]

Definition at line 698 of file ApiParse.php.

References $title, ParserOptions\enableLimitReport(), ParserOptions\setIsPreview(), ParserOptions\setIsSectionPreview(), and ParserOptions\setWrapOutputClass().

Member Data Documentation

◆ $content

Content null ApiParse::$content = null
private

Definition at line 41 of file ApiParse.php.

◆ $contentHandlerFactory

IContentHandlerFactory ApiParse::$contentHandlerFactory
private

Definition at line 65 of file ApiParse.php.

Referenced by __construct().

◆ $contentIsDeleted

bool ApiParse::$contentIsDeleted = false
private

Definition at line 47 of file ApiParse.php.

◆ $contentIsSuppressed

bool ApiParse::$contentIsSuppressed = false
private

Definition at line 47 of file ApiParse.php.

◆ $contentTransformer

ContentTransformer ApiParse::$contentTransformer
private

Definition at line 74 of file ApiParse.php.

Referenced by __construct().

◆ $languageNameUtils

LanguageNameUtils ApiParse::$languageNameUtils
private

Definition at line 56 of file ApiParse.php.

Referenced by __construct().

◆ $linkBatchFactory

LinkBatchFactory ApiParse::$linkBatchFactory
private

Definition at line 59 of file ApiParse.php.

Referenced by __construct().

◆ $linkCache

LinkCache ApiParse::$linkCache
private

Definition at line 62 of file ApiParse.php.

Referenced by __construct().

◆ $parser

Parser ApiParse::$parser
private

Definition at line 68 of file ApiParse.php.

Referenced by __construct().

◆ $pstContent

Content null ApiParse::$pstContent = null
private

Definition at line 44 of file ApiParse.php.

◆ $revisionLookup

RevisionLookup ApiParse::$revisionLookup
private

Definition at line 50 of file ApiParse.php.

Referenced by __construct().

◆ $section

string false null ApiParse::$section = null
private

Definition at line 38 of file ApiParse.php.

◆ $skinFactory

SkinFactory ApiParse::$skinFactory
private

Definition at line 53 of file ApiParse.php.

Referenced by __construct().

◆ $wikiPageFactory

WikiPageFactory ApiParse::$wikiPageFactory
private

Definition at line 71 of file ApiParse.php.

Referenced by __construct().


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