93 private static function addValues( array &$result, $values, $flags = [], $name =
null ) {
94 foreach ( $values as $val ) {
95 if ( $val instanceof
Title ) {
98 } elseif ( $name !==
null ) {
99 $v = [ $name => $val ];
103 foreach ( $flags as $flag ) {
118 parent::__construct( $dbSource->getMain(), $dbSource->getModuleName() );
119 $this->mDbSource = $dbSource;
121 $this->mDefaultNamespace = $defaultNamespace;
124 $this->mResolveRedirects = $this->mParams[
'redirects'];
125 $this->mConvertTitles = $this->mParams[
'converttitles'];
149 $generatorName = $this->mAllowGenerator ? $this->mParams[
'generator'] :
null;
150 if ( isset( $generatorName ) ) {
152 if ( !$dbSource instanceof
ApiQuery ) {
154 $dbSource = $this->
getMain()->getModuleManager()->getModule(
'query' );
156 $generator = $dbSource->getModuleManager()->getModule( $generatorName,
null,
true );
158 $this->
dieWithError( [
'apierror-badgenerator-unknown', $generatorName ],
'badgenerator' );
161 $this->
dieWithError( [
'apierror-badgenerator-notgenerator', $generatorName ],
'badgenerator' );
165 $tmpPageSet =
new ApiPageSet( $dbSource, self::DISABLE_GENERATORS );
172 $tmpPageSet->executeInternal( $isDryRun );
180 Hooks::run(
'APIQueryGeneratorAfterExecute', [ &
$generator, &$apiModule ] );
184 foreach (
$generator->extractRequestParams() as $paramName => $param ) {
185 $main->markParamsUsed(
$generator->encodeParamName( $paramName ) );
195 if ( isset( $this->mParams[
'titles'] ) ) {
196 $dataSource =
'titles';
198 if ( isset( $this->mParams[
'pageids'] ) ) {
199 if ( isset( $dataSource ) ) {
202 'apierror-invalidparammix-cannotusewith',
209 $dataSource =
'pageids';
211 if ( isset( $this->mParams[
'revids'] ) ) {
212 if ( isset( $dataSource ) ) {
215 'apierror-invalidparammix-cannotusewith',
222 $dataSource =
'revids';
227 switch ( $dataSource ) {
235 if ( $this->mResolveRedirects ) {
236 $this->
addWarning(
'apiwarn-redirectsandrevids' );
238 $this->mResolveRedirects =
false;
266 if ( $this->mAllowGenerator && isset( $this->mParams[
'generator'] ) ) {
269 if ( isset( $this->mParams[
'titles'] ) ) {
272 if ( isset( $this->mParams[
'pageids'] ) ) {
275 if ( isset( $this->mParams[
'revids'] ) ) {
288 $this->mRequestedPageFields[$fieldName] =
null;
298 return $this->mRequestedPageFields[$fieldName];
311 'page_namespace' =>
null,
312 'page_title' =>
null,
316 if ( $this->mResolveRedirects ) {
317 $pageFlds[
'page_is_redirect'] =
null;
320 if ( $this->
getConfig()->
get(
'ContentHandlerUseDB' ) ) {
321 $pageFlds[
'page_content_model'] =
null;
324 if ( $this->
getConfig()->
get(
'PageLanguageUseDB' ) ) {
325 $pageFlds[
'page_lang'] =
null;
328 foreach ( LinkCache::getSelectFields() as $field ) {
329 $pageFlds[$field] =
null;
332 $pageFlds = array_merge( $pageFlds, $this->mRequestedPageFields );
334 return array_keys( $pageFlds );
360 return count( $this->mTitles );
384 return count( $this->mGoodTitles );
429 return array_map(
function (
$t ) {
471 'from' => strval( $titleStrFrom ),
472 'to' => $titleTo->getPrefixedText(),
474 if ( $titleTo->hasFragment() ) {
475 $r[
'tofragment'] = $titleTo->getFragment();
477 if ( $titleTo->isExternal() ) {
478 $r[
'tointerwiki'] = $titleTo->getInterwiki();
480 if ( isset( $this->mResolvedRedirectTitles[$titleStrFrom] ) ) {
481 $titleFrom = $this->mResolvedRedirectTitles[$titleStrFrom];
482 $ns = $titleFrom->getNamespace();
483 $dbkey = $titleFrom->getDBkey();
484 if ( isset( $this->mGeneratorData[$ns][$dbkey] ) ) {
485 $r = array_merge( $this->mGeneratorData[$ns][$dbkey], $r );
491 if ( !empty( $values ) && $result ) {
519 $encode = (
$wgContLang->normalize( $rawTitleStr ) !== $rawTitleStr );
521 'fromencoded' => $encode,
522 'from' => $encode ? rawurlencode( $rawTitleStr ) : $rawTitleStr,
526 if ( !empty( $values ) && $result ) {
553 'from' => $rawTitleStr,
557 if ( !empty( $values ) && $result ) {
585 'title' => $rawTitleStr,
586 'iw' => $interwikiStr,
589 $title = Title::newFromText( $rawTitleStr );
590 $item[
'url'] = $title->getFullURL(
'',
false,
PROTO_CURRENT );
594 if ( !empty( $values ) && $result ) {
616 'special',
'missingIds',
'missingRevIds',
'missingTitles',
'interwikiTitles' ]
619 if ( in_array(
'invalidTitles', $invalidChecks ) ) {
622 if ( in_array(
'special', $invalidChecks ) ) {
626 if ( $title->isKnown() ) {
635 if ( in_array(
'missingIds', $invalidChecks ) ) {
638 if ( in_array(
'missingRevIds', $invalidChecks ) ) {
641 if ( in_array(
'missingTitles', $invalidChecks ) ) {
645 if ( $title->isKnown() ) {
654 if ( in_array(
'interwikiTitles', $invalidChecks ) ) {
706 if ( !empty( $values ) && $result ) {
772 $title = Title::newFromRow( $row );
774 LinkCache::singleton()->addGoodLinkObjFromRow( $title, $row );
776 $pageId = intval( $row->page_id );
777 $this->mAllPages[$row->page_namespace][$row->page_title] = $pageId;
778 $this->mTitles[] =
$title;
780 if ( $this->mResolveRedirects && $row->page_is_redirect ==
'1' ) {
781 $this->mPendingRedirectIDs[$pageId] =
$title;
783 $this->mGoodPages[$row->page_namespace][$row->page_title] = $pageId;
784 $this->mGoodAndMissingPages[$row->page_namespace][$row->page_title] = $pageId;
785 $this->mGoodTitles[$pageId] =
$title;
788 foreach ( $this->mRequestedPageFields as $fieldName => &$fieldValues ) {
789 $fieldValues[$pageId] = $row->$fieldName;
812 if ( $linkBatch->isEmpty() ) {
818 $db = $this->
getDB();
819 $set = $linkBatch->constructSet(
'page', $db );
841 $pageids = array_map(
'intval', $pageids );
842 $remaining = array_flip( $pageids );
847 if ( !empty( $pageids ) ) {
849 'page_id' => $pageids
851 $db = $this->
getDB();
875 if ( !is_null( $remaining ) && is_null( $processTitles ) ) {
876 ApiBase::dieDebug( __METHOD__,
'Missing $processTitles parameter when $remaining is provided' );
881 foreach (
$res as $row ) {
882 $pageId = intval( $row->page_id );
885 if ( isset( $remaining ) ) {
886 if ( $processTitles ) {
887 unset( $remaining[$row->page_namespace][$row->page_title] );
889 unset( $remaining[$pageId] );
897 if ( MWNamespace::hasGenderDistinction( $row->page_namespace ) ) {
898 $usernames[] = $row->page_title;
903 if ( isset( $remaining ) ) {
905 if ( $processTitles ) {
907 $linkCache = LinkCache::singleton();
908 foreach ( $remaining as $ns => $dbkeys ) {
909 foreach ( array_keys( $dbkeys ) as $dbkey ) {
910 $title = Title::makeTitle( $ns, $dbkey );
911 $linkCache->addBadLinkObj( $title );
916 $this->mFakePageId--;
917 $this->mTitles[] =
$title;
920 if ( MWNamespace::hasGenderDistinction( $ns ) ) {
921 $usernames[] = $dbkey;
927 if ( !$this->mMissingPageIDs ) {
928 $this->mMissingPageIDs = array_keys( $remaining );
930 $this->mMissingPageIDs = array_merge( $this->mMissingPageIDs, array_keys( $remaining ) );
936 $genderCache = MediaWikiServices::getInstance()->getGenderCache();
937 $genderCache->doQuery( $usernames, __METHOD__ );
950 $revids = array_map(
'intval', $revids );
951 $db = $this->
getDB();
953 $remaining = array_flip( $revids );
957 if ( !empty( $revids ) ) {
958 $tables = [
'revision',
'page' ];
959 $fields = [
'rev_id',
'rev_page' ];
960 $where = [
'rev_id' => $revids,
'rev_page = page_id' ];
963 $res = $db->select(
$tables, $fields, $where, __METHOD__ );
964 foreach (
$res as $row ) {
965 $revid = intval( $row->rev_id );
966 $pageid = intval( $row->rev_page );
967 $this->mGoodRevIDs[$revid] = $pageid;
968 $this->mLiveRevIDs[$revid] = $pageid;
969 $pageids[$pageid] =
'';
970 unset( $remaining[$revid] );
974 $this->mMissingRevIDs = array_keys( $remaining );
982 if ( !empty( $this->mMissingRevIDs ) && $this->
getUser()->isAllowed(
'deletedhistory' ) ) {
983 $remaining = array_flip( $this->mMissingRevIDs );
985 $fields = [
'ar_rev_id',
'ar_namespace',
'ar_title' ];
988 $res = $db->select(
$tables, $fields, $where, __METHOD__ );
990 foreach (
$res as $row ) {
991 $revid = intval( $row->ar_rev_id );
992 $titles[$revid] = Title::makeTitle( $row->ar_namespace, $row->ar_title );
993 unset( $remaining[$revid] );
998 foreach (
$titles as $revid => $title ) {
999 $ns = $title->getNamespace();
1000 $dbkey = $title->getDBkey();
1003 if ( !isset( $this->mAllPages[$ns][$dbkey] ) &&
1004 isset( $this->mConvertedTitles[$title->getPrefixedText()] )
1006 $title = Title::newFromText( $this->mConvertedTitles[$title->getPrefixedText()] );
1007 $ns = $title->getNamespace();
1008 $dbkey = $title->getDBkey();
1011 if ( isset( $this->mAllPages[$ns][$dbkey] ) ) {
1012 $this->mGoodRevIDs[$revid] = $this->mAllPages[$ns][$dbkey];
1013 $this->mDeletedRevIDs[$revid] = $this->mAllPages[$ns][$dbkey];
1015 $remaining[$revid] =
true;
1019 $this->mMissingRevIDs = array_keys( $remaining );
1029 if ( $this->mResolveRedirects ) {
1030 $db = $this->
getDB();
1035 while ( $this->mPendingRedirectIDs || $this->mPendingRedirectSpecialPages ) {
1040 if ( $linkBatch->isEmpty() ) {
1044 $set = $linkBatch->constructSet(
'page', $db );
1045 if ( $set ===
false ) {
1050 $res = $db->select(
'page', $pageFlds, $set, __METHOD__ );
1066 $titlesToResolve = [];
1067 $db = $this->
getDB();
1069 if ( $this->mPendingRedirectIDs ) {
1078 ], [
'rd_from' => array_keys( $this->mPendingRedirectIDs ) ],
1081 foreach (
$res as $row ) {
1082 $rdfrom = intval( $row->rd_from );
1083 $from = $this->mPendingRedirectIDs[$rdfrom]->getPrefixedText();
1084 $to = Title::makeTitle(
1090 $this->mResolvedRedirectTitles[$from] = $this->mPendingRedirectIDs[$rdfrom];
1091 unset( $this->mPendingRedirectIDs[$rdfrom] );
1092 if ( $to->isExternal() ) {
1093 $this->mInterwikiTitles[$to->getPrefixedText()] = $to->getInterwiki();
1094 } elseif ( !isset( $this->mAllPages[$to->getNamespace()][$to->getDBkey()] ) ) {
1095 $titlesToResolve[] = $to;
1097 $this->mRedirectTitles[$from] = $to;
1100 if ( $this->mPendingRedirectIDs ) {
1103 foreach ( $this->mPendingRedirectIDs as $id => $title ) {
1104 $page = WikiPage::factory( $title );
1105 $rt = $page->insertRedirect();
1110 if ( $rt->isExternal() ) {
1111 $this->mInterwikiTitles[$rt->getPrefixedText()] = $rt->getInterwiki();
1112 } elseif ( !isset( $this->mAllPages[$rt->getNamespace()][$rt->getDBkey()] ) ) {
1113 $titlesToResolve[] = $rt;
1115 $from = $title->getPrefixedText();
1116 $this->mResolvedRedirectTitles[$from] =
$title;
1117 $this->mRedirectTitles[$from] = $rt;
1118 unset( $this->mPendingRedirectIDs[$id] );
1123 if ( $this->mPendingRedirectSpecialPages ) {
1124 foreach ( $this->mPendingRedirectSpecialPages as $key =>
list( $from, $to ) ) {
1125 $fromKey = $from->getPrefixedText();
1126 $this->mResolvedRedirectTitles[$fromKey] = $from;
1127 $this->mRedirectTitles[$fromKey] = $to;
1128 if ( $to->isExternal() ) {
1129 $this->mInterwikiTitles[$to->getPrefixedText()] = $to->getInterwiki();
1130 } elseif ( !isset( $this->mAllPages[$to->getNamespace()][$to->getDBkey()] ) ) {
1131 $titlesToResolve[] = $to;
1134 $this->mPendingRedirectSpecialPages = [];
1138 $this->mCacheMode =
'private';
1174 foreach (
$titles as $title ) {
1175 if ( is_string( $title ) ) {
1177 $titleObj = Title::newFromTextThrow( $title, $this->mDefaultNamespace );
1180 if ( !isset( $this->mAllPages[0][$title] ) ) {
1184 'invalidreason' => $this->
getErrorFormatter()->formatException( $ex, [
'bc' =>
true ] ),
1186 $this->mFakePageId--;
1193 $unconvertedTitle = $titleObj->getPrefixedText();
1194 $titleWasConverted =
false;
1195 if ( $titleObj->isExternal() ) {
1197 $this->mInterwikiTitles[$unconvertedTitle] = $titleObj->getInterwiki();
1201 if ( $this->mConvertTitles &&
1203 !$titleObj->exists()
1207 $titleText = is_string( $title ) ?
$title : $titleObj->getPrefixedText();
1208 $wgContLang->findVariantLink( $titleText, $titleObj );
1209 $titleWasConverted = $unconvertedTitle !== $titleObj->getPrefixedText();
1212 if ( $titleObj->getNamespace() < 0 ) {
1214 $titleObj = $titleObj->fixSpecialName();
1215 $ns = $titleObj->getNamespace();
1216 $dbkey = $titleObj->getDBkey();
1217 if ( !isset( $this->mAllSpecials[$ns][$dbkey] ) ) {
1220 if ( $ns ===
NS_SPECIAL && $this->mResolveRedirects ) {
1231 $target = $special->getRedirect( $subpage );
1235 $this->mPendingRedirectSpecialPages[$dbkey] = [ $titleObj, $target ];
1238 $this->mFakePageId--;
1243 $linkBatch->addObj( $titleObj );
1252 if ( $titleWasConverted ) {
1253 $this->mConvertedTitles[$unconvertedTitle] = $titleObj->getPrefixedText();
1255 if ( is_string( $title ) && $title !== $unconvertedTitle ) {
1256 $this->mNormalizedTitles[
$title] = $unconvertedTitle;
1258 } elseif ( is_string( $title ) && $title !== $titleObj->getPrefixedText() ) {
1259 $this->mNormalizedTitles[
$title] = $titleObj->getPrefixedText();
1263 if ( MWNamespace::hasGenderDistinction( $titleObj->getNamespace() ) ) {
1264 $usernames[] = $titleObj->getText();
1268 $genderCache = MediaWikiServices::getInstance()->getGenderCache();
1269 $genderCache->doQuery( $usernames, __METHOD__ );
1290 $ns = $title->getNamespace();
1291 $dbkey = $title->getDBkey();
1292 $this->mGeneratorData[$ns][$dbkey] = $data;
1315 $this->mRedirectMergePolicy = $callable;
1340 $data = $result->getResultData( $path );
1341 if ( $data ===
null ) {
1346 foreach ( $path as $key ) {
1347 if ( !isset( $data[$key] ) ) {
1352 $data = &$data[$key];
1355 foreach ( $this->mGeneratorData as $ns => $dbkeys ) {
1358 foreach ( $this->mSpecialTitles as $id => $title ) {
1359 $pages[$title->getDBkey()] = $id;
1362 if ( !isset( $this->mAllPages[$ns] ) ) {
1366 $pages = $this->mAllPages[$ns];
1368 foreach ( $dbkeys as $dbkey => $genData ) {
1369 if ( !isset( $pages[$dbkey] ) ) {
1373 $pageId = $pages[$dbkey];
1374 if ( !isset( $data[$pageId] ) ) {
1380 $path2 = array_merge( $path, [ $pageId ] );
1381 foreach ( $genData as $key =>
$value ) {
1382 if ( !$result->addValue( $path2, $key,
$value ) ) {
1387 $data[$pageId] = array_merge( $data[$pageId], $genData );
1393 if ( $this->mRedirectMergePolicy ) {
1394 foreach ( $this->mResolvedRedirectTitles as $titleFrom ) {
1396 while ( isset( $this->mRedirectTitles[$dest->getPrefixedText()] ) ) {
1397 $dest = $this->mRedirectTitles[$dest->getPrefixedText()];
1399 $fromNs = $titleFrom->getNamespace();
1400 $fromDBkey = $titleFrom->getDBkey();
1401 $toPageId = $dest->getArticleID();
1402 if ( isset( $data[$toPageId] ) &&
1403 isset( $this->mGeneratorData[$fromNs][$fromDBkey] )
1407 $data[$toPageId] = call_user_func(
1408 $this->mRedirectMergePolicy,
1410 $this->mGeneratorData[$fromNs][$fromDBkey]
1429 return $this->mDbSource->getDB();
1442 foreach ( $array as $i => $int ) {
1444 unset( $array[$i] );
1475 ?
'api-pageset-param-redirects-generator'
1476 :
'api-pageset-param-redirects-nogenerator',
1478 'converttitles' => [
1481 'api-pageset-param-converttitles',
1482 [ Message::listParam( LanguageConverter::$languagesWithVariants,
'text' ) ],
1487 if ( !$this->mAllowGenerator ) {
1488 unset( $result[
'generator'] );
1498 parent::handleParamNormalization( $paramName,
$value, $rawValue );
1500 if ( $paramName ===
'titles' ) {
1506 for ( $i = 0; $i < $l; $i++ ) {
1507 if (
$value[$i] !== $rawValue[$i] ) {
1508 $this->mNormalizedTitles[$rawValue[$i]] =
$value[$i];
1521 if ( self::$generators ===
null ) {
1526 $query = $this->
getMain()->getModuleManager()->getModule(
'query' );
1529 $prefix =
$query->getModulePath() .
'+';
1530 $mgr =
$query->getModuleManager();
1531 foreach ( $mgr->getNamesWithClasses() as $name => $class ) {
1532 if ( is_subclass_of( $class, ApiQueryGeneratorBase::class ) ) {
1537 self::$generators = $gens;
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
This abstract class implements many basic API functions, and is the base of all API classes.
const PARAM_SUBMODULE_MAP
(string[]) When PARAM_TYPE is 'submodule', map parameter values to submodule paths.
encodeParamName( $paramName)
This method mangles parameter name based on the prefix supplied to the constructor.
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
getMain()
Get the main module.
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
getErrorFormatter()
Get the error formatter.
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
const PARAM_SUBMODULE_PARAM_PREFIX
(string) When PARAM_TYPE is 'submodule', used to indicate the 'g' prefix added by ApiQueryGeneratorBa...
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
const GET_VALUES_FOR_HELP
getAllowedParams() flag: When set, the result could take longer to generate, but should be more thoro...
explodeMultiValue( $value, $limit)
Split a multi-valued parameter string, like explode()
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
This class contains a list of pages that the client has requested.
getGoodAndMissingTitlesByNamespace()
Returns an array [ns][dbkey] => page_id for all good and missing titles.
initFromPageIds( $pageids)
Does the same as initFromTitles(), but is based on page IDs instead.
populateFromRevisionIDs( $revIDs)
Populate this PageSet from a list of revision IDs.
getInterwikiTitlesAsResult( $result=null, $iwUrl=false)
Get a list of interwiki titles - maps a title to its interwiki prefix as result.
getCustomField( $fieldName)
Get the value of a custom field previously requested through requestField()
getNormalizedTitles()
Get a list of title normalizations - maps a title to its normalized version.
getGenerators()
Get an array of all available generators.
__construct(ApiBase $dbSource, $flags=0, $defaultNamespace=NS_MAIN)
getGoodTitlesByNamespace()
Returns an array [ns][dbkey] => page_id for all good titles.
getAllowedParams( $flags=0)
getRevisionIDs()
Get the list of valid revision IDs (requested with the revids= parameter)
getGoodAndMissingTitles()
Title objects for good and missing titles.
populateFromPageIDs( $pageIDs)
Populate this PageSet from a list of page IDs.
getRedirectTargets()
Get the targets of the pending redirects from the database.
getMissingTitlesByNamespace()
Returns an array [ns][dbkey] => fake_page_id for all missing titles.
static getPositiveIntegers( $array)
Returns the input array of integers with all values < 0 removed.
getMissingTitles()
Title objects that were NOT found in the database.
getDB()
Get the database connection (read-only)
initFromRevIDs( $revids)
Does the same as initFromTitles(), but is based on revision IDs instead.
executeDryRun()
In case execute() is not called, call this method to mark all relevant parameters as used This preven...
getRedirectTitlesAsResult( $result=null)
Get a list of redirect resolutions - maps a title to its redirect target.
getPageTableFields()
Get the fields that have to be queried from the page table: the ones requested through requestField()...
getGoodTitleCount()
Returns the number of found unique pages (not revisions) in the set.
getRevisionCount()
Returns the number of revisions (requested with revids= parameter).
getAllTitlesByNamespace()
Returns an array [ns][dbkey] => page_id for all requested titles.
processDbRow( $row)
Extract all requested fields from the row received from the database.
processTitlesArray( $titles)
Given an array of title strings, convert them into Title objects.
static addValues(array &$result, $values, $flags=[], $name=null)
Add all items from $values into the result.
setRedirectMergePolicy( $callable)
Controls how generator data about a redirect source is merged into the generator data for the redirec...
handleParamNormalization( $paramName, $value, $rawValue)
Handle when a parameter was Unicode-normalized.
getNormalizedTitlesAsResult( $result=null)
Get a list of title normalizations - maps a title to its normalized version in the form of result arr...
getTitleCount()
Returns the number of unique pages (not revisions) in the set.
initFromTitles( $titles)
This method populates internal variables with page information based on the given array of title stri...
getInvalidTitlesAndReasons()
Titles that were deemed invalid by Title::newFromText() The array's index will be unique and negative...
array $mInvalidTitles
[fake_page_id] => [ 'title' => $title, 'invalidreason' => $reason ]
getSpecialTitles()
Get the list of titles with negative namespace.
Title[] $mPendingRedirectIDs
getTitles()
All Title objects provided.
executeInternal( $isDryRun)
Populate the PageSet from the request parameters.
resolvePendingRedirects()
Resolve any redirects in the result if redirect resolution was requested.
populateFromQueryResult( $db, $queryResult)
Populate this PageSet from a rowset returned from the database.
getMissingPageIDs()
Page IDs that were not found in the database.
requestField( $fieldName)
Request an additional field from the page table.
getInterwikiTitles()
Get a list of interwiki titles - maps a title to its interwiki prefix.
populateFromTitles( $titles)
Populate this PageSet from a list of Titles.
getMissingRevisionIDs()
Revision IDs that were not found in the database.
execute()
Populate the PageSet from the request parameters.
populateGeneratorData(&$result, array $path=[])
Populate the generator data for all titles in the result.
$mPendingRedirectSpecialPages
getConvertedTitlesAsResult( $result=null)
Get a list of title conversions - maps a title to its converted version as a result array.
getConvertedTitles()
Get a list of title conversions - maps a title to its converted version.
getInvalidTitles()
Titles that were deemed invalid by Title::newFromText() The array's index will be unique and negative...
getDataSource()
Return the parameter name that is the source of data for this PageSet.
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)
getCacheMode( $params=null)
Get the cache mode for the data generated by this module.
getGoodTitles()
Title objects that were found in the database.
callable null $mRedirectMergePolicy
isResolvingRedirects()
Check whether this PageSet is resolving redirects.
getRedirectTitles()
Get a list of redirect resolutions - maps a title to its redirect target, as an array of output-ready...
setGeneratorData(Title $title, array $data)
Set data for a title.
const DISABLE_GENERATORS
Constructor flag: The new instance of ApiPageSet will ignore the 'generator=' parameter.
initFromQueryResult( $res, &$remaining=null, $processTitles=null)
Iterate through the result of the query on 'page' table, and for each row create and store title obje...
getMissingRevisionIDsAsResult( $result=null)
Revision IDs that were not found in the database as result array.
getDeletedRevisionIDs()
Get the list of revision IDs that were associated with deleted titles.
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
This is the main query class.
This class represents the result of the API operations.
const OVERRIDE
Override existing value in addValue(), setValue(), and similar functions.
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
An IContextSource implementation which will inherit context from another source but allow individual ...
WebRequest clone which takes values from a provided array.
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Superclass for any RedirectSpecialPage which redirects the user to a particular article (as opposed t...
static getPage( $name)
Find the object with a given name and return it (or NULL)
static resolveAlias( $alias)
Given a special page name with a possible subpage, return an array where the first element is the spe...
Represents a title within MediaWiki.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
namespace being checked & $result
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist & $tables
namespace and then decline to actually register it file or subcat img or subcat $title
Allows to change the fields on the form that will be generated $name
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles