MediaWiki  REL1_31
ApiQueryBacklinks.php
Go to the documentation of this file.
1 <?php
32 
36  private $rootTitle;
37 
38  private $params, $cont, $redirect;
40 
46  private $pageMap = [];
47  private $resultArr;
48 
49  private $redirTitles = [];
50  private $continueStr = null;
51 
52  // output element name, database column field prefix, database table
53  private $backlinksSettings = [
54  'backlinks' => [
55  'code' => 'bl',
56  'prefix' => 'pl',
57  'linktbl' => 'pagelinks',
58  'helpurl' => 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Backlinks',
59  ],
60  'embeddedin' => [
61  'code' => 'ei',
62  'prefix' => 'tl',
63  'linktbl' => 'templatelinks',
64  'helpurl' => 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Embeddedin',
65  ],
66  'imageusage' => [
67  'code' => 'iu',
68  'prefix' => 'il',
69  'linktbl' => 'imagelinks',
70  'helpurl' => 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Imageusage',
71  ]
72  ];
73 
74  public function __construct( ApiQuery $query, $moduleName ) {
75  $settings = $this->backlinksSettings[$moduleName];
76  $prefix = $settings['prefix'];
77  $code = $settings['code'];
78  $this->resultArr = [];
79 
80  parent::__construct( $query, $moduleName, $code );
81  $this->bl_ns = $prefix . '_namespace';
82  $this->bl_from = $prefix . '_from';
83  $this->bl_from_ns = $prefix . '_from_namespace';
84  $this->bl_table = $settings['linktbl'];
85  $this->bl_code = $code;
86  $this->helpUrl = $settings['helpurl'];
87 
88  $this->hasNS = $moduleName !== 'imageusage';
89  if ( $this->hasNS ) {
90  $this->bl_title = $prefix . '_title';
91  $this->bl_fields = [
94  ];
95  } else {
96  $this->bl_title = $prefix . '_to';
97  $this->bl_fields = [
99  ];
100  }
101  }
102 
103  public function execute() {
104  $this->run();
105  }
106 
107  public function getCacheMode( $params ) {
108  return 'public';
109  }
110 
111  public function executeGenerator( $resultPageSet ) {
112  $this->run( $resultPageSet );
113  }
114 
119  private function runFirstQuery( $resultPageSet = null ) {
120  $this->addTables( [ $this->bl_table, 'page' ] );
121  $this->addWhere( "{$this->bl_from}=page_id" );
122  if ( is_null( $resultPageSet ) ) {
123  $this->addFields( [ 'page_id', 'page_title', 'page_namespace' ] );
124  } else {
125  $this->addFields( $resultPageSet->getPageTableFields() );
126  }
127  $this->addFields( [ 'page_is_redirect', 'from_ns' => 'page_namespace' ] );
128 
129  $this->addWhereFld( $this->bl_title, $this->rootTitle->getDBkey() );
130  if ( $this->hasNS ) {
131  $this->addWhereFld( $this->bl_ns, $this->rootTitle->getNamespace() );
132  }
133  $this->addWhereFld( $this->bl_from_ns, $this->params['namespace'] );
134 
135  if ( count( $this->cont ) >= 2 ) {
136  $op = $this->params['dir'] == 'descending' ? '<' : '>';
137  if ( $this->params['namespace'] !== null && count( $this->params['namespace'] ) > 1 ) {
138  $this->addWhere(
139  "{$this->bl_from_ns} $op {$this->cont[0]} OR " .
140  "({$this->bl_from_ns} = {$this->cont[0]} AND " .
141  "{$this->bl_from} $op= {$this->cont[1]})"
142  );
143  } else {
144  $this->addWhere( "{$this->bl_from} $op= {$this->cont[1]}" );
145  }
146  }
147 
148  if ( $this->params['filterredir'] == 'redirects' ) {
149  $this->addWhereFld( 'page_is_redirect', 1 );
150  } elseif ( $this->params['filterredir'] == 'nonredirects' && !$this->redirect ) {
151  // T24245 - Check for !redirect, as filtering nonredirects, when
152  // getting what links to them is contradictory
153  $this->addWhereFld( 'page_is_redirect', 0 );
154  }
155 
156  $this->addOption( 'LIMIT', $this->params['limit'] + 1 );
157  $sort = ( $this->params['dir'] == 'descending' ? ' DESC' : '' );
158  $orderBy = [];
159  if ( $this->params['namespace'] !== null && count( $this->params['namespace'] ) > 1 ) {
160  $orderBy[] = $this->bl_from_ns . $sort;
161  }
162  $orderBy[] = $this->bl_from . $sort;
163  $this->addOption( 'ORDER BY', $orderBy );
164  $this->addOption( 'STRAIGHT_JOIN' );
165 
166  $res = $this->select( __METHOD__ );
167  $count = 0;
168  foreach ( $res as $row ) {
169  if ( ++$count > $this->params['limit'] ) {
170  // We've reached the one extra which shows that there are
171  // additional pages to be had. Stop here...
172  // Continue string may be overridden at a later step
173  $this->continueStr = "{$row->from_ns}|{$row->page_id}";
174  break;
175  }
176 
177  // Fill in continuation fields for later steps
178  if ( count( $this->cont ) < 2 ) {
179  $this->cont[] = $row->from_ns;
180  $this->cont[] = $row->page_id;
181  }
182 
183  $this->pageMap[$row->page_namespace][$row->page_title] = $row->page_id;
184  $t = Title::makeTitle( $row->page_namespace, $row->page_title );
185  if ( $row->page_is_redirect ) {
186  $this->redirTitles[] = $t;
187  }
188 
189  if ( is_null( $resultPageSet ) ) {
190  $a = [ 'pageid' => intval( $row->page_id ) ];
192  if ( $row->page_is_redirect ) {
193  $a['redirect'] = true;
194  }
195  // Put all the results in an array first
196  $this->resultArr[$a['pageid']] = $a;
197  } else {
198  $resultPageSet->processDbRow( $row );
199  }
200  }
201  }
202 
207  private function runSecondQuery( $resultPageSet = null ) {
208  $db = $this->getDB();
209  $this->addTables( [ $this->bl_table, 'page' ] );
210  $this->addWhere( "{$this->bl_from}=page_id" );
211 
212  if ( is_null( $resultPageSet ) ) {
213  $this->addFields( [ 'page_id', 'page_title', 'page_namespace', 'page_is_redirect' ] );
214  } else {
215  $this->addFields( $resultPageSet->getPageTableFields() );
216  }
217 
218  $this->addFields( [ $this->bl_title, 'from_ns' => 'page_namespace' ] );
219  if ( $this->hasNS ) {
220  $this->addFields( $this->bl_ns );
221  }
222 
223  // We can't use LinkBatch here because $this->hasNS may be false
224  $titleWhere = [];
225  $allRedirNs = [];
226  $allRedirDBkey = [];
228  foreach ( $this->redirTitles as $t ) {
229  $redirNs = $t->getNamespace();
230  $redirDBkey = $t->getDBkey();
231  $titleWhere[] = "{$this->bl_title} = " . $db->addQuotes( $redirDBkey ) .
232  ( $this->hasNS ? " AND {$this->bl_ns} = {$redirNs}" : '' );
233  $allRedirNs[$redirNs] = true;
234  $allRedirDBkey[$redirDBkey] = true;
235  }
236  $this->addWhere( $db->makeList( $titleWhere, LIST_OR ) );
237  $this->addWhereFld( 'page_namespace', $this->params['namespace'] );
238 
239  if ( count( $this->cont ) >= 6 ) {
240  $op = $this->params['dir'] == 'descending' ? '<' : '>';
241 
242  $where = "{$this->bl_from} $op= {$this->cont[5]}";
243  // Don't bother with namespace, title, or from_namespace if it's
244  // otherwise constant in the where clause.
245  if ( $this->params['namespace'] !== null && count( $this->params['namespace'] ) > 1 ) {
246  $where = "{$this->bl_from_ns} $op {$this->cont[4]} OR " .
247  "({$this->bl_from_ns} = {$this->cont[4]} AND ($where))";
248  }
249  if ( count( $allRedirDBkey ) > 1 ) {
250  $title = $db->addQuotes( $this->cont[3] );
251  $where = "{$this->bl_title} $op $title OR " .
252  "({$this->bl_title} = $title AND ($where))";
253  }
254  if ( $this->hasNS && count( $allRedirNs ) > 1 ) {
255  $where = "{$this->bl_ns} $op {$this->cont[2]} OR " .
256  "({$this->bl_ns} = {$this->cont[2]} AND ($where))";
257  }
258 
259  $this->addWhere( $where );
260  }
261  if ( $this->params['filterredir'] == 'redirects' ) {
262  $this->addWhereFld( 'page_is_redirect', 1 );
263  } elseif ( $this->params['filterredir'] == 'nonredirects' ) {
264  $this->addWhereFld( 'page_is_redirect', 0 );
265  }
266 
267  $this->addOption( 'LIMIT', $this->params['limit'] + 1 );
268  $orderBy = [];
269  $sort = ( $this->params['dir'] == 'descending' ? ' DESC' : '' );
270  // Don't order by namespace/title/from_namespace if it's constant in the WHERE clause
271  if ( $this->hasNS && count( $allRedirNs ) > 1 ) {
272  $orderBy[] = $this->bl_ns . $sort;
273  }
274  if ( count( $allRedirDBkey ) > 1 ) {
275  $orderBy[] = $this->bl_title . $sort;
276  }
277  if ( $this->params['namespace'] !== null && count( $this->params['namespace'] ) > 1 ) {
278  $orderBy[] = $this->bl_from_ns . $sort;
279  }
280  $orderBy[] = $this->bl_from . $sort;
281  $this->addOption( 'ORDER BY', $orderBy );
282  $this->addOption( 'USE INDEX', [ 'page' => 'PRIMARY' ] );
283  // T290379: Avoid MariaDB deciding to scan all of `page`.
284  $this->addOption( 'STRAIGHT_JOIN' );
285 
286  $res = $this->select( __METHOD__ );
287  $count = 0;
288  foreach ( $res as $row ) {
289  $ns = $this->hasNS ? $row->{$this->bl_ns} : NS_FILE;
290 
291  if ( ++$count > $this->params['limit'] ) {
292  // We've reached the one extra which shows that there are
293  // additional pages to be had. Stop here...
294  // Note we must keep the parameters for the first query constant
295  // This may be overridden at a later step
296  $title = $row->{$this->bl_title};
297  $this->continueStr = implode( '|', array_slice( $this->cont, 0, 2 ) ) .
298  "|$ns|$title|{$row->from_ns}|{$row->page_id}";
299  break;
300  }
301 
302  // Fill in continuation fields for later steps
303  if ( count( $this->cont ) < 6 ) {
304  $this->cont[] = $ns;
305  $this->cont[] = $row->{$this->bl_title};
306  $this->cont[] = $row->from_ns;
307  $this->cont[] = $row->page_id;
308  }
309 
310  if ( is_null( $resultPageSet ) ) {
311  $a['pageid'] = intval( $row->page_id );
312  ApiQueryBase::addTitleInfo( $a, Title::makeTitle( $row->page_namespace, $row->page_title ) );
313  if ( $row->page_is_redirect ) {
314  $a['redirect'] = true;
315  }
316  $parentID = $this->pageMap[$ns][$row->{$this->bl_title}];
317  // Put all the results in an array first
318  $this->resultArr[$parentID]['redirlinks'][$row->page_id] = $a;
319  } else {
320  $resultPageSet->processDbRow( $row );
321  }
322  }
323  }
324 
329  private function run( $resultPageSet = null ) {
330  $this->params = $this->extractRequestParams( false );
331  $this->redirect = isset( $this->params['redirect'] ) && $this->params['redirect'];
332  $userMax = ( $this->redirect ? ApiBase::LIMIT_BIG1 / 2 : ApiBase::LIMIT_BIG1 );
333  $botMax = ( $this->redirect ? ApiBase::LIMIT_BIG2 / 2 : ApiBase::LIMIT_BIG2 );
334 
335  $result = $this->getResult();
336 
337  if ( $this->params['limit'] == 'max' ) {
338  $this->params['limit'] = $this->getMain()->canApiHighLimits() ? $botMax : $userMax;
339  $result->addParsedLimit( $this->getModuleName(), $this->params['limit'] );
340  } else {
341  $this->params['limit'] = intval( $this->params['limit'] );
342  $this->validateLimit( 'limit', $this->params['limit'], 1, $userMax, $botMax );
343  }
344 
345  $this->rootTitle = $this->getTitleFromTitleOrPageId( $this->params );
346 
347  // only image titles are allowed for the root in imageinfo mode
348  if ( !$this->hasNS && $this->rootTitle->getNamespace() !== NS_FILE ) {
349  $this->dieWithError(
350  [ 'apierror-imageusage-badtitle', $this->getModuleName() ],
351  'bad_image_title'
352  );
353  }
354 
355  // Parse and validate continuation parameter
356  $this->cont = [];
357  if ( $this->params['continue'] !== null ) {
358  $cont = explode( '|', $this->params['continue'] );
359 
360  switch ( count( $cont ) ) {
361  case 8:
362  // redirect page ID for result adding
363  $this->cont[7] = (int)$cont[7];
364  $this->dieContinueUsageIf( $cont[7] !== (string)$this->cont[7] );
365 
366  /* Fall through */
367 
368  case 7:
369  // top-level page ID for result adding
370  $this->cont[6] = (int)$cont[6];
371  $this->dieContinueUsageIf( $cont[6] !== (string)$this->cont[6] );
372 
373  /* Fall through */
374 
375  case 6:
376  // ns for 2nd query (even for imageusage)
377  $this->cont[2] = (int)$cont[2];
378  $this->dieContinueUsageIf( $cont[2] !== (string)$this->cont[2] );
379 
380  // title for 2nd query
381  $this->cont[3] = $cont[3];
382 
383  // from_ns for 2nd query
384  $this->cont[4] = (int)$cont[4];
385  $this->dieContinueUsageIf( $cont[4] !== (string)$this->cont[4] );
386 
387  // from_id for 1st query
388  $this->cont[5] = (int)$cont[5];
389  $this->dieContinueUsageIf( $cont[5] !== (string)$this->cont[5] );
390 
391  /* Fall through */
392 
393  case 2:
394  // from_ns for 1st query
395  $this->cont[0] = (int)$cont[0];
396  $this->dieContinueUsageIf( $cont[0] !== (string)$this->cont[0] );
397 
398  // from_id for 1st query
399  $this->cont[1] = (int)$cont[1];
400  $this->dieContinueUsageIf( $cont[1] !== (string)$this->cont[1] );
401 
402  break;
403 
404  default:
405  $this->dieContinueUsageIf( true );
406  }
407 
408  ksort( $this->cont );
409  }
410 
411  $this->runFirstQuery( $resultPageSet );
412  if ( $this->redirect && count( $this->redirTitles ) ) {
413  $this->resetQueryParams();
414  $this->runSecondQuery( $resultPageSet );
415  }
416 
417  // Fill in any missing fields in case it's needed below
418  $this->cont += [ 0, 0, 0, '', 0, 0, 0 ];
419 
420  if ( is_null( $resultPageSet ) ) {
421  // Try to add the result data in one go and pray that it fits
422  $code = $this->bl_code;
423  $data = array_map( function ( $arr ) use ( $result, $code ) {
424  if ( isset( $arr['redirlinks'] ) ) {
425  $arr['redirlinks'] = array_values( $arr['redirlinks'] );
426  ApiResult::setIndexedTagName( $arr['redirlinks'], $code );
427  }
428  return $arr;
429  }, array_values( $this->resultArr ) );
430  $fit = $result->addValue( 'query', $this->getModuleName(), $data );
431  if ( !$fit ) {
432  // It didn't fit. Add elements one by one until the
433  // result is full.
434  ksort( $this->resultArr );
435  if ( count( $this->cont ) >= 7 ) {
436  $startAt = $this->cont[6];
437  } else {
438  reset( $this->resultArr );
439  $startAt = key( $this->resultArr );
440  }
441  $idx = 0;
442  foreach ( $this->resultArr as $pageID => $arr ) {
443  if ( $pageID < $startAt ) {
444  continue;
445  }
446 
447  // Add the basic entry without redirlinks first
448  $fit = $result->addValue(
449  [ 'query', $this->getModuleName() ],
450  $idx, array_diff_key( $arr, [ 'redirlinks' => '' ] ) );
451  if ( !$fit ) {
452  $this->continueStr = implode( '|', array_slice( $this->cont, 0, 6 ) ) .
453  "|$pageID";
454  break;
455  }
456 
457  $hasRedirs = false;
458  $redirLinks = isset( $arr['redirlinks'] ) ? (array)$arr['redirlinks'] : [];
459  ksort( $redirLinks );
460  if ( count( $this->cont ) >= 8 && $pageID == $startAt ) {
461  $redirStartAt = $this->cont[7];
462  } else {
463  reset( $redirLinks );
464  $redirStartAt = key( $redirLinks );
465  }
466  foreach ( $redirLinks as $key => $redir ) {
467  if ( $key < $redirStartAt ) {
468  continue;
469  }
470 
471  $fit = $result->addValue(
472  [ 'query', $this->getModuleName(), $idx, 'redirlinks' ],
473  null, $redir );
474  if ( !$fit ) {
475  $this->continueStr = implode( '|', array_slice( $this->cont, 0, 6 ) ) .
476  "|$pageID|$key";
477  break;
478  }
479  $hasRedirs = true;
480  }
481  if ( $hasRedirs ) {
482  $result->addIndexedTagName(
483  [ 'query', $this->getModuleName(), $idx, 'redirlinks' ],
484  $this->bl_code );
485  }
486  if ( !$fit ) {
487  break;
488  }
489 
490  $idx++;
491  }
492  }
493 
494  $result->addIndexedTagName(
495  [ 'query', $this->getModuleName() ],
496  $this->bl_code
497  );
498  }
499  if ( !is_null( $this->continueStr ) ) {
500  $this->setContinueEnumParameter( 'continue', $this->continueStr );
501  }
502  }
503 
504  public function getAllowedParams() {
505  $retval = [
506  'title' => [
507  ApiBase::PARAM_TYPE => 'string',
508  ],
509  'pageid' => [
510  ApiBase::PARAM_TYPE => 'integer',
511  ],
512  'continue' => [
513  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
514  ],
515  'namespace' => [
516  ApiBase::PARAM_ISMULTI => true,
517  ApiBase::PARAM_TYPE => 'namespace'
518  ],
519  'dir' => [
520  ApiBase::PARAM_DFLT => 'ascending',
522  'ascending',
523  'descending'
524  ]
525  ],
526  'filterredir' => [
527  ApiBase::PARAM_DFLT => 'all',
529  'all',
530  'redirects',
531  'nonredirects'
532  ]
533  ],
534  'limit' => [
535  ApiBase::PARAM_DFLT => 10,
536  ApiBase::PARAM_TYPE => 'limit',
537  ApiBase::PARAM_MIN => 1,
540  ]
541  ];
542  if ( $this->getModuleName() == 'embeddedin' ) {
543  return $retval;
544  }
545  $retval['redirect'] = false;
546 
547  return $retval;
548  }
549 
550  protected function getExamplesMessages() {
551  static $examples = [
552  'backlinks' => [
553  'action=query&list=backlinks&bltitle=Main%20Page'
554  => 'apihelp-query+backlinks-example-simple',
555  'action=query&generator=backlinks&gbltitle=Main%20Page&prop=info'
556  => 'apihelp-query+backlinks-example-generator',
557  ],
558  'embeddedin' => [
559  'action=query&list=embeddedin&eititle=Template:Stub'
560  => 'apihelp-query+embeddedin-example-simple',
561  'action=query&generator=embeddedin&geititle=Template:Stub&prop=info'
562  => 'apihelp-query+embeddedin-example-generator',
563  ],
564  'imageusage' => [
565  'action=query&list=imageusage&iutitle=File:Albert%20Einstein%20Head.jpg'
566  => 'apihelp-query+imageusage-example-simple',
567  'action=query&generator=imageusage&giutitle=File:Albert%20Einstein%20Head.jpg&prop=info'
568  => 'apihelp-query+imageusage-example-generator',
569  ]
570  ];
571 
572  return $examples[$this->getModuleName()];
573  }
574 
575  public function getHelpUrls() {
576  return $this->helpUrl;
577  }
578 }
ApiQueryBase\addFields
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:192
ApiQuery
This is the main query class.
Definition: ApiQuery.php:36
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
array
the array() calling protocol came about after MediaWiki 1.4rc1.
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:124
ApiBase\PARAM_TYPE
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:87
NS_FILE
const NS_FILE
Definition: Defines.php:80
$res
$res
Definition: database.txt:21
ApiQueryBase\addOption
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:325
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1993
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
key
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling but I prefer the flexibility This should also do the output encoding The system allocates a global one in $wgOut Title Represents the title of an and does all the work of translating among various forms such as plain database key
Definition: design.txt:26
ApiBase\PARAM_MIN
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:99
LIST_OR
const LIST_OR
Definition: Defines.php:56
ApiBase\LIMIT_BIG1
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:234
ApiQueryBase\getDB
getDB()
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:105
ApiBase\PARAM_MAX
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:90
ApiQueryBase\addTables
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:158
ApiQueryBase\select
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:350
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:534
$sort
$sort
Definition: profileinfo.php:317
ApiQueryBase\$where
$where
Definition: ApiQueryBase.php:35
ApiResult\setIndexedTagName
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
ApiQueryBase\addWhereFld
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
Definition: ApiQueryBase.php:260
ApiQueryGeneratorBase
Definition: ApiQueryGeneratorBase.php:26
Title
Represents a title within MediaWiki.
Definition: Title.php:39
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:236
$code
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition: hooks.txt:865
ApiBase\PARAM_DFLT
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:48
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:51
ApiBase\PARAM_MAX2
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
Definition: ApiBase.php:96
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:227
$t
$t
Definition: testCompression.php:69
$query
null for the 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
Definition: hooks.txt:1620
$retval
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account incomplete not yet checked for validity & $retval
Definition: hooks.txt:266
redirect
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second redirect
Definition: All_system_messages.txt:1267
ApiQueryBase\addTitleInfo
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:482