This class contains a list of pages that the client has requested. More...

Inheritance diagram for ApiPageSet:

[legend]

Collaboration diagram for ApiPageSet:

[legend]

Public Member Functions
	__construct (ApiBase $dbSource, $flags=0, $defaultNamespace=NS_MAIN)

	execute ()
	Populate the PageSet from the request parameters.

	executeDryRun ()
	In case execute() is not called, call this method to mark all relevant parameters as used This prevents unused parameters from being reported as warnings.

	getAllowedParams ( $flags=0)

	getAllTitlesByNamespace ()
	Returns an array [ns][dbkey] => page_id for all requested titles.

	getCacheMode ( $params=null)
	Get the cache mode for the data generated by this module.

	getConvertedTitles ()
	Get a list of title conversions - maps a title to its converted version.

	getConvertedTitlesAsResult ( $result=null)
	Get a list of title conversions - maps a title to its converted version as a result array.

	getCustomField ( $fieldName)
	Get the value of a custom field previously requested through requestField()

	getDataSource ()
	Return the parameter name that is the source of data for this PageSet.

	getDeletedRevisionIDs ()
	Get the list of revision IDs that were associated with deleted titles.

	getGoodAndMissingTitles ()
	Title objects for good and missing titles.

	getGoodAndMissingTitlesByNamespace ()
	Returns an array [ns][dbkey] => page_id for all good and missing titles.

	getGoodTitleCount ()
	Returns the number of found unique pages (not revisions) in the set.

	getGoodTitles ()
	Title objects that were found in the database.

	getGoodTitlesByNamespace ()
	Returns an array [ns][dbkey] => page_id for all good titles.

	getInterwikiTitles ()
	Get a list of interwiki titles - maps a title to its interwiki prefix.

	getInterwikiTitlesAsResult ( $result=null, $iwUrl=false)
	Get a list of interwiki titles - maps a title to its interwiki prefix as result.

	getInvalidTitlesAndReasons ()
	Titles that were deemed invalid by Title::newFromText() The array's index will be unique and negative for each item.

	getInvalidTitlesAndRevisions ( $invalidChecks=[ 'invalidTitles', 'special', 'missingIds', 'missingRevIds', 'missingTitles', 'interwikiTitles'])
	Get an array of invalid/special/missing titles.

	getLiveRevisionIDs ()
	Get the list of non-deleted revision IDs (requested with the revids= parameter)

	getMissingPageIDs ()
	Page IDs that were not found in the database.

	getMissingRevisionIDs ()
	Revision IDs that were not found in the database.

	getMissingRevisionIDsAsResult ( $result=null)
	Revision IDs that were not found in the database as result array.

	getMissingTitles ()
	Title objects that were NOT found in the database.

	getMissingTitlesByNamespace ()
	Returns an array [ns][dbkey] => fake_page_id for all missing titles.

	getNormalizedTitles ()
	Get a list of title normalizations - maps a title to its normalized version.

	getNormalizedTitlesAsResult ( $result=null)
	Get a list of title normalizations - maps a title to its normalized version in the form of result array.

	getPageTableFields ()
	Get the fields that have to be queried from the page table: the ones requested through requestField() and a few basic ones we always need.

	getRedirectTitles ()
	Get a list of redirect resolutions - maps a title to its redirect target, as an array of output-ready arrays.

	getRedirectTitlesAsResult ( $result=null)
	Get a list of redirect resolutions - maps a title to its redirect target.

	getRevisionCount ()
	Returns the number of revisions (requested with revids= parameter).

	getRevisionIDs ()
	Get the list of valid revision IDs (requested with the revids= parameter)

	getSpecialTitles ()
	Get the list of titles with negative namespace.

	getTitleCount ()
	Returns the number of unique pages (not revisions) in the set.

	getTitles ()
	All Title objects provided.

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

	isResolvingRedirects ()
	Check whether this PageSet is resolving redirects.

	populateFromPageIDs ( $pageIDs)
	Populate this PageSet from a list of page IDs.

	populateFromQueryResult ( $db, $queryResult)
	Populate this PageSet from a rowset returned from the database.

	populateFromRevisionIDs ( $revIDs)
	Populate this PageSet from a list of revision IDs.

	populateFromTitles ( $titles)
	Populate this PageSet from a list of Titles.

	populateGeneratorData (&$result, array $path=[])
	Populate the generator data for all titles in the result.

	processDbRow ( $row)
	Extract all requested fields from the row received from the database.

	requestField ( $fieldName)
	Request an additional field from the page table.

	setGeneratorData (Title $title, array $data)
	Set data for a title.

	setRedirectMergePolicy ( $callable)
	Controls how generator data about a redirect source is merged into the generator data for the redirect target.

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

	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 Stable to override.

	isReadMode ()
	Indicates whether this module requires read rights Stable to override.

	isWriteMode ()
	Indicates whether this module requires write mode.

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

	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 Stable to override.

	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 Stable to override.

	getContinuationManager ()
	Get the continuation manager.

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

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

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

	extractRequestParams ( $options=[])
	Using getAllowedParams(), this function makes an array of the values provided by the user, with key being the name of the variable, and value - validated value from user or default.

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

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

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

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

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

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

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

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

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

	addBlockInfoToStatus (StatusValue $status, User $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 (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.

	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 (LinkTarget $linkTarget, $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.

	getConfig ()

	getContext ()
	Get the base IContextSource object.

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getStats ()

	getTiming ()

	getTitle ()

	getUser ()
	Stable to override.

	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
	getDB ()
	Get the database connection (read-only)

Protected Member Functions inherited from ApiBase
	explodeMultiValue ( $value, $limit)
	Split a multi-valued parameter string, like explode()

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

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

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

	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.

	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
	executeInternal ( $isDryRun)
	Populate the PageSet from the request parameters.

	getGenerators ()
	Get an array of all available generators.

	getRedirectTargets ()
	Get the targets of the pending redirects from the database.

	initFromPageIds ( $pageids, $filterIds=true)
	Does the same as initFromTitles(), but is based on page IDs instead.

	initFromQueryResult ( $res, &$remaining=null, $processTitles=null)
	Iterate through the result of the query on 'page' table, and for each row create and store title object and save any extra fields requested.

	initFromRevIDs ( $revids)
	Does the same as initFromTitles(), but is based on revision IDs instead.

	initFromTitles ( $titles)
	This method populates internal variables with page information based on the given array of title strings.

	processTitlesArray ( $titles)
	Given an array of title strings, convert them into Title objects.

	resolvePendingRedirects ()
	Resolve any redirects in the result if redirect resolution was requested.

	resolveRedirectTitleDest (Title $titleFrom)
	Resolve the title a redirect points to.

Static Private Member Functions
static	addValues (array &$result, $values, $flags=[], $name=null)
	Add all items from $values into the result.

Private Attributes
	$mAllowGenerator

	$mAllPages = []

	$mAllSpecials = []

	$mCacheMode = 'public'

	$mConvertedTitles = []

	$mConvertTitles

	$mDbSource

int	$mDefaultNamespace = NS_MAIN

	$mDeletedRevIDs = []

	$mFakePageId = -1

	$mGeneratorData = []

	$mGoodAndMissingPages = []

	$mGoodPages = []

	$mGoodRevIDs = []

	$mGoodTitles = []

	$mInterwikiTitles = []

array	$mInvalidTitles = []
	[fake_page_id] => [ 'title' => $title, 'invalidreason' => $reason ]

	$mLiveRevIDs = []

	$mMissingPageIDs = []

	$mMissingPages = []

	$mMissingRevIDs = []

	$mMissingTitles = []

	$mNormalizedTitles = []

	$mParams = []

Title[]	$mPendingRedirectIDs = []

	$mPendingRedirectSpecialPages = []

callable null	$mRedirectMergePolicy

	$mRedirectTitles = []

array	$mRequestedPageFields = []

	$mResolvedRedirectTitles = []

	$mResolveRedirects

	$mSpecialTitles = []

	$mTitles = []

const	DISABLE_GENERATORS = 1
	Constructor flag: The new instance of ApiPageSet will ignore the 'generator=' parameter.

Static Private Attributes
static	$generators = null

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	ALL_DEFAULT_STRING = '*'

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

const	LIMIT_BIG1 = 500
	Fast query, standard limit.

const	LIMIT_BIG2 = 5000
	Fast query, apihighlimits limit.

const	LIMIT_SML1 = 50
	Slow query, standard limit.

const	LIMIT_SML2 = 500
	Slow query, apihighlimits limit.

const	PARAM_DFLT = 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_RANGE_ENFORCE = 'api-param-range-enforce'
	(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE

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.

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

Detailed Description

This class contains a list of pages that the client has requested.

Initially, when the client passes in titles=, pageids=, or revisions= parameter, an instance of the ApiPageSet class will normalize titles, determine if the pages/revisions exist, and prefetch any additional page data requested.

When a generator is used, the result of the generator will become the input for the second instance of this class, and all subsequent actions will use the second instance for all their work.

Since: 1.21 derives from ApiBase instead of ApiQueryBase

Definition at line 42 of file ApiPageSet.php.

Constructor & Destructor Documentation

◆ __construct()

ApiPageSet::__construct	(	ApiBase	$dbSource,
			$flags = `0`,
			$defaultNamespace = `NS_MAIN`
	)

Parameters

ApiBase	$dbSource	Module implementing getDB(). Allows PageSet to reuse existing db connection from the shared state like ApiQuery.
int	$flags	Zero or more flags like DISABLE_GENERATORS
int	$defaultNamespace	The namespace to use if none is specified by a prefix.

Since: 1.21 accepts $flags instead of two boolean values

Definition at line 120 of file ApiPageSet.php.

References ApiBase\extractRequestParams(), ApiBase\getMain(), and ApiBase\getModuleName().

Member Function Documentation

◆ addValues()

static ApiPageSet::addValues	(	array &	$result,
			$values,
			$flags = `[]`,
			$name = `null`
	)

staticprivate

Add all items from $values into the result.

Parameters

array	&$result	Output
array	$values	Values to add
string[]	$flags	The names of boolean flags to mark this element
string \| null	$name	If given, name of the value

Definition at line 96 of file ApiPageSet.php.

◆ execute()

ApiPageSet::execute ( )

Populate the PageSet from the request parameters.

Reimplemented from ApiBase.

Definition at line 142 of file ApiPageSet.php.

References executeInternal().

◆ executeDryRun()

ApiPageSet::executeDryRun ( )

In case execute() is not called, call this method to mark all relevant parameters as used This prevents unused parameters from being reported as warnings.

Definition at line 135 of file ApiPageSet.php.

References executeInternal().

◆ executeInternal()

ApiPageSet::executeInternal ( $isDryRun )

private

Populate the PageSet from the request parameters.

Parameters

bool $isDryRun If true, instantiates generator, but only to mark relevant parameters as used

Definition at line 151 of file ApiPageSet.php.

References $generator, ApiBase\addWarning(), ApiBase\dieWithError(), ApiBase\encodeParamName(), ApiBase\getHookRunner(), ApiBase\getMain(), initFromPageIds(), initFromRevIDs(), initFromTitles(), and resolvePendingRedirects().

Referenced by execute(), and executeDryRun().

◆ getAllowedParams()

ApiPageSet::getAllowedParams ( $flags = 0 )

Definition at line 1452 of file ApiPageSet.php.

References ApiBase\GET_VALUES_FOR_HELP, Message\listParam(), ApiBase\PARAM_DFLT, ApiBase\PARAM_HELP_MSG, ApiBase\PARAM_ISMULTI, ApiBase\PARAM_SUBMODULE_MAP, ApiBase\PARAM_SUBMODULE_PARAM_PREFIX, and ApiBase\PARAM_TYPE.

◆ getAllTitlesByNamespace()

ApiPageSet::getAllTitlesByNamespace ( )

Returns an array [ns][dbkey] => page_id for all requested titles.

page_id is a unique negative number in case title was not found. Invalid titles will also have negative page IDs and will be in namespace 0

Returns: array

Definition at line 342 of file ApiPageSet.php.

◆ getCacheMode()

ApiPageSet::getCacheMode ( $params = null )

Get the cache mode for the data generated by this module.

All PageSet users should take into account whether this returns a more-restrictive cache mode than the using module itself. For possible return values and other details about cache modes, see ApiMain::setCacheMode()

Public caching will only be allowed if all the modules that supply data for a given request return a cache mode of public.

Parameters

array | null $params

Returns: string

Since: 1.21

Definition at line 1152 of file ApiPageSet.php.

◆ getConvertedTitles()

ApiPageSet::getConvertedTitles ( )

Get a list of title conversions - maps a title to its converted version.

Returns: array Array of raw_prefixed_title (string) => prefixed_title (string)

Definition at line 523 of file ApiPageSet.php.

Referenced by getConvertedTitlesAsResult().

◆ getConvertedTitlesAsResult()

ApiPageSet::getConvertedTitlesAsResult ( $result = null )

Get a list of title conversions - maps a title to its converted version as a result array.

Parameters

ApiResult | null $result

Returns: array Array of (from, to) strings

Since: 1.21

Definition at line 534 of file ApiPageSet.php.

References getConvertedTitles().

◆ getCustomField()

ApiPageSet::getCustomField ( $fieldName )

Get the value of a custom field previously requested through requestField()

Parameters

string $fieldName Field name

Returns: mixed Field value

Definition at line 298 of file ApiPageSet.php.

◆ getDataSource()

ApiPageSet::getDataSource ( )

Return the parameter name that is the source of data for this PageSet.

If multiple source parameters are specified (e.g. titles and pageids), one will be named arbitrarily.

Returns: string|null

Definition at line 266 of file ApiPageSet.php.

◆ getDB()

ApiPageSet::getDB ( )

protected

Get the database connection (read-only)

Returns: IDatabase

Reimplemented from ApiBase.

Definition at line 1448 of file ApiPageSet.php.

◆ getDeletedRevisionIDs()

ApiPageSet::getDeletedRevisionIDs ( )

Get the list of revision IDs that were associated with deleted titles.

Returns: array Array of revID (int) => pageID (int)

Definition at line 666 of file ApiPageSet.php.

◆ getGenerators()

ApiPageSet::getGenerators ( )

private

Get an array of all available generators.

Returns: array

Definition at line 1521 of file ApiPageSet.php.

◆ getGoodAndMissingTitles()

ApiPageSet::getGoodAndMissingTitles ( )

Title objects for good and missing titles.

Returns: Title[]

Definition at line 416 of file ApiPageSet.php.

◆ getGoodAndMissingTitlesByNamespace()

ApiPageSet::getGoodAndMissingTitlesByNamespace ( )

Returns an array [ns][dbkey] => page_id for all good and missing titles.

Returns: array

Definition at line 408 of file ApiPageSet.php.

◆ getGoodTitleCount()

ApiPageSet::getGoodTitleCount ( )

Returns the number of found unique pages (not revisions) in the set.

Returns: int

Definition at line 382 of file ApiPageSet.php.

◆ getGoodTitles()

ApiPageSet::getGoodTitles ( )

Title objects that were found in the database.

Returns: Title[] Array page_id (int) => Title (obj)

Definition at line 374 of file ApiPageSet.php.

◆ getGoodTitlesByNamespace()

ApiPageSet::getGoodTitlesByNamespace ( )

Returns an array [ns][dbkey] => page_id for all good titles.

Returns: array

Definition at line 366 of file ApiPageSet.php.

◆ getInterwikiTitles()

ApiPageSet::getInterwikiTitles ( )

Get a list of interwiki titles - maps a title to its interwiki prefix.

Returns: array Array of raw_prefixed_title (string) => interwiki_prefix (string)

Definition at line 554 of file ApiPageSet.php.

Referenced by getInterwikiTitlesAsResult().

◆ getInterwikiTitlesAsResult()

ApiPageSet::getInterwikiTitlesAsResult	(	$result = `null`,
		$iwUrl = `false`
	)

Get a list of interwiki titles - maps a title to its interwiki prefix as result.

Parameters

ApiResult \| null	$result
bool	$iwUrl

Returns: array Array of raw_prefixed_title (string) => interwiki_prefix (string)

Since: 1.21

Definition at line 566 of file ApiPageSet.php.

References $title, getInterwikiTitles(), and PROTO_CURRENT.

Referenced by getInvalidTitlesAndRevisions().

◆ getInvalidTitlesAndReasons()

ApiPageSet::getInvalidTitlesAndReasons ( )

Titles that were deemed invalid by Title::newFromText() The array's index will be unique and negative for each item.

Returns: array[] Array of arrays with 'title' and 'invalidreason' properties

Definition at line 425 of file ApiPageSet.php.

Referenced by getInvalidTitlesAndRevisions().

◆ getInvalidTitlesAndRevisions()

ApiPageSet::getInvalidTitlesAndRevisions ( $invalidChecks = [ 'invalidTitles', 'special', 'missingIds', 'missingRevIds', 'missingTitles', 'interwikiTitles' ] )

Get an array of invalid/special/missing titles.

Parameters

array

$invalidChecks

List of types of invalid titles to include. Recognized values are:

invalidTitles: Titles and reasons from $this->getInvalidTitlesAndReasons()
special: Titles from $this->getSpecialTitles()
missingIds: ids from $this->getMissingPageIDs()
missingRevIds: ids from $this->getMissingRevisionIDs()
missingTitles: Titles from $this->getMissingTitles()
interwikiTitles: Titles from $this->getInterwikiTitlesAsResult()

Returns: array Array suitable for inclusion in the response

Since: 1.23

Definition at line 600 of file ApiPageSet.php.

References $title, getInterwikiTitlesAsResult(), getInvalidTitlesAndReasons(), getMissingPageIDs(), getMissingRevisionIDs(), getMissingTitles(), and getSpecialTitles().

◆ getLiveRevisionIDs()

ApiPageSet::getLiveRevisionIDs ( )

Get the list of non-deleted revision IDs (requested with the revids= parameter)

Returns: array Array of revID (int) => pageID (int)

Definition at line 658 of file ApiPageSet.php.

◆ getMissingPageIDs()

ApiPageSet::getMissingPageIDs ( )

Page IDs that were not found in the database.

Returns: array Array of page IDs

Definition at line 433 of file ApiPageSet.php.

Referenced by getInvalidTitlesAndRevisions().

◆ getMissingRevisionIDs()

ApiPageSet::getMissingRevisionIDs ( )

Revision IDs that were not found in the database.

Returns: array Array of revision IDs

Definition at line 674 of file ApiPageSet.php.

Referenced by getInvalidTitlesAndRevisions(), and getMissingRevisionIDsAsResult().

◆ getMissingRevisionIDsAsResult()

ApiPageSet::getMissingRevisionIDsAsResult ( $result = null )

Revision IDs that were not found in the database as result array.

Parameters

ApiResult | null $result

Returns: array Array of revision IDs

Since: 1.21

Definition at line 684 of file ApiPageSet.php.

References getMissingRevisionIDs().

◆ getMissingTitles()

ApiPageSet::getMissingTitles ( )

Title objects that were NOT found in the database.

The array's index will be negative for each item

Returns: Title[]

Definition at line 400 of file ApiPageSet.php.

Referenced by getInvalidTitlesAndRevisions().

◆ getMissingTitlesByNamespace()

ApiPageSet::getMissingTitlesByNamespace ( )

Returns an array [ns][dbkey] => fake_page_id for all missing titles.

fake_page_id is a unique negative number.

Returns: array

Definition at line 391 of file ApiPageSet.php.

◆ getNormalizedTitles()

ApiPageSet::getNormalizedTitles ( )

Get a list of title normalizations - maps a title to its normalized version.

Returns: array Array of raw_prefixed_title (string) => prefixed_title (string)

Definition at line 489 of file ApiPageSet.php.

Referenced by getNormalizedTitlesAsResult().

◆ getNormalizedTitlesAsResult()

ApiPageSet::getNormalizedTitlesAsResult ( $result = null )

Get a list of title normalizations - maps a title to its normalized version in the form of result array.

Parameters

ApiResult | null $result

Returns: array Array of raw_prefixed_title (string) => prefixed_title (string)

Since: 1.21

Definition at line 500 of file ApiPageSet.php.

References getNormalizedTitles().

◆ getPageTableFields()

ApiPageSet::getPageTableFields ( )

Get the fields that have to be queried from the page table: the ones requested through requestField() and a few basic ones we always need.

Returns: array Array of field names

Definition at line 308 of file ApiPageSet.php.

References ContextSource\getConfig().

Referenced by initFromPageIds(), initFromTitles(), and resolvePendingRedirects().

◆ getRedirectTargets()

ApiPageSet::getRedirectTargets ( )

private

Get the targets of the pending redirects from the database.

Also creates entries in the redirect table for redirects that don't have one.

Returns: LinkBatch

Definition at line 1057 of file ApiPageSet.php.

References $res, $title, getDB(), Title\getPrefixedText(), and processTitlesArray().

Referenced by resolvePendingRedirects().

◆ getRedirectTitles()

ApiPageSet::getRedirectTitles ( )

Get a list of redirect resolutions - maps a title to its redirect target, as an array of output-ready arrays.

Returns: Title[]

Definition at line 442 of file ApiPageSet.php.

Referenced by getRedirectTitlesAsResult().

◆ getRedirectTitlesAsResult()

ApiPageSet::getRedirectTitlesAsResult ( $result = null )

Get a list of redirect resolutions - maps a title to its redirect target.

Includes generator data for redirect source when available.

Parameters

ApiResult | null $result

Returns: array Array of prefixed_title (string) => Title object

Since: 1.21

Definition at line 453 of file ApiPageSet.php.

References getRedirectTitles().

◆ getRevisionCount()

ApiPageSet::getRevisionCount ( )

Returns the number of revisions (requested with revids= parameter).

Returns: int Number of revisions.

Definition at line 711 of file ApiPageSet.php.

References getRevisionIDs().

◆ getRevisionIDs()

ApiPageSet::getRevisionIDs ( )

Get the list of valid revision IDs (requested with the revids= parameter)

Returns: array Array of revID (int) => pageID (int)

Definition at line 650 of file ApiPageSet.php.

Referenced by getRevisionCount().

◆ getSpecialTitles()

ApiPageSet::getSpecialTitles ( )

Get the list of titles with negative namespace.

Returns: Title[]

Definition at line 703 of file ApiPageSet.php.

Referenced by getInvalidTitlesAndRevisions().

◆ getTitleCount()

ApiPageSet::getTitleCount ( )

Returns the number of unique pages (not revisions) in the set.

Returns: int

Definition at line 358 of file ApiPageSet.php.

◆ getTitles()

ApiPageSet::getTitles ( )

All Title objects provided.

Returns: Title[]

Definition at line 350 of file ApiPageSet.php.

◆ handleParamNormalization()

ApiPageSet::handleParamNormalization	(	$paramName,
		$value,
		$rawValue
	)

Handle when a parameter was Unicode-normalized.

Since: 1.28; 1.35 $paramName is prefixed

Reimplemented from ApiBase.

Definition at line 1498 of file ApiPageSet.php.

◆ initFromPageIds()

ApiPageSet::initFromPageIds	(	$pageids,
		$filterIds = `true`
	)

private

Does the same as initFromTitles(), but is based on page IDs instead.

Parameters

array	$pageids	Array of page IDs
bool	$filterIds	Whether the IDs need filtering

Definition at line 824 of file ApiPageSet.php.

References $res, ApiBase\filterIDs(), getDB(), getPageTableFields(), initFromQueryResult(), and resolvePendingRedirects().

Referenced by executeInternal(), initFromRevIDs(), and populateFromPageIDs().

◆ initFromQueryResult()

ApiPageSet::initFromQueryResult	(		$res,
		&	$remaining = `null`,
			$processTitles = `null`
	)

private

Iterate through the result of the query on 'page' table, and for each row create and store title object and save any extra fields requested.

Parameters

IResultWrapper	$res	DB Query result
array \| null	&$remaining	Array of either pageID or ns/title elements (optional). If given, any missing items will go to $mMissingPageIDs and $mMissingTitles
bool \| null	$processTitles	Must be provided together with $remaining. If true, treat $remaining as an array of [ns][title] If false, treat it as an array of [pageIDs]

Definition at line 864 of file ApiPageSet.php.

References $res, $title, ApiBase\dieDebug(), and processDbRow().

Referenced by initFromPageIds(), initFromTitles(), populateFromQueryResult(), and resolvePendingRedirects().

◆ initFromRevIDs()

ApiPageSet::initFromRevIDs ( $revids )

private

Does the same as initFromTitles(), but is based on revision IDs instead.

Parameters

array $revids Array of revision IDs

Definition at line 937 of file ApiPageSet.php.

References $res, $title, ApiBase\filterIDs(), getDB(), getPermissionManager(), getUser(), initFromPageIds(), and initFromTitles().

Referenced by executeInternal(), and populateFromRevisionIDs().

◆ initFromTitles()

ApiPageSet::initFromTitles ( $titles )

private

This method populates internal variables with page information based on the given array of title strings.

Steps: #1 For each title, get data from page table #2 If page was not found in the DB, store it as missing

Additionally, when resolving redirects: #3 If no more redirects left, stop. #4 For each redirect, get its target from the redirect table. #5 Substitute the original LinkBatch object with the new list #6 Repeat from step #1

Parameters

array $titles Array of Title objects or strings

Definition at line 796 of file ApiPageSet.php.

References $res, getDB(), getPageTableFields(), initFromQueryResult(), processTitlesArray(), and resolvePendingRedirects().

Referenced by executeInternal(), initFromRevIDs(), and populateFromTitles().

◆ isResolvingRedirects()

ApiPageSet::isResolvingRedirects ( )

Check whether this PageSet is resolving redirects.

Returns: bool

Definition at line 254 of file ApiPageSet.php.

◆ populateFromPageIDs()

ApiPageSet::populateFromPageIDs ( $pageIDs )

Populate this PageSet from a list of page IDs.

Parameters

array $pageIDs Array of page IDs

Definition at line 727 of file ApiPageSet.php.

References initFromPageIds().

◆ populateFromQueryResult()

ApiPageSet::populateFromQueryResult	(	$db,
		$queryResult
	)

Populate this PageSet from a rowset returned from the database.

Note that the query result must include the columns returned by $this->getPageTableFields().

Parameters

IDatabase	$db
IResultWrapper	$queryResult

Definition at line 740 of file ApiPageSet.php.

References initFromQueryResult().

◆ populateFromRevisionIDs()

ApiPageSet::populateFromRevisionIDs ( $revIDs )

Populate this PageSet from a list of revision IDs.

Parameters

array $revIDs Array of revision IDs

Definition at line 748 of file ApiPageSet.php.

References initFromRevIDs().

◆ populateFromTitles()

ApiPageSet::populateFromTitles ( $titles )

Populate this PageSet from a list of Titles.

Parameters

array $titles Array of Title objects

Definition at line 719 of file ApiPageSet.php.

References initFromTitles().

◆ populateGeneratorData()

ApiPageSet::populateGeneratorData	(	&	$result,
		array	$path = `[]`
	)

Populate the generator data for all titles in the result.

The page data may be inserted into an ApiResult object or into an associative array. The $path parameter specifies the path within the ApiResult or array to find the "pages" node.

The "pages" node itself must be an associative array mapping the page ID or fake page ID values returned by this pageset (see self::getAllTitlesByNamespace() and self::getSpecialTitles()) to associative arrays of page data. Each of those subarrays will have the data from self::setGeneratorData() merged in.

Data that was set by self::setGeneratorData() for pages not in the "pages" node will be ignored.

Parameters

ApiResult \| array	&$result
array	$path

Returns: bool Whether the data fit

Definition at line 1361 of file ApiPageSet.php.

References $path, $title, ApiResult\addValue(), and NS_SPECIAL.

◆ processDbRow()

ApiPageSet::processDbRow ( $row )

Extract all requested fields from the row received from the database.

Parameters

stdClass $row Result row

Definition at line 756 of file ApiPageSet.php.

References $title.

Referenced by initFromQueryResult().

◆ processTitlesArray()

ApiPageSet::processTitlesArray ( $titles )

private

Given an array of title strings, convert them into Title objects.

Alternatively, an array of Title objects may be given. This method validates access rights for the title, and appends normalization values to the output.

Parameters

array $titles Array of Title objects or strings

Returns: LinkBatch

Definition at line 1165 of file ApiPageSet.php.

References ContextSource\$context, $title, ApiBase\getErrorFormatter(), and NS_SPECIAL.

Referenced by getRedirectTargets(), and initFromTitles().

◆ requestField()

ApiPageSet::requestField ( $fieldName )

Request an additional field from the page table.

Must be called before execute()

Parameters

string $fieldName Field name

Definition at line 288 of file ApiPageSet.php.

◆ resolvePendingRedirects()

ApiPageSet::resolvePendingRedirects ( )

private

Resolve any redirects in the result if redirect resolution was requested.

This function is called repeatedly until all redirects have been resolved.

Definition at line 1020 of file ApiPageSet.php.

References $res, getDB(), getPageTableFields(), getRedirectTargets(), and initFromQueryResult().

Referenced by executeInternal(), initFromPageIds(), and initFromTitles().

◆ resolveRedirectTitleDest()

ApiPageSet::resolveRedirectTitleDest ( Title $titleFrom )

private

Resolve the title a redirect points to.

Will follow sequential redirects to find the final page. In the case of a redirect cycle the original page will be returned. self::resolvePendingRedirects must be executed before calling this method.

Parameters

Title $titleFrom A title from $this->mResolvedRedirectTitles

Returns: Title

Definition at line 1328 of file ApiPageSet.php.

◆ setGeneratorData()

ApiPageSet::setGeneratorData	(	Title	$title,
		array	$data
	)

Set data for a title.

This data may be extracted into an ApiResult using self::populateGeneratorData. This should generally be limited to data that is likely to be particularly useful to end users rather than just being a dump of everything returned in non-generator mode.

Redirects here will not be followed, even if 'redirects' was specified, since in the case of multiple redirects we can't know which source's data to use on the target.

Parameters

Title	$title
array	$data

Definition at line 1288 of file ApiPageSet.php.

References $title.

◆ setRedirectMergePolicy()

ApiPageSet::setRedirectMergePolicy ( $callable )

Controls how generator data about a redirect source is merged into the generator data for the redirect target.

When not set no data is merged. Note that if multiple titles redirect to the same target the order of operations is undefined.

Example to include generated data from redirect in target, prefering the data generated for the destination when there is a collision:

$pageSet->setRedirectMergePolicy( function( array $current, array $new ) {
    return $current + $new;
} );

Parameters

callable | null $callable Recieves two array arguments, first the generator data for the redirect target and second the generator data for the redirect source. Returns the resulting generator data to use for the redirect target.

Definition at line 1313 of file ApiPageSet.php.

Member Data Documentation

◆ $generators

ApiPageSet::$generators = null

staticprivate

Definition at line 1515 of file ApiPageSet.php.

◆ $mAllowGenerator

ApiPageSet::$mAllowGenerator

private

Definition at line 53 of file ApiPageSet.php.

◆ $mAllPages

ApiPageSet::$mAllPages = []

private

Definition at line 55 of file ApiPageSet.php.

◆ $mAllSpecials

ApiPageSet::$mAllSpecials = []

private

Definition at line 67 of file ApiPageSet.php.

◆ $mCacheMode

ApiPageSet::$mCacheMode = 'public'

private

Definition at line 81 of file ApiPageSet.php.

◆ $mConvertedTitles

ApiPageSet::$mConvertedTitles = []

private

Definition at line 74 of file ApiPageSet.php.

◆ $mConvertTitles

ApiPageSet::$mConvertTitles

private

Definition at line 52 of file ApiPageSet.php.

◆ $mDbSource

ApiPageSet::$mDbSource

private

Definition at line 49 of file ApiPageSet.php.

◆ $mDefaultNamespace

int ApiPageSet::$mDefaultNamespace = NS_MAIN

private

Definition at line 85 of file ApiPageSet.php.

◆ $mDeletedRevIDs

ApiPageSet::$mDeletedRevIDs = []

private

Definition at line 77 of file ApiPageSet.php.

◆ $mFakePageId

ApiPageSet::$mFakePageId = -1

private

Definition at line 80 of file ApiPageSet.php.

◆ $mGeneratorData

ApiPageSet::$mGeneratorData = []

private

Definition at line 79 of file ApiPageSet.php.

◆ $mGoodAndMissingPages

ApiPageSet::$mGoodAndMissingPages = []

private

Definition at line 57 of file ApiPageSet.php.

◆ $mGoodPages

ApiPageSet::$mGoodPages = []

private

Definition at line 58 of file ApiPageSet.php.

◆ $mGoodRevIDs

ApiPageSet::$mGoodRevIDs = []

private

Definition at line 75 of file ApiPageSet.php.

◆ $mGoodTitles

ApiPageSet::$mGoodTitles = []

private

Definition at line 59 of file ApiPageSet.php.

◆ $mInterwikiTitles

ApiPageSet::$mInterwikiTitles = []

private

Definition at line 69 of file ApiPageSet.php.

◆ $mInvalidTitles

array ApiPageSet::$mInvalidTitles = []

private

[fake_page_id] => [ 'title' => $title, 'invalidreason' => $reason ]

Definition at line 63 of file ApiPageSet.php.

◆ $mLiveRevIDs

ApiPageSet::$mLiveRevIDs = []

private

Definition at line 76 of file ApiPageSet.php.

◆ $mMissingPageIDs

ApiPageSet::$mMissingPageIDs = []

private

Definition at line 64 of file ApiPageSet.php.

◆ $mMissingPages

ApiPageSet::$mMissingPages = []

private

Definition at line 60 of file ApiPageSet.php.

◆ $mMissingRevIDs

ApiPageSet::$mMissingRevIDs = []

private

Definition at line 78 of file ApiPageSet.php.

◆ $mMissingTitles

ApiPageSet::$mMissingTitles = []

private

Definition at line 61 of file ApiPageSet.php.

◆ $mNormalizedTitles

ApiPageSet::$mNormalizedTitles = []

private

Definition at line 68 of file ApiPageSet.php.

◆ $mParams

ApiPageSet::$mParams = []

private

Definition at line 50 of file ApiPageSet.php.

◆ $mPendingRedirectIDs

Title [] ApiPageSet::$mPendingRedirectIDs = []

private

Definition at line 71 of file ApiPageSet.php.

◆ $mPendingRedirectSpecialPages

ApiPageSet::$mPendingRedirectSpecialPages = []

private

Definition at line 72 of file ApiPageSet.php.

◆ $mRedirectMergePolicy

callable null ApiPageSet::$mRedirectMergePolicy

private

Definition at line 87 of file ApiPageSet.php.

◆ $mRedirectTitles

ApiPageSet::$mRedirectTitles = []

private

Definition at line 65 of file ApiPageSet.php.

◆ $mRequestedPageFields

array ApiPageSet::$mRequestedPageFields = []

private

Definition at line 83 of file ApiPageSet.php.

◆ $mResolvedRedirectTitles

ApiPageSet::$mResolvedRedirectTitles = []

private

Definition at line 73 of file ApiPageSet.php.

◆ $mResolveRedirects

ApiPageSet::$mResolveRedirects

private

Definition at line 51 of file ApiPageSet.php.

◆ $mSpecialTitles

ApiPageSet::$mSpecialTitles = []

private

Definition at line 66 of file ApiPageSet.php.

◆ $mTitles

ApiPageSet::$mTitles = []

private

Definition at line 56 of file ApiPageSet.php.

◆ DISABLE_GENERATORS

const ApiPageSet::DISABLE_GENERATORS = 1

private

Constructor flag: The new instance of ApiPageSet will ignore the 'generator=' parameter.

Since: 1.21

Definition at line 47 of file ApiPageSet.php.

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

includes/api/ApiPageSet.php

Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addValues()

◆ execute()

◆ executeDryRun()

◆ executeInternal()

◆ getAllowedParams()

◆ getAllTitlesByNamespace()

◆ getCacheMode()

◆ getConvertedTitles()

◆ getConvertedTitlesAsResult()

◆ getCustomField()

◆ getDataSource()

◆ getDB()

◆ getDeletedRevisionIDs()

◆ getGenerators()

◆ getGoodAndMissingTitles()

◆ getGoodAndMissingTitlesByNamespace()

◆ getGoodTitleCount()

◆ getGoodTitles()

◆ getGoodTitlesByNamespace()

◆ getInterwikiTitles()

◆ getInterwikiTitlesAsResult()

◆ getInvalidTitlesAndReasons()

◆ getInvalidTitlesAndRevisions()

◆ getLiveRevisionIDs()

◆ getMissingPageIDs()

◆ getMissingRevisionIDs()

◆ getMissingRevisionIDsAsResult()

◆ getMissingTitles()

◆ getMissingTitlesByNamespace()

◆ getNormalizedTitles()

◆ getNormalizedTitlesAsResult()

◆ getPageTableFields()

◆ getRedirectTargets()

◆ getRedirectTitles()

◆ getRedirectTitlesAsResult()

◆ getRevisionCount()

◆ getRevisionIDs()

◆ getSpecialTitles()

◆ getTitleCount()

◆ getTitles()

◆ handleParamNormalization()

◆ initFromPageIds()

◆ initFromQueryResult()

◆ initFromRevIDs()

◆ initFromTitles()

◆ isResolvingRedirects()

◆ populateFromPageIDs()

◆ populateFromQueryResult()

◆ populateFromRevisionIDs()

◆ populateFromTitles()

◆ populateGeneratorData()

◆ processDbRow()

◆ processTitlesArray()

◆ requestField()

◆ resolvePendingRedirects()

◆ resolveRedirectTitleDest()

◆ setGeneratorData()

◆ setRedirectMergePolicy()

Member Data Documentation

◆ $generators

◆ $mAllowGenerator

◆ $mAllPages

◆ $mAllSpecials

◆ $mCacheMode

◆ $mConvertedTitles

◆ $mConvertTitles

◆ $mDbSource

◆ $mDefaultNamespace

◆ $mDeletedRevIDs