includes/api/ApiQueryBacklinks.php

   1 <?php
   2 /**
   3  * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * This is a three-in-one module to query:
  25  *   * backlinks  - links pointing to the given page,
  26  *   * embeddedin - what pages transclude the given page within themselves,
  27  *   * imageusage - what pages use the given image
  28  *
  29  * @ingroup API
  30  */
  31 class ApiQueryBacklinks extends ApiQueryGeneratorBase {
  32
  33         /**
  34          * @var Title
  35          */
  36         private $rootTitle;
  37
  38         private $params, $cont, $redirect;
  39         private $bl_ns, $bl_from, $bl_from_ns, $bl_table, $bl_code, $bl_title, $bl_fields, $hasNS;
  40
  41         /**
  42          * Maps ns and title to pageid
  43          *
  44          * @var array
  45          */
  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 = [
  92                                 $this->bl_ns,
  93                                 $this->bl_title
  94                         ];
  95                 } else {
  96                         $this->bl_title = $prefix . '_to';
  97                         $this->bl_fields = [
  98                                 $this->bl_title
  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
 115         /**
 116          * @param ApiPageSet $resultPageSet
 117          * @return void
 118          */
 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 ) ];
 191                                 ApiQueryBase::addTitleInfo( $a, $t );
 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
 203         /**
 204          * @param ApiPageSet $resultPageSet
 205          * @return void
 206          */
 207         private function runSecondQuery( $resultPageSet = null ) {
 208                 $db = $this->getDB();
 209                 $this->addTables( [ 'page', $this->bl_table ] );
 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 = [];
 227                 /** @var Title $t */
 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
 284                 $res = $this->select( __METHOD__ );
 285                 $count = 0;
 286                 foreach ( $res as $row ) {
 287                         $ns = $this->hasNS ? $row->{$this->bl_ns} : NS_FILE;
 288
 289                         if ( ++$count > $this->params['limit'] ) {
 290                                 // We've reached the one extra which shows that there are
 291                                 // additional pages to be had. Stop here...
 292                                 // Note we must keep the parameters for the first query constant
 293                                 // This may be overridden at a later step
 294                                 $title = $row->{$this->bl_title};
 295                                 $this->continueStr = implode( '|', array_slice( $this->cont, 0, 2 ) ) .
 296                                         "|$ns|$title|{$row->from_ns}|{$row->page_id}";
 297                                 break;
 298                         }
 299
 300                         // Fill in continuation fields for later steps
 301                         if ( count( $this->cont ) < 6 ) {
 302                                 $this->cont[] = $ns;
 303                                 $this->cont[] = $row->{$this->bl_title};
 304                                 $this->cont[] = $row->from_ns;
 305                                 $this->cont[] = $row->page_id;
 306                         }
 307
 308                         if ( is_null( $resultPageSet ) ) {
 309                                 $a['pageid'] = intval( $row->page_id );
 310                                 ApiQueryBase::addTitleInfo( $a, Title::makeTitle( $row->page_namespace, $row->page_title ) );
 311                                 if ( $row->page_is_redirect ) {
 312                                         $a['redirect'] = true;
 313                                 }
 314                                 $parentID = $this->pageMap[$ns][$row->{$this->bl_title}];
 315                                 // Put all the results in an array first
 316                                 $this->resultArr[$parentID]['redirlinks'][$row->page_id] = $a;
 317                         } else {
 318                                 $resultPageSet->processDbRow( $row );
 319                         }
 320                 }
 321         }
 322
 323         /**
 324          * @param ApiPageSet $resultPageSet
 325          * @return void
 326          */
 327         private function run( $resultPageSet = null ) {
 328                 $this->params = $this->extractRequestParams( false );
 329                 $this->redirect = isset( $this->params['redirect'] ) && $this->params['redirect'];
 330                 $userMax = ( $this->redirect ? ApiBase::LIMIT_BIG1 / 2 : ApiBase::LIMIT_BIG1 );
 331                 $botMax = ( $this->redirect ? ApiBase::LIMIT_BIG2 / 2 : ApiBase::LIMIT_BIG2 );
 332
 333                 $result = $this->getResult();
 334
 335                 if ( $this->params['limit'] == 'max' ) {
 336                         $this->params['limit'] = $this->getMain()->canApiHighLimits() ? $botMax : $userMax;
 337                         $result->addParsedLimit( $this->getModuleName(), $this->params['limit'] );
 338                 } else {
 339                         $this->params['limit'] = intval( $this->params['limit'] );
 340                         $this->validateLimit( 'limit', $this->params['limit'], 1, $userMax, $botMax );
 341                 }
 342
 343                 $this->rootTitle = $this->getTitleFromTitleOrPageId( $this->params );
 344
 345                 // only image titles are allowed for the root in imageinfo mode
 346                 if ( !$this->hasNS && $this->rootTitle->getNamespace() !== NS_FILE ) {
 347                         $this->dieWithError(
 348                                 [ 'apierror-imageusage-badtitle', $this->getModuleName() ],
 349                                 'bad_image_title'
 350                         );
 351                 }
 352
 353                 // Parse and validate continuation parameter
 354                 $this->cont = [];
 355                 if ( $this->params['continue'] !== null ) {
 356                         $cont = explode( '|', $this->params['continue'] );
 357
 358                         switch ( count( $cont ) ) {
 359                                 case 8:
 360                                         // redirect page ID for result adding
 361                                         $this->cont[7] = (int)$cont[7];
 362                                         $this->dieContinueUsageIf( $cont[7] !== (string)$this->cont[7] );
 363
 364                                         /* Fall through */
 365
 366                                 case 7:
 367                                         // top-level page ID for result adding
 368                                         $this->cont[6] = (int)$cont[6];
 369                                         $this->dieContinueUsageIf( $cont[6] !== (string)$this->cont[6] );
 370
 371                                         /* Fall through */
 372
 373                                 case 6:
 374                                         // ns for 2nd query (even for imageusage)
 375                                         $this->cont[2] = (int)$cont[2];
 376                                         $this->dieContinueUsageIf( $cont[2] !== (string)$this->cont[2] );
 377
 378                                         // title for 2nd query
 379                                         $this->cont[3] = $cont[3];
 380
 381                                         // from_ns for 2nd query
 382                                         $this->cont[4] = (int)$cont[4];
 383                                         $this->dieContinueUsageIf( $cont[4] !== (string)$this->cont[4] );
 384
 385                                         // from_id for 1st query
 386                                         $this->cont[5] = (int)$cont[5];
 387                                         $this->dieContinueUsageIf( $cont[5] !== (string)$this->cont[5] );
 388
 389                                         /* Fall through */
 390
 391                                 case 2:
 392                                         // from_ns for 1st query
 393                                         $this->cont[0] = (int)$cont[0];
 394                                         $this->dieContinueUsageIf( $cont[0] !== (string)$this->cont[0] );
 395
 396                                         // from_id for 1st query
 397                                         $this->cont[1] = (int)$cont[1];
 398                                         $this->dieContinueUsageIf( $cont[1] !== (string)$this->cont[1] );
 399
 400                                         break;
 401
 402                                 default:
 403                                         $this->dieContinueUsageIf( true );
 404                         }
 405
 406                         ksort( $this->cont );
 407                 }
 408
 409                 $this->runFirstQuery( $resultPageSet );
 410                 if ( $this->redirect && count( $this->redirTitles ) ) {
 411                         $this->resetQueryParams();
 412                         $this->runSecondQuery( $resultPageSet );
 413                 }
 414
 415                 // Fill in any missing fields in case it's needed below
 416                 $this->cont += [ 0, 0, 0, '', 0, 0, 0 ];
 417
 418                 if ( is_null( $resultPageSet ) ) {
 419                         // Try to add the result data in one go and pray that it fits
 420                         $code = $this->bl_code;
 421                         $data = array_map( function ( $arr ) use ( $code ) {
 422                                 if ( isset( $arr['redirlinks'] ) ) {
 423                                         $arr['redirlinks'] = array_values( $arr['redirlinks'] );
 424                                         ApiResult::setIndexedTagName( $arr['redirlinks'], $code );
 425                                 }
 426                                 return $arr;
 427                         }, array_values( $this->resultArr ) );
 428                         $fit = $result->addValue( 'query', $this->getModuleName(), $data );
 429                         if ( !$fit ) {
 430                                 // It didn't fit. Add elements one by one until the
 431                                 // result is full.
 432                                 ksort( $this->resultArr );
 433                                 if ( count( $this->cont ) >= 7 ) {
 434                                         $startAt = $this->cont[6];
 435                                 } else {
 436                                         reset( $this->resultArr );
 437                                         $startAt = key( $this->resultArr );
 438                                 }
 439                                 $idx = 0;
 440                                 foreach ( $this->resultArr as $pageID => $arr ) {
 441                                         if ( $pageID < $startAt ) {
 442                                                 continue;
 443                                         }
 444
 445                                         // Add the basic entry without redirlinks first
 446                                         $fit = $result->addValue(
 447                                                 [ 'query', $this->getModuleName() ],
 448                                                 $idx, array_diff_key( $arr, [ 'redirlinks' => '' ] ) );
 449                                         if ( !$fit ) {
 450                                                 $this->continueStr = implode( '|', array_slice( $this->cont, 0, 6 ) ) .
 451                                                         "|$pageID";
 452                                                 break;
 453                                         }
 454
 455                                         $hasRedirs = false;
 456                                         $redirLinks = isset( $arr['redirlinks'] ) ? (array)$arr['redirlinks'] : [];
 457                                         ksort( $redirLinks );
 458                                         if ( count( $this->cont ) >= 8 && $pageID == $startAt ) {
 459                                                 $redirStartAt = $this->cont[7];
 460                                         } else {
 461                                                 reset( $redirLinks );
 462                                                 $redirStartAt = key( $redirLinks );
 463                                         }
 464                                         foreach ( $redirLinks as $key => $redir ) {
 465                                                 if ( $key < $redirStartAt ) {
 466                                                         continue;
 467                                                 }
 468
 469                                                 $fit = $result->addValue(
 470                                                         [ 'query', $this->getModuleName(), $idx, 'redirlinks' ],
 471                                                         null, $redir );
 472                                                 if ( !$fit ) {
 473                                                         $this->continueStr = implode( '|', array_slice( $this->cont, 0, 6 ) ) .
 474                                                                 "|$pageID|$key";
 475                                                         break;
 476                                                 }
 477                                                 $hasRedirs = true;
 478                                         }
 479                                         if ( $hasRedirs ) {
 480                                                 $result->addIndexedTagName(
 481                                                         [ 'query', $this->getModuleName(), $idx, 'redirlinks' ],
 482                                                         $this->bl_code );
 483                                         }
 484                                         if ( !$fit ) {
 485                                                 break;
 486                                         }
 487
 488                                         $idx++;
 489                                 }
 490                         }
 491
 492                         $result->addIndexedTagName(
 493                                 [ 'query', $this->getModuleName() ],
 494                                 $this->bl_code
 495                         );
 496                 }
 497                 if ( !is_null( $this->continueStr ) ) {
 498                         $this->setContinueEnumParameter( 'continue', $this->continueStr );
 499                 }
 500         }
 501
 502         public function getAllowedParams() {
 503                 $retval = [
 504                         'title' => [
 505                                 ApiBase::PARAM_TYPE => 'string',
 506                         ],
 507                         'pageid' => [
 508                                 ApiBase::PARAM_TYPE => 'integer',
 509                         ],
 510                         'continue' => [
 511                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 512                         ],
 513                         'namespace' => [
 514                                 ApiBase::PARAM_ISMULTI => true,
 515                                 ApiBase::PARAM_TYPE => 'namespace'
 516                         ],
 517                         'dir' => [
 518                                 ApiBase::PARAM_DFLT => 'ascending',
 519                                 ApiBase::PARAM_TYPE => [
 520                                         'ascending',
 521                                         'descending'
 522                                 ]
 523                         ],
 524                         'filterredir' => [
 525                                 ApiBase::PARAM_DFLT => 'all',
 526                                 ApiBase::PARAM_TYPE => [
 527                                         'all',
 528                                         'redirects',
 529                                         'nonredirects'
 530                                 ]
 531                         ],
 532                         'limit' => [
 533                                 ApiBase::PARAM_DFLT => 10,
 534                                 ApiBase::PARAM_TYPE => 'limit',
 535                                 ApiBase::PARAM_MIN => 1,
 536                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 537                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 538                         ]
 539                 ];
 540                 if ( $this->getModuleName() == 'embeddedin' ) {
 541                         return $retval;
 542                 }
 543                 $retval['redirect'] = false;
 544
 545                 return $retval;
 546         }
 547
 548         protected function getExamplesMessages() {
 549                 static $examples = [
 550                         'backlinks' => [
 551                                 'action=query&list=backlinks&bltitle=Main%20Page'
 552                                         => 'apihelp-query+backlinks-example-simple',
 553                                 'action=query&generator=backlinks&gbltitle=Main%20Page&prop=info'
 554                                         => 'apihelp-query+backlinks-example-generator',
 555                         ],
 556                         'embeddedin' => [
 557                                 'action=query&list=embeddedin&eititle=Template:Stub'
 558                                         => 'apihelp-query+embeddedin-example-simple',
 559                                 'action=query&generator=embeddedin&geititle=Template:Stub&prop=info'
 560                                         => 'apihelp-query+embeddedin-example-generator',
 561                         ],
 562                         'imageusage' => [
 563                                 'action=query&list=imageusage&iutitle=File:Albert%20Einstein%20Head.jpg'
 564                                         => 'apihelp-query+imageusage-example-simple',
 565                                 'action=query&generator=imageusage&giutitle=File:Albert%20Einstein%20Head.jpg&prop=info'
 566                                         => 'apihelp-query+imageusage-example-generator',
 567                         ]
 568                 ];
 569
 570                 return $examples[$this->getModuleName()];
 571         }
 572
 573         public function getHelpUrls() {
 574                 return $this->helpUrl;
 575         }
 576 }