MediaWiki  master
ApiQueryRevisionsBase Class Reference

A base class for functions common to producing a list of revisions. More...

Inheritance diagram for ApiQueryRevisionsBase:
Collaboration diagram for ApiQueryRevisionsBase:

Constants for internal use. Don't use externally.

const IS_DELETED = 1
 
const CANNOT_VIEW = 2
 
RevisionStore $revisionStore
 
IContentHandlerFactory $contentHandlerFactory
 
ParserFactory $parserFactory
 
SlotRoleRegistry $slotRoleRegistry
 
ContentTransformer $contentTransformer
 
 $limit
 
 $fld_ids = false
 
 $diffto
 
 $difftotext
 
 $difftotextpst
 
 $expandTemplates
 
 $generateXML
 
 $section
 
 $parseContent
 
 $fetchContent
 
 $contentFormat
 
 $setParsedLimit = true
 
 $slotRoles = null
 
 $needSlots
 
 $fld_flags = false
 
 $fld_timestamp = false
 
 $fld_size = false
 
 $fld_slotsize = false
 
 $fld_sha1 = false
 
 $fld_slotsha1 = false
 
 $fld_comment = false
 
 $fld_parsedcomment = false
 
 $fld_user = false
 
 $fld_userid = false
 
 $fld_content = false
 
 $fld_tags = false
 
 $fld_contentmodel = false
 
 $fld_roles = false
 
 $fld_parsetree = false
 
 __construct (ApiQuery $queryModule, $moduleName, $paramPrefix='', RevisionStore $revisionStore=null, IContentHandlerFactory $contentHandlerFactory=null, ParserFactory $parserFactory=null, SlotRoleRegistry $slotRoleRegistry=null, ContentTransformer $contentTransformer=null)
 
 execute ()
 
 executeGenerator ( $resultPageSet)
 
 getCacheMode ( $params)
 
 getAllowedParams ()
 
 run (ApiPageSet $resultPageSet=null)
 
 parseParameters ( $params)
 Parse the parameters into the various instance fields. More...
 
 extractRevisionInfo (RevisionRecord $revision, $row)
 Extract information from the RevisionRecord. More...
 
 checkRevDel (RevisionRecord $revision, $field)
 Test revision deletion status. More...
 
 extractAllSlotInfo (RevisionRecord $revision, $revDel)
 Extracts information about all relevant slots. More...
 
 extractSlotInfo (SlotRecord $slot, $revDel, &$content=null)
 Extract information from the SlotRecord. More...
 
 extractDeprecatedContent (Content $content, RevisionRecord $revision)
 Format a Content using deprecated options. More...
 

Additional Inherited Members

- Public Member Functions inherited from ApiQueryGeneratorBase
 encodeParamName ( $paramName)
 Overrides ApiBase to prepend 'g' to every generator parameter. More...
 
 isInGeneratorMode ()
 Indicate whether the module is in generator mode. More...
 
 setGeneratorMode (ApiPageSet $generatorPageSet)
 Switch this module to generator mode. More...
 
- Public Member Functions inherited from ApiQueryBase
 __construct (ApiQuery $queryModule, $moduleName, $paramPrefix='')
 
 requestExtraData ( $pageSet)
 Override this method to request extra fields from the pageSet using $pageSet->requestField('fieldName') More...
 
 showHiddenUsersAddBlockInfo ( $showBlockInfo)
 Filters hidden users (where the user doesn't have the right to view them) Also adds relevant block information. More...
 
 getQuery ()
 Get the main Query module. More...
 
 getParent ()
 Get the parent of this module.
Stability: stable
to override
Since
1.25
Returns
ApiBase|null
More...
 
 selectNamedDB ( $name, $db, $groups)
 Selects the query database connection with the given name. More...
 
 titlePartToKey ( $titlePart, $namespace=NS_MAIN)
 Convert an input title or title prefix into a dbkey. More...
 
 prefixedTitlePartToKey ( $titlePart, $defaultNamespace=NS_MAIN)
 Convert an input title or title prefix into a namespace constant and dbkey. More...
 
 validateSha1Hash ( $hash)
 
 validateSha1Base36Hash ( $hash)
 
 userCanSeeRevDel ()
 Check whether the current user has permission to view revision-deleted fields. 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...
 
 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...
 
 shouldCheckMaxlag ()
 Indicates if this module needs maxlag to be checked. More...
 
 isReadMode ()
 Indicates whether this module requires read rights. 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...
 
 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 ()
 
 getContinuationManager ()
 
 setContinuationManager (ApiContinuationManager $manager=null)
 
 dynamicParameterDocumentation ()
 Indicate if the module supports dynamically-determined parameters that cannot be included in self::getAllowedParams(). 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, Authority $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 (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. 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 ( $pageIdentity, $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...
 
 getAuthority ()
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getCsrfTokenSet ()
 Get a repository to obtain and match CSRF tokens. 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 inherited from ApiQueryBase
static addTitleInfo (&$arr, $title, $prefix='')
 Add information (title and namespace) about a Title object to a result array. 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...
 
- Public Attributes inherited from ApiQueryBase
 $mDb
 
- Public Attributes inherited from ApiBase
const PARAM_RANGE_ENFORCE = 'api-param-range-enforce'
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
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. 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...
 
const ALL_DEFAULT_STRING = '*'
 (string|array|Message) Specify an alternative i18n documentation message for this parameter. 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 GET_VALUES_FOR_HELP = 1
 getAllowedParams() flag: When set, the result could take longer to generate, but should be more thorough. More...
 
string $mModulePrefix
 (string|array|Message) Specify an alternative i18n documentation message for this parameter. More...
 
- Protected Member Functions inherited from ApiQueryGeneratorBase
 getHelpFlags ()
 Generates the list of flags for the help screen and for action=paraminfo.Corresponding messages: api-help-flag-deprecated, api-help-flag-internal, api-help-flag-readrights, api-help-flag-writerights, api-help-flag-mustbeposted
Returns
string[]
More...
 
 getPageSet ()
 Get the PageSet object to work on. More...
 
 setContinueEnumParameter ( $paramName, $paramValue)
 Overridden to set the generator param if in generator mode. More...
 
- Protected Member Functions inherited from ApiQueryBase
 resetQueryParams ()
 Blank the internal arrays with query parameters. More...
 
 getQueryBuilder ()
 Get the SelectQueryBuilder. More...
 
 addTables ( $tables, $alias=null)
 Add a set of tables to the internal array. More...
 
 addJoinConds ( $join_conds)
 Add a set of JOIN conditions to the internal array. More...
 
 addFields ( $value)
 Add a set of fields to select to the internal array. More...
 
 addFieldsIf ( $value, $condition)
 Same as addFields(), but add the fields only if a condition is met. More...
 
 addWhere ( $value)
 Add a set of WHERE clauses to the internal array. More...
 
 addWhereIf ( $value, $condition)
 Same as addWhere(), but add the WHERE clauses only if a condition is met. More...
 
 addWhereFld ( $field, $value)
 Equivalent to addWhere( [ $field => $value ] ) More...
 
 addWhereIDsFld ( $table, $field, $ids)
 Like addWhereFld for an integer list of IDs. More...
 
 addWhereRange ( $field, $dir, $start, $end, $sort=true)
 Add a WHERE clause corresponding to a range, and an ORDER BY clause to sort in the right direction. More...
 
 addTimestampWhereRange ( $field, $dir, $start, $end, $sort=true)
 Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end to database timestamps. More...
 
 addOption ( $name, $value=null)
 Add an option such as LIMIT or USE INDEX. More...
 
 select ( $method, $extraQuery=[], array &$hookData=null)
 Execute a SELECT query based on the values in the internal arrays. More...
 
 processRow ( $row, array &$data, array &$hookData)
 Call the ApiQueryBaseProcessRow hook. More...
 
 getDB ()
 Get the Query database connection (read-only) More...
 
 addPageSubItems ( $pageId, $data)
 Add a sub-element under the page element with the given page ID. More...
 
 addPageSubItem ( $pageId, $item, $elemname=null)
 Same as addPageSubItems(), but one element of $data at a time. More...
 
 parsePrefixedTitlePart ( $titlePart, $defaultNamespace=NS_MAIN)
 Convert an input title or title prefix into a TitleValue. More...
 
 executeGenderCacheFromResultWrapper (IResultWrapper $res, $fname=__METHOD__, $fieldPrefix='page')
 Preprocess the result set to fill the GenderCache with the necessary information before using self::addTitleInfo. More...
 
- Protected Member Functions inherited from ApiBase
 getExamplesMessages ()
 Returns usage examples for this module. More...
 
 getWebUITokenSalt (array $params)
 Fetch the salt used in the Web UI corresponding to this module. 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...
 
 getParameterFromSettings ( $name, $settings, $parseLimit)
 Using the settings determine the value for the given 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...
 
 getModuleSourceInfo ()
 Returns information about the source of this module, if known. More...
 
- Static Protected Member Functions inherited from ApiBase
static dieDebug ( $method, $message)
 Internal code errors should be reported with this method. More...
 

Detailed Description

A base class for functions common to producing a list of revisions.

Stability: stable
to extend

Definition at line 42 of file ApiQueryRevisionsBase.php.

Constructor & Destructor Documentation

◆ __construct()

ApiQueryRevisionsBase::__construct ( ApiQuery  $queryModule,
  $moduleName,
  $paramPrefix = '',
RevisionStore  $revisionStore = null,
IContentHandlerFactory  $contentHandlerFactory = null,
ParserFactory  $parserFactory = null,
SlotRoleRegistry  $slotRoleRegistry = null,
ContentTransformer  $contentTransformer = null 
)
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 91 of file ApiQueryRevisionsBase.php.

References $contentHandlerFactory, $contentTransformer, $parserFactory, $revisionStore, and $slotRoleRegistry.

Member Function Documentation

◆ checkRevDel()

ApiQueryRevisionsBase::checkRevDel ( RevisionRecord  $revision,
  $field 
)
private

Test revision deletion status.

Parameters
RevisionRecord$revisionRevision to check
int$fieldOne of the RevisionRecord::DELETED_* constants
Returns
int Revision deletion status flags. Bitwise OR of self::IS_DELETED and self::CANNOT_VIEW, as appropriate.

Definition at line 269 of file ApiQueryRevisionsBase.php.

References CANNOT_VIEW, ContextSource\getAuthority(), IS_DELETED, MediaWiki\Revision\RevisionRecord\isDeleted(), and MediaWiki\Revision\RevisionRecord\userCan().

Referenced by extractRevisionInfo(), and parseParameters().

◆ execute()

ApiQueryRevisionsBase::execute ( )
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Reimplemented from ApiBase.

Definition at line 112 of file ApiQueryRevisionsBase.php.

References run().

◆ executeGenerator()

ApiQueryRevisionsBase::executeGenerator (   $resultPageSet)
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Reimplemented from ApiQueryGeneratorBase.

Definition at line 116 of file ApiQueryRevisionsBase.php.

References run().

◆ extractAllSlotInfo()

ApiQueryRevisionsBase::extractAllSlotInfo ( RevisionRecord  $revision,
  $revDel 
)
private

◆ extractDeprecatedContent()

◆ extractRevisionInfo()

◆ extractSlotInfo()

ApiQueryRevisionsBase::extractSlotInfo ( SlotRecord  $slot,
  $revDel,
$content = null 
)
private

Extract information from the SlotRecord.

Parameters
SlotRecord$slot
int$revDelRevdel status flags, from self::checkRevDel()
Content | null&$contentSet to the slot's content, if available and $this->fetchContent is true
Returns
array

Definition at line 499 of file ApiQueryRevisionsBase.php.

References $content, MediaWiki\Revision\SlotRecord\getContent(), MediaWiki\Revision\SlotRecord\getModel(), MediaWiki\Revision\SlotRecord\getSha1(), MediaWiki\Revision\SlotRecord\getSize(), and ApiResult\setArrayType().

Referenced by extractAllSlotInfo().

◆ getAllowedParams()

◆ getCacheMode()

ApiQueryRevisionsBase::getCacheMode (   $params)
Stability: stable
to override
Parameters
array$params
Returns
string

Reimplemented from ApiQueryBase.

Definition at line 718 of file ApiQueryRevisionsBase.php.

References ApiQueryBase\userCanSeeRevDel().

◆ parseParameters()

◆ run()

ApiQueryRevisionsBase::run ( ApiPageSet  $resultPageSet = null)
abstractprotected
Parameters
ApiPageSet | null$resultPageSet
Returns
void

Reimplemented in ApiQueryRevisions, ApiQueryDeletedRevisions, ApiQueryAllRevisions, and ApiQueryAllDeletedRevisions.

Referenced by execute(), and executeGenerator().

Member Data Documentation

◆ $contentFormat

ApiQueryRevisionsBase::$contentFormat
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 55 of file ApiQueryRevisionsBase.php.

◆ $contentHandlerFactory

IContentHandlerFactory ApiQueryRevisionsBase::$contentHandlerFactory
private
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 68 of file ApiQueryRevisionsBase.php.

Referenced by ApiQueryAllRevisions\__construct(), ApiQueryRevisions\__construct(), ApiQueryDeletedRevisions\__construct(), ApiQueryAllDeletedRevisions\__construct(), and __construct().

◆ $contentTransformer

ContentTransformer ApiQueryRevisionsBase::$contentTransformer
private
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 77 of file ApiQueryRevisionsBase.php.

Referenced by ApiQueryAllRevisions\__construct(), ApiQueryRevisions\__construct(), ApiQueryDeletedRevisions\__construct(), ApiQueryAllDeletedRevisions\__construct(), and __construct().

◆ $diffto

ApiQueryRevisionsBase::$diffto
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 54 of file ApiQueryRevisionsBase.php.

◆ $difftotext

ApiQueryRevisionsBase::$difftotext
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 54 of file ApiQueryRevisionsBase.php.

◆ $difftotextpst

ApiQueryRevisionsBase::$difftotextpst
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 54 of file ApiQueryRevisionsBase.php.

◆ $expandTemplates

ApiQueryRevisionsBase::$expandTemplates
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 54 of file ApiQueryRevisionsBase.php.

◆ $fetchContent

ApiQueryRevisionsBase::$fetchContent
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 55 of file ApiQueryRevisionsBase.php.

◆ $fld_comment

ApiQueryRevisionsBase::$fld_comment = false
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 60 of file ApiQueryRevisionsBase.php.

◆ $fld_content

ApiQueryRevisionsBase::$fld_content = false
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 61 of file ApiQueryRevisionsBase.php.

◆ $fld_contentmodel

ApiQueryRevisionsBase::$fld_contentmodel = false
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 61 of file ApiQueryRevisionsBase.php.

◆ $fld_flags

ApiQueryRevisionsBase::$fld_flags = false
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 58 of file ApiQueryRevisionsBase.php.

◆ $fld_ids

ApiQueryRevisionsBase::$fld_ids = false
protected
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 58 of file ApiQueryRevisionsBase.php.

◆ $fld_parsedcomment

ApiQueryRevisionsBase::$fld_parsedcomment = false
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 60 of file ApiQueryRevisionsBase.php.

◆ $fld_parsetree

ApiQueryRevisionsBase::$fld_parsetree = false
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 62 of file ApiQueryRevisionsBase.php.

Referenced by parseParameters().

◆ $fld_roles

ApiQueryRevisionsBase::$fld_roles = false
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 61 of file ApiQueryRevisionsBase.php.

◆ $fld_sha1

ApiQueryRevisionsBase::$fld_sha1 = false
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 59 of file ApiQueryRevisionsBase.php.

◆ $fld_size

ApiQueryRevisionsBase::$fld_size = false
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 59 of file ApiQueryRevisionsBase.php.

◆ $fld_slotsha1

ApiQueryRevisionsBase::$fld_slotsha1 = false
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 59 of file ApiQueryRevisionsBase.php.

Referenced by parseParameters().

◆ $fld_slotsize

ApiQueryRevisionsBase::$fld_slotsize = false
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 59 of file ApiQueryRevisionsBase.php.

◆ $fld_tags

ApiQueryRevisionsBase::$fld_tags = false
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 61 of file ApiQueryRevisionsBase.php.

◆ $fld_timestamp

ApiQueryRevisionsBase::$fld_timestamp = false
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 58 of file ApiQueryRevisionsBase.php.

◆ $fld_user

ApiQueryRevisionsBase::$fld_user = false
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 60 of file ApiQueryRevisionsBase.php.

◆ $fld_userid

ApiQueryRevisionsBase::$fld_userid = false
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 60 of file ApiQueryRevisionsBase.php.

◆ $generateXML

ApiQueryRevisionsBase::$generateXML
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 54 of file ApiQueryRevisionsBase.php.

◆ $limit

ApiQueryRevisionsBase::$limit
protected
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 54 of file ApiQueryRevisionsBase.php.

◆ $needSlots

ApiQueryRevisionsBase::$needSlots
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 56 of file ApiQueryRevisionsBase.php.

◆ $parseContent

ApiQueryRevisionsBase::$parseContent
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 55 of file ApiQueryRevisionsBase.php.

◆ $parserFactory

ParserFactory ApiQueryRevisionsBase::$parserFactory
private
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 71 of file ApiQueryRevisionsBase.php.

Referenced by ApiQueryAllRevisions\__construct(), ApiQueryRevisions\__construct(), ApiQueryDeletedRevisions\__construct(), ApiQueryAllDeletedRevisions\__construct(), and __construct().

◆ $revisionStore

RevisionStore ApiQueryRevisionsBase::$revisionStore
private
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 65 of file ApiQueryRevisionsBase.php.

Referenced by __construct().

◆ $section

ApiQueryRevisionsBase::$section
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 55 of file ApiQueryRevisionsBase.php.

◆ $setParsedLimit

ApiQueryRevisionsBase::$setParsedLimit = true
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 55 of file ApiQueryRevisionsBase.php.

◆ $slotRoleRegistry

SlotRoleRegistry ApiQueryRevisionsBase::$slotRoleRegistry
private
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 74 of file ApiQueryRevisionsBase.php.

Referenced by ApiQueryAllRevisions\__construct(), ApiQueryRevisions\__construct(), ApiQueryDeletedRevisions\__construct(), ApiQueryAllDeletedRevisions\__construct(), and __construct().

◆ $slotRoles

ApiQueryRevisionsBase::$slotRoles = null
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 56 of file ApiQueryRevisionsBase.php.

Referenced by getAllowedParams().

◆ CANNOT_VIEW

const ApiQueryRevisionsBase::CANNOT_VIEW = 2
private
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 50 of file ApiQueryRevisionsBase.php.

Referenced by checkRevDel().

◆ IS_DELETED

const ApiQueryRevisionsBase::IS_DELETED = 1
private
Since
1.37 Support injection of services
Stability: stable
to call
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix
RevisionStore | null$revisionStore
IContentHandlerFactory | null$contentHandlerFactory
ParserFactory | null$parserFactory
SlotRoleRegistry | null$slotRoleRegistry
ContentTransformer | null$contentTransformer

Definition at line 49 of file ApiQueryRevisionsBase.php.

Referenced by checkRevDel().


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