includes/api/ApiQueryBase.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Sep 7, 2006
   6  *
   7  * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  */
  26
  27 /**
  28  * This is a base class for all Query modules.
  29  * It provides some common functionality such as constructing various SQL
  30  * queries.
  31  *
  32  * @ingroup API
  33  */
  34 abstract class ApiQueryBase extends ApiBase {
  35
  36         private $mQueryModule, $mDb, $tables, $where, $fields, $options, $join_conds;
  37
  38         /**
  39          * @param ApiQuery $queryModule
  40          * @param string $moduleName
  41          * @param string $paramPrefix
  42          */
  43         public function __construct( ApiQuery $queryModule, $moduleName, $paramPrefix = '' ) {
  44                 parent::__construct( $queryModule->getMain(), $moduleName, $paramPrefix );
  45                 $this->mQueryModule = $queryModule;
  46                 $this->mDb = null;
  47                 $this->resetQueryParams();
  48         }
  49
  50         /************************************************************************//**
  51          * @name   Methods to implement
  52          * @{
  53          */
  54
  55         /**
  56          * Get the cache mode for the data generated by this module. Override
  57          * this in the module subclass. For possible return values and other
  58          * details about cache modes, see ApiMain::setCacheMode()
  59          *
  60          * Public caching will only be allowed if *all* the modules that supply
  61          * data for a given request return a cache mode of public.
  62          *
  63          * @param array $params
  64          * @return string
  65          */
  66         public function getCacheMode( $params ) {
  67                 return 'private';
  68         }
  69
  70         /**
  71          * Override this method to request extra fields from the pageSet
  72          * using $pageSet->requestField('fieldName')
  73          *
  74          * Note this only makes sense for 'prop' modules, as 'list' and 'meta'
  75          * modules should not be using the pageset.
  76          *
  77          * @param ApiPageSet $pageSet
  78          */
  79         public function requestExtraData( $pageSet ) {
  80         }
  81
  82         /**@}*/
  83
  84         /************************************************************************//**
  85          * @name   Data access
  86          * @{
  87          */
  88
  89         /**
  90          * Get the main Query module
  91          * @return ApiQuery
  92          */
  93         public function getQuery() {
  94                 return $this->mQueryModule;
  95         }
  96
  97         /**
  98          * @see ApiBase::getParent()
  99          */
 100         public function getParent() {
 101                 return $this->getQuery();
 102         }
 103
 104         /**
 105          * Get the Query database connection (read-only)
 106          * @return DatabaseBase
 107          */
 108         protected function getDB() {
 109                 if ( is_null( $this->mDb ) ) {
 110                         $this->mDb = $this->getQuery()->getDB();
 111                 }
 112
 113                 return $this->mDb;
 114         }
 115
 116         /**
 117          * Selects the query database connection with the given name.
 118          * See ApiQuery::getNamedDB() for more information
 119          * @param string $name Name to assign to the database connection
 120          * @param int $db One of the DB_* constants
 121          * @param array $groups Query groups
 122          * @return DatabaseBase
 123          */
 124         public function selectNamedDB( $name, $db, $groups ) {
 125                 $this->mDb = $this->getQuery()->getNamedDB( $name, $db, $groups );
 126         }
 127
 128         /**
 129          * Get the PageSet object to work on
 130          * @return ApiPageSet
 131          */
 132         protected function getPageSet() {
 133                 return $this->getQuery()->getPageSet();
 134         }
 135
 136         /**@}*/
 137
 138         /************************************************************************//**
 139          * @name   Querying
 140          * @{
 141          */
 142
 143         /**
 144          * Blank the internal arrays with query parameters
 145          */
 146         protected function resetQueryParams() {
 147                 $this->tables = array();
 148                 $this->where = array();
 149                 $this->fields = array();
 150                 $this->options = array();
 151                 $this->join_conds = array();
 152         }
 153
 154         /**
 155          * Add a set of tables to the internal array
 156          * @param string|string[] $tables Table name or array of table names
 157          * @param string|null $alias Table alias, or null for no alias. Cannot be
 158          *  used with multiple tables
 159          */
 160         protected function addTables( $tables, $alias = null ) {
 161                 if ( is_array( $tables ) ) {
 162                         if ( !is_null( $alias ) ) {
 163                                 ApiBase::dieDebug( __METHOD__, 'Multiple table aliases not supported' );
 164                         }
 165                         $this->tables = array_merge( $this->tables, $tables );
 166                 } else {
 167                         if ( !is_null( $alias ) ) {
 168                                 $this->tables[$alias] = $tables;
 169                         } else {
 170                                 $this->tables[] = $tables;
 171                         }
 172                 }
 173         }
 174
 175         /**
 176          * Add a set of JOIN conditions to the internal array
 177          *
 178          * JOIN conditions are formatted as array( tablename => array(jointype,
 179          * conditions) e.g. array('page' => array('LEFT JOIN',
 180          * 'page_id=rev_page')) . conditions may be a string or an
 181          * addWhere()-style array
 182          * @param array $join_conds JOIN conditions
 183          */
 184         protected function addJoinConds( $join_conds ) {
 185                 if ( !is_array( $join_conds ) ) {
 186                         ApiBase::dieDebug( __METHOD__, 'Join conditions have to be arrays' );
 187                 }
 188                 $this->join_conds = array_merge( $this->join_conds, $join_conds );
 189         }
 190
 191         /**
 192          * Add a set of fields to select to the internal array
 193          * @param array|string $value Field name or array of field names
 194          */
 195         protected function addFields( $value ) {
 196                 if ( is_array( $value ) ) {
 197                         $this->fields = array_merge( $this->fields, $value );
 198                 } else {
 199                         $this->fields[] = $value;
 200                 }
 201         }
 202
 203         /**
 204          * Same as addFields(), but add the fields only if a condition is met
 205          * @param array|string $value See addFields()
 206          * @param bool $condition If false, do nothing
 207          * @return bool $condition
 208          */
 209         protected function addFieldsIf( $value, $condition ) {
 210                 if ( $condition ) {
 211                         $this->addFields( $value );
 212
 213                         return true;
 214                 }
 215
 216                 return false;
 217         }
 218
 219         /**
 220          * Add a set of WHERE clauses to the internal array.
 221          * Clauses can be formatted as 'foo=bar' or array('foo' => 'bar'),
 222          * the latter only works if the value is a constant (i.e. not another field)
 223          *
 224          * If $value is an empty array, this function does nothing.
 225          *
 226          * For example, array('foo=bar', 'baz' => 3, 'bla' => 'foo') translates
 227          * to "foo=bar AND baz='3' AND bla='foo'"
 228          * @param string|array $value
 229          */
 230         protected function addWhere( $value ) {
 231                 if ( is_array( $value ) ) {
 232                         // Sanity check: don't insert empty arrays,
 233                         // Database::makeList() chokes on them
 234                         if ( count( $value ) ) {
 235                                 $this->where = array_merge( $this->where, $value );
 236                         }
 237                 } else {
 238                         $this->where[] = $value;
 239                 }
 240         }
 241
 242         /**
 243          * Same as addWhere(), but add the WHERE clauses only if a condition is met
 244          * @param string|array $value
 245          * @param bool $condition If false, do nothing
 246          * @return bool $condition
 247          */
 248         protected function addWhereIf( $value, $condition ) {
 249                 if ( $condition ) {
 250                         $this->addWhere( $value );
 251
 252                         return true;
 253                 }
 254
 255                 return false;
 256         }
 257
 258         /**
 259          * Equivalent to addWhere(array($field => $value))
 260          * @param string $field Field name
 261          * @param string $value Value; ignored if null or empty array;
 262          */
 263         protected function addWhereFld( $field, $value ) {
 264                 // Use count() to its full documented capabilities to simultaneously
 265                 // test for null, empty array or empty countable object
 266                 if ( count( $value ) ) {
 267                         $this->where[$field] = $value;
 268                 }
 269         }
 270
 271         /**
 272          * Add a WHERE clause corresponding to a range, and an ORDER BY
 273          * clause to sort in the right direction
 274          * @param string $field Field name
 275          * @param string $dir If 'newer', sort in ascending order, otherwise
 276          *  sort in descending order
 277          * @param string $start Value to start the list at. If $dir == 'newer'
 278          *  this is the lower boundary, otherwise it's the upper boundary
 279          * @param string $end Value to end the list at. If $dir == 'newer' this
 280          *  is the upper boundary, otherwise it's the lower boundary
 281          * @param bool $sort If false, don't add an ORDER BY clause
 282          */
 283         protected function addWhereRange( $field, $dir, $start, $end, $sort = true ) {
 284                 $isDirNewer = ( $dir === 'newer' );
 285                 $after = ( $isDirNewer ? '>=' : '<=' );
 286                 $before = ( $isDirNewer ? '<=' : '>=' );
 287                 $db = $this->getDB();
 288
 289                 if ( !is_null( $start ) ) {
 290                         $this->addWhere( $field . $after . $db->addQuotes( $start ) );
 291                 }
 292
 293                 if ( !is_null( $end ) ) {
 294                         $this->addWhere( $field . $before . $db->addQuotes( $end ) );
 295                 }
 296
 297                 if ( $sort ) {
 298                         $order = $field . ( $isDirNewer ? '' : ' DESC' );
 299                         // Append ORDER BY
 300                         $optionOrderBy = isset( $this->options['ORDER BY'] )
 301                                 ? (array)$this->options['ORDER BY']
 302                                 : array();
 303                         $optionOrderBy[] = $order;
 304                         $this->addOption( 'ORDER BY', $optionOrderBy );
 305                 }
 306         }
 307
 308         /**
 309          * Add a WHERE clause corresponding to a range, similar to addWhereRange,
 310          * but converts $start and $end to database timestamps.
 311          * @see addWhereRange
 312          * @param string $field
 313          * @param string $dir
 314          * @param string $start
 315          * @param string $end
 316          * @param bool $sort
 317          */
 318         protected function addTimestampWhereRange( $field, $dir, $start, $end, $sort = true ) {
 319                 $db = $this->getDb();
 320                 $this->addWhereRange( $field, $dir,
 321                         $db->timestampOrNull( $start ), $db->timestampOrNull( $end ), $sort );
 322         }
 323
 324         /**
 325          * Add an option such as LIMIT or USE INDEX. If an option was set
 326          * before, the old value will be overwritten
 327          * @param string $name Option name
 328          * @param string $value Option value
 329          */
 330         protected function addOption( $name, $value = null ) {
 331                 if ( is_null( $value ) ) {
 332                         $this->options[] = $name;
 333                 } else {
 334                         $this->options[$name] = $value;
 335                 }
 336         }
 337
 338         /**
 339          * Execute a SELECT query based on the values in the internal arrays
 340          * @param string $method Function the query should be attributed to.
 341          *  You should usually use __METHOD__ here
 342          * @param array $extraQuery Query data to add but not store in the object
 343          *  Format is array(
 344          *    'tables' => ...,
 345          *    'fields' => ...,
 346          *    'where' => ...,
 347          *    'options' => ...,
 348          *    'join_conds' => ...
 349          *  )
 350          * @return ResultWrapper
 351          */
 352         protected function select( $method, $extraQuery = array() ) {
 353
 354                 $tables = array_merge(
 355                         $this->tables,
 356                         isset( $extraQuery['tables'] ) ? (array)$extraQuery['tables'] : array()
 357                 );
 358                 $fields = array_merge(
 359                         $this->fields,
 360                         isset( $extraQuery['fields'] ) ? (array)$extraQuery['fields'] : array()
 361                 );
 362                 $where = array_merge(
 363                         $this->where,
 364                         isset( $extraQuery['where'] ) ? (array)$extraQuery['where'] : array()
 365                 );
 366                 $options = array_merge(
 367                         $this->options,
 368                         isset( $extraQuery['options'] ) ? (array)$extraQuery['options'] : array()
 369                 );
 370                 $join_conds = array_merge(
 371                         $this->join_conds,
 372                         isset( $extraQuery['join_conds'] ) ? (array)$extraQuery['join_conds'] : array()
 373                 );
 374
 375                 $res = $this->getDB()->select( $tables, $fields, $where, $method, $options, $join_conds );
 376
 377                 return $res;
 378         }
 379
 380         /**
 381          * @param string $query
 382          * @param string $protocol
 383          * @return null|string
 384          */
 385         public function prepareUrlQuerySearchString( $query = null, $protocol = null ) {
 386                 $db = $this->getDb();
 387                 if ( !is_null( $query ) || $query != '' ) {
 388                         if ( is_null( $protocol ) ) {
 389                                 $protocol = 'http://';
 390                         }
 391
 392                         $likeQuery = LinkFilter::makeLikeArray( $query, $protocol );
 393                         if ( !$likeQuery ) {
 394                                 $this->dieUsage( 'Invalid query', 'bad_query' );
 395                         }
 396
 397                         $likeQuery = LinkFilter::keepOneWildcard( $likeQuery );
 398
 399                         return 'el_index ' . $db->buildLike( $likeQuery );
 400                 } elseif ( !is_null( $protocol ) ) {
 401                         return 'el_index ' . $db->buildLike( "$protocol", $db->anyString() );
 402                 }
 403
 404                 return null;
 405         }
 406
 407         /**
 408          * Filters hidden users (where the user doesn't have the right to view them)
 409          * Also adds relevant block information
 410          *
 411          * @param bool $showBlockInfo
 412          * @return void
 413          */
 414         public function showHiddenUsersAddBlockInfo( $showBlockInfo ) {
 415                 $this->addTables( 'ipblocks' );
 416                 $this->addJoinConds( array(
 417                         'ipblocks' => array( 'LEFT JOIN', 'ipb_user=user_id' ),
 418                 ) );
 419
 420                 $this->addFields( 'ipb_deleted' );
 421
 422                 if ( $showBlockInfo ) {
 423                         $this->addFields( array( 'ipb_id', 'ipb_by', 'ipb_by_text', 'ipb_reason', 'ipb_expiry', 'ipb_timestamp' ) );
 424                 }
 425
 426                 // Don't show hidden names
 427                 if ( !$this->getUser()->isAllowed( 'hideuser' ) ) {
 428                         $this->addWhere( 'ipb_deleted = 0 OR ipb_deleted IS NULL' );
 429                 }
 430         }
 431
 432         /**@}*/
 433
 434         /************************************************************************//**
 435          * @name   Utility methods
 436          * @{
 437          */
 438
 439         /**
 440          * Add information (title and namespace) about a Title object to a
 441          * result array
 442          * @param array $arr Result array à la ApiResult
 443          * @param Title $title
 444          * @param string $prefix Module prefix
 445          */
 446         public static function addTitleInfo( &$arr, $title, $prefix = '' ) {
 447                 $arr[$prefix . 'ns'] = intval( $title->getNamespace() );
 448                 $arr[$prefix . 'title'] = $title->getPrefixedText();
 449         }
 450
 451         /**
 452          * Add a sub-element under the page element with the given page ID
 453          * @param int $pageId Page ID
 454          * @param array $data Data array à la ApiResult
 455          * @return bool Whether the element fit in the result
 456          */
 457         protected function addPageSubItems( $pageId, $data ) {
 458                 $result = $this->getResult();
 459                 $result->setIndexedTagName( $data, $this->getModulePrefix() );
 460
 461                 return $result->addValue( array( 'query', 'pages', intval( $pageId ) ),
 462                         $this->getModuleName(),
 463                         $data );
 464         }
 465
 466         /**
 467          * Same as addPageSubItems(), but one element of $data at a time
 468          * @param int $pageId Page ID
 469          * @param array $item Data array à la ApiResult
 470          * @param string $elemname XML element name. If null, getModuleName()
 471          *  is used
 472          * @return bool Whether the element fit in the result
 473          */
 474         protected function addPageSubItem( $pageId, $item, $elemname = null ) {
 475                 if ( is_null( $elemname ) ) {
 476                         $elemname = $this->getModulePrefix();
 477                 }
 478                 $result = $this->getResult();
 479                 $fit = $result->addValue( array( 'query', 'pages', $pageId,
 480                         $this->getModuleName() ), null, $item );
 481                 if ( !$fit ) {
 482                         return false;
 483                 }
 484                 $result->setIndexedTagName_internal( array( 'query', 'pages', $pageId,
 485                         $this->getModuleName() ), $elemname );
 486
 487                 return true;
 488         }
 489
 490         /**
 491          * Set a query-continue value
 492          * @param string $paramName Parameter name
 493          * @param string|array $paramValue Parameter value
 494          */
 495         protected function setContinueEnumParameter( $paramName, $paramValue ) {
 496                 $this->getResult()->setContinueParam( $this, $paramName, $paramValue );
 497         }
 498
 499         /**
 500          * Convert an input title or title prefix into a dbkey.
 501          *
 502          * $namespace should always be specified in order to handle per-namespace
 503          * capitalization settings.
 504          *
 505          * @param string $titlePart Title part
 506          * @param int $defaultNamespace Namespace of the title
 507          * @return string DBkey (no namespace prefix)
 508          */
 509         public function titlePartToKey( $titlePart, $namespace = NS_MAIN ) {
 510                 $t = Title::makeTitleSafe( $namespace, $titlePart . 'x' );
 511                 if ( !$t || $t->hasFragment() ) {
 512                         // Invalid title (e.g. bad chars) or contained a '#'.
 513                         $this->dieUsageMsg( array( 'invalidtitle', $titlePart ) );
 514                 }
 515                 if ( $namespace != $t->getNamespace() || $t->isExternal() ) {
 516                         // This can happen in two cases. First, if you call titlePartToKey with a title part
 517                         // that looks like a namespace, but with $defaultNamespace = NS_MAIN. It would be very
 518                         // difficult to handle such a case. Such cases cannot exist and are therefore treated
 519                         // as invalid user input. The second case is when somebody specifies a title interwiki
 520                         // prefix.
 521                         $this->dieUsageMsg( array( 'invalidtitle', $titlePart ) );
 522                 }
 523
 524                 return substr( $t->getDbKey(), 0, -1 );
 525         }
 526
 527         /**
 528          * Gets the personalised direction parameter description
 529          *
 530          * @param string $p ModulePrefix
 531          * @param string $extraDirText Any extra text to be appended on the description
 532          * @return array
 533          */
 534         public function getDirectionDescription( $p = '', $extraDirText = '' ) {
 535                 return array(
 536                         "In which direction to enumerate{$extraDirText}",
 537                         " newer          - List oldest first. Note: {$p}start has to be before {$p}end.",
 538                         " older          - List newest first (default). Note: {$p}start has to be later than {$p}end.",
 539                 );
 540         }
 541
 542         /**
 543          * @param string $hash
 544          * @return bool
 545          */
 546         public function validateSha1Hash( $hash ) {
 547                 return preg_match( '/^[a-f0-9]{40}$/', $hash );
 548         }
 549
 550         /**
 551          * @param string $hash
 552          * @return bool
 553          */
 554         public function validateSha1Base36Hash( $hash ) {
 555                 return preg_match( '/^[a-z0-9]{31}$/', $hash );
 556         }
 557
 558         /**
 559          * Check whether the current user has permission to view revision-deleted
 560          * fields.
 561          * @return bool
 562          */
 563         public function userCanSeeRevDel() {
 564                 return $this->getUser()->isAllowedAny(
 565                         'deletedhistory',
 566                         'deletedtext',
 567                         'suppressrevision',
 568                         'viewsuppressed'
 569                 );
 570         }
 571
 572         /**@}*/
 573
 574         /************************************************************************//**
 575          * @name   Deprecated
 576          * @{
 577          */
 578
 579         /**
 580          * Estimate the row count for the SELECT query that would be run if we
 581          * called select() right now, and check if it's acceptable.
 582          * @deprecated since 1.24
 583          * @return bool True if acceptable, false otherwise
 584          */
 585         protected function checkRowCount() {
 586                 wfDeprecated( __METHOD__, '1.24' );
 587                 $db = $this->getDB();
 588                 $rowcount = $db->estimateRowCount(
 589                         $this->tables,
 590                         $this->fields,
 591                         $this->where,
 592                         __METHOD__,
 593                         $this->options
 594                 );
 595
 596                 if ( $rowcount > $this->getConfig()->get( 'APIMaxDBRows' ) ) {
 597                         return false;
 598                 }
 599
 600                 return true;
 601         }
 602
 603         /**
 604          * Convert a title to a DB key
 605          * @deprecated since 1.24, past uses of this were always incorrect and should
 606          *   have used self::titlePartToKey() instead
 607          * @param string $title Page title with spaces
 608          * @return string Page title with underscores
 609          */
 610         public function titleToKey( $title ) {
 611                 wfDeprecated( __METHOD__, '1.24' );
 612                 // Don't throw an error if we got an empty string
 613                 if ( trim( $title ) == '' ) {
 614                         return '';
 615                 }
 616                 $t = Title::newFromText( $title );
 617                 if ( !$t ) {
 618                         $this->dieUsageMsg( array( 'invalidtitle', $title ) );
 619                 }
 620
 621                 return $t->getPrefixedDBkey();
 622         }
 623
 624         /**
 625          * The inverse of titleToKey()
 626          * @deprecated since 1.24, unused and probably never needed
 627          * @param string $key Page title with underscores
 628          * @return string Page title with spaces
 629          */
 630         public function keyToTitle( $key ) {
 631                 wfDeprecated( __METHOD__, '1.24' );
 632                 // Don't throw an error if we got an empty string
 633                 if ( trim( $key ) == '' ) {
 634                         return '';
 635                 }
 636                 $t = Title::newFromDBkey( $key );
 637                 // This really shouldn't happen but we gotta check anyway
 638                 if ( !$t ) {
 639                         $this->dieUsageMsg( array( 'invalidtitle', $key ) );
 640                 }
 641
 642                 return $t->getPrefixedText();
 643         }
 644
 645         /**
 646          * Inverse of titlePartToKey()
 647          * @deprecated since 1.24, unused and probably never needed
 648          * @param string $keyPart DBkey, with prefix
 649          * @return string Key part with underscores
 650          */
 651         public function keyPartToTitle( $keyPart ) {
 652                 wfDeprecated( __METHOD__, '1.24' );
 653                 return substr( $this->keyToTitle( $keyPart . 'x' ), 0, -1 );
 654         }
 655
 656         /**@}*/
 657 }
 658
 659 /**
 660  * @ingroup API
 661  */
 662 abstract class ApiQueryGeneratorBase extends ApiQueryBase {
 663
 664         private $mGeneratorPageSet = null;
 665
 666         /**
 667          * Switch this module to generator mode. By default, generator mode is
 668          * switched off and the module acts like a normal query module.
 669          * @since 1.21 requires pageset parameter
 670          * @param ApiPageSet $generatorPageSet ApiPageSet object that the module will get
 671          *        by calling getPageSet() when in generator mode.
 672          */
 673         public function setGeneratorMode( ApiPageSet $generatorPageSet ) {
 674                 if ( $generatorPageSet === null ) {
 675                         ApiBase::dieDebug( __METHOD__, 'Required parameter missing - $generatorPageSet' );
 676                 }
 677                 $this->mGeneratorPageSet = $generatorPageSet;
 678         }
 679
 680         /**
 681          * Get the PageSet object to work on.
 682          * If this module is generator, the pageSet object is different from other module's
 683          * @return ApiPageSet
 684          */
 685         protected function getPageSet() {
 686                 if ( $this->mGeneratorPageSet !== null ) {
 687                         return $this->mGeneratorPageSet;
 688                 }
 689
 690                 return parent::getPageSet();
 691         }
 692
 693         /**
 694          * Overrides ApiBase to prepend 'g' to every generator parameter
 695          * @param string $paramName Parameter name
 696          * @return string Prefixed parameter name
 697          */
 698         public function encodeParamName( $paramName ) {
 699                 if ( $this->mGeneratorPageSet !== null ) {
 700                         return 'g' . parent::encodeParamName( $paramName );
 701                 } else {
 702                         return parent::encodeParamName( $paramName );
 703                 }
 704         }
 705
 706         /**
 707          * Overridden to set the generator param if in generator mode
 708          * @param string $paramName Parameter name
 709          * @param string|array $paramValue Parameter value
 710          */
 711         protected function setContinueEnumParameter( $paramName, $paramValue ) {
 712                 if ( $this->mGeneratorPageSet !== null ) {
 713                         $this->getResult()->setGeneratorContinueParam( $this, $paramName, $paramValue );
 714                 } else {
 715                         parent::setContinueEnumParameter( $paramName, $paramValue );
 716                 }
 717         }
 718
 719         /**
 720          * @see ApiBase::getHelpFlags()
 721          *
 722          * Corresponding messages: api-help-flag-generator
 723          */
 724         protected function getHelpFlags() {
 725                 $flags = parent::getHelpFlags();
 726                 $flags[] = 'generator';
 727                 return $flags;
 728         }
 729
 730         /**
 731          * Execute this module as a generator
 732          * @param ApiPageSet $resultPageSet All output should be appended to this object
 733          */
 734         abstract public function executeGenerator( $resultPageSet );
 735 }