ApiQueryGeneratorBase Class Reference

Inheritance diagram for ApiQueryGeneratorBase:

Collaboration diagram for ApiQueryGeneratorBase:

Public Member Functions
	encodeParamName ( $paramName)
	Overrides ApiBase to prepend 'g' to every generator parameter.
	executeGenerator ( $resultPageSet)
	Execute this module as a generator.
	isInGeneratorMode ()
	Indicate whether the module is in generator mode.
	setGeneratorMode (ApiPageSet $generatorPageSet)
	Switch this module to generator mode.
Public Member Functions inherited from ApiQueryBase
	__construct (ApiQuery $queryModule, $moduleName, $paramPrefix='')
	getCacheMode ( $params)
	Get the cache mode for the data generated by this module.
	requestExtraData ( $pageSet)
	Override this method to request extra fields from the pageSet using $pageSet->requestField('fieldName')
	getQuery ()
	Get the main Query module.
	getParent ()
	selectNamedDB ( $name, $db, $groups)
	Selects the query database connection with the given name.
	prepareUrlQuerySearchString ( $query=null, $protocol=null)
	showHiddenUsersAddBlockInfo ( $showBlockInfo)
	Filters hidden users (where the user doesn't have the right to view them) Also adds relevant block information.
	titlePartToKey ( $titlePart, $namespace=NS_MAIN)
	Convert an input title or title prefix into a dbkey.
	prefixedTitlePartToKey ( $titlePart, $defaultNamespace=NS_MAIN)
	Convert an input title or title prefix into a namespace constant and dbkey.
	validateSha1Hash ( $hash)
	validateSha1Base36Hash ( $hash)
	userCanSeeRevDel ()
	Check whether the current user has permission to view revision-deleted fields.
Public Member Functions inherited from ApiBase
	__construct (ApiMain $mainModule, $moduleName, $modulePrefix='')
	setWarning ( $warning)
	Set warning section for this module.
	dieUsage ( $description, $errorCode, $httpRespCode=0, $extradata=null)
	Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an error message.
	dieBlocked (Block $block)
	Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an error message including block info.
	getErrorFromStatus ( $status, &$extraData=null)
	Get error (as code, string) from a Status object.
	dieStatus ( $status)
	Throw a UsageException based on the errors in the Status object.
	dieReadOnly ()
	Helper function for readonly errors.
	dieUsageMsg ( $error)
	Output the error message related to a certain array.
	dieUsageMsgOrDebug ( $error)
	Will only set a warning instead of failing if the global $wgDebugAPI is set to true.
	parseMsg ( $error)
	Return the error message related to a certain array.
	logFeatureUsage ( $feature)
	Write logging information for API features to a debug log, for usage analysis.
	execute ()
	Evaluates the parameters, performs the requested query, and sets up the result.
	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.
	getHelpUrls ()
	Return links to more detailed help pages about the module.
	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.
	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 ( $manager)
	Set the continuation manager.
	dynamicParameterDocumentation ()
	Indicate if the module supports dynamically-determined parameters that cannot be included in self::getAllowedParams().
	extractRequestParams ( $parseLimit=true)
	Using getAllowedParams(), this function makes an array of the values provided by the user, with key being the name of the variable, and value - validated value from user or default.
	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.
	validateToken ( $token, array $params)
	Validate the supplied token.
	getWatchlistUser ( $params)
	Gets the user for whom to get the watchlist.
	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.
	getModuleProfileName ( $db=false)
	profileIn ()
	profileOut ()
	safeProfileOut ()
	getProfileTime ()
	profileDBIn ()
	profileDBOut ()
	getProfileDBTime ()
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 ()
	Get the Config object.
	getContext ()
	Get the base IContextSource object.
	getLanguage ()
	Get the Language object.
	getOutput ()
	Get the OutputPage object.
	getRequest ()
	Get the WebRequest object.
	getSkin ()
	Get the Skin object.
	getStats ()
	Get the Stats object.
	getTiming ()
	Get the Timing object.
	getTitle ()
	Get the Title object.
	getUser ()
	Get the User object.
	getWikiPage ()
	Get the WikiPage object.
	msg ()
	Get a Message object with context set Parameters are the same as wfMessage()
	setContext (IContextSource $context)
	Set the IContextSource object.

Protected Member Functions
	getHelpFlags ()
	getPageSet ()
	Get the PageSet object to work on.
	setContinueEnumParameter ( $paramName, $paramValue)
	Overridden to set the generator param if in generator mode.
Protected Member Functions inherited from ApiQueryBase
	getDB ()
	Get the Query database connection (read-only)
	resetQueryParams ()
	Blank the internal arrays with query parameters.
	addTables ( $tables, $alias=null)
	Add a set of tables to the internal array.
	addJoinConds ( $join_conds)
	Add a set of JOIN conditions to the internal array.
	addFields ( $value)
	Add a set of fields to select to the internal array.
	addFieldsIf ( $value, $condition)
	Same as addFields(), but add the fields only if a condition is met.
	addWhere ( $value)
	Add a set of WHERE clauses to the internal array.
	addWhereIf ( $value, $condition)
	Same as addWhere(), but add the WHERE clauses only if a condition is met.
	addWhereFld ( $field, $value)
	Equivalent to addWhere(array($field => $value))
	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.
	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.
	addOption ( $name, $value=null)
	Add an option such as LIMIT or USE INDEX.
	select ( $method, $extraQuery=[], array &$hookData=null)
	Execute a SELECT query based on the values in the internal arrays.
	processRow ( $row, array &$data, array &$hookData)
	Call the ApiQueryBaseProcessRow hook.
	addPageSubItems ( $pageId, $data)
	Add a sub-element under the page element with the given page ID.
	addPageSubItem ( $pageId, $item, $elemname=null)
	Same as addPageSubItems(), but one element of $data at a time.
Protected Member Functions inherited from ApiBase
	dieContinueUsageIf ( $condition)
	Die with the $prefix.
	getExamplesMessages ()
	Returns usage examples for this module.
	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.
	getWebUITokenSalt (array $params)
	Fetch the salt used in the Web UI corresponding to this module.
	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)
	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 of parameters of type 'timestamp'.
	setWatch ( $watch, $titleObj, $userOption=null)
	Set a watch (or unwatch) based the based on a watchlist parameter.
	getDescriptionMessage ()
	Return the description message.
	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.
	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

Private Attributes
	$mGeneratorPageSet = null

Additional Inherited Members
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.
Static Public Member Functions inherited from ApiBase
static	truncateArray (&$arr, $limit)
	Truncate an array to a certain length.
static	makeMessage ( $msg, IContextSource $context, array $params=null)
	Create a Message from a string or array.
Public Attributes inherited from ApiBase
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_SENSITIVE = 17
	(boolean) Is the parameter sensitive? Note 'password'-type fields are always sensitive regardless of the value of this field.
Static Public Attributes inherited from ApiBase
static	$messageMap
	Array that maps message keys to error messages.
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 30 of file ApiQueryGeneratorBase.php.

Member Function Documentation

encodeParamName()

ApiQueryGeneratorBase::encodeParamName

(

$paramName

)

Overrides ApiBase to prepend 'g' to every generator parameter.

Parameters

string

$paramName

Parameter name

Returns

string Prefixed parameter name

Reimplemented from ApiBase.

Definition at line 75 of file ApiQueryGeneratorBase.php.

executeGenerator()

ApiQueryGeneratorBase::executeGenerator (   $resultPageSet )

abstract

Execute this module as a generator.

Parameters

ApiPageSet

$resultPageSet

All output should be appended to this object

Reimplemented in ApiQueryAllCategories, ApiQueryAllImages, ApiQueryAllLinks, ApiQueryAllPages, ApiQueryBacklinks, ApiQueryBacklinksprop, ApiQueryCategories, ApiQueryCategoryMembers, ApiQueryDuplicateFiles, ApiQueryExtLinksUsage, ApiQueryImages, ApiQueryIWBacklinks, ApiQueryLangBacklinks, ApiQueryLinks, ApiQueryPagesWithProp, ApiQueryPrefixSearch, ApiQueryProtectedTitles, ApiQueryQueryPage, ApiQueryRandom, ApiQueryRecentChanges, ApiQueryRevisionsBase, ApiQuerySearch, ApiQueryWatchlist, and ApiQueryWatchlistRaw.

getHelpFlags()

ApiQueryGeneratorBase::getHelpFlags ( )

protected

See also

ApiBase::getHelpFlags()

Corresponding messages: api-help-flag-generator

Reimplemented from ApiBase.

Definition at line 101 of file ApiQueryGeneratorBase.php.

References $flags.

getPageSet()

ApiQueryGeneratorBase::getPageSet ( )

protected

Get the PageSet object to work on.

If this module is generator, the pageSet object is different from other module's

Returns

ApiPageSet

Reimplemented from ApiQueryBase.

Definition at line 62 of file ApiQueryGeneratorBase.php.

References $mGeneratorPageSet.

Referenced by ApiQueryCategories\run(), ApiQueryDuplicateFiles\run(), ApiQueryImages\run(), ApiQueryLinks\run(), ApiQueryBacklinksprop\run(), ApiQueryDeletedRevisions\run(), and ApiQueryRevisions\run().

isInGeneratorMode()

ApiQueryGeneratorBase::isInGeneratorMode

(

)

Indicate whether the module is in generator mode.

Since

1.28

Returns

bool

Definition at line 53 of file ApiQueryGeneratorBase.php.

setContinueEnumParameter()

ApiQueryGeneratorBase::setContinueEnumParameter (   $paramName,   $paramValue  )

protected

Overridden to set the generator param if in generator mode.

Parameters

string	$paramName	Parameter name
string | array	$paramValue	Parameter value

Reimplemented from ApiQueryBase.

Definition at line 88 of file ApiQueryGeneratorBase.php.

References ApiBase\getContinuationManager().

Referenced by ApiQueryAllCategories\run(), ApiQueryAllImages\run(), ApiQueryAllLinks\run(), ApiQueryAllPages\run(), ApiQueryCategories\run(), ApiQueryCategoryMembers\run(), ApiQueryDuplicateFiles\run(), ApiQueryExtLinksUsage\run(), ApiQueryImages\run(), ApiQueryIWBacklinks\run(), ApiQueryLangBacklinks\run(), ApiQueryLinks\run(), ApiQueryPagesWithProp\run(), ApiQueryPrefixSearch\run(), ApiQueryProtectedTitles\run(), ApiQueryQueryPage\run(), ApiQueryRandom\run(), ApiQueryRecentChanges\run(), ApiQuerySearch\run(), ApiQueryWatchlist\run(), ApiQueryWatchlistRaw\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryAllRevisions\run(), ApiQueryDeletedRevisions\run(), ApiQueryRevisions\run(), and ApiQueryBacklinksprop\setContinue().

setGeneratorMode()

ApiQueryGeneratorBase::setGeneratorMode

(

ApiPageSet

$generatorPageSet

)

Switch this module to generator mode.

By default, generator mode is switched off and the module acts like a normal query module.

Since

1.21 requires pageset parameter

Parameters

ApiPageSet

$generatorPageSet

ApiPageSet object that the module will get by calling getPageSet() when in generator mode.

Definition at line 41 of file ApiQueryGeneratorBase.php.

References ApiBase\dieDebug().

Member Data Documentation

$mGeneratorPageSet

ApiQueryGeneratorBase::$mGeneratorPageSet = null

private

Definition at line 32 of file ApiQueryGeneratorBase.php.

Referenced by getPageSet().

---

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

• includes/api/ApiQueryGeneratorBase.php