MediaWiki  master
ApiQueryGeneratorBase.php
Go to the documentation of this file.
1 <?php
26 abstract class ApiQueryGeneratorBase extends ApiQueryBase {
27 
29 
37  public function setGeneratorMode( ApiPageSet $generatorPageSet ) {
38  if ( $generatorPageSet === null ) {
39  ApiBase::dieDebug( __METHOD__, 'Required parameter missing - $generatorPageSet' );
40  }
41  $this->mGeneratorPageSet = $generatorPageSet;
42  }
43 
49  public function isInGeneratorMode() {
50  return $this->mGeneratorPageSet !== null;
51  }
52 
58  protected function getPageSet() {
59  if ( $this->mGeneratorPageSet !== null ) {
61  }
62 
63  return parent::getPageSet();
64  }
65 
71  public function encodeParamName( $paramName ) {
72  if ( $this->mGeneratorPageSet !== null ) {
73  return 'g' . parent::encodeParamName( $paramName );
74  } else {
75  return parent::encodeParamName( $paramName );
76  }
77  }
78 
84  protected function setContinueEnumParameter( $paramName, $paramValue ) {
85  if ( $this->mGeneratorPageSet !== null ) {
86  $this->getContinuationManager()->addGeneratorContinueParam( $this, $paramName, $paramValue );
87  } else {
88  parent::setContinueEnumParameter( $paramName, $paramValue );
89  }
90  }
91 
93  protected function getHelpFlags() {
94  // Corresponding messages: api-help-flag-generator
95  $flags = parent::getHelpFlags();
96  $flags[] = 'generator';
97  return $flags;
98  }
99 
104  abstract public function executeGenerator( $resultPageSet );
105 }
isInGeneratorMode()
Indicate whether the module is in generator mode.
This class contains a list of pages that the client has requested.
Definition: ApiPageSet.php:40
This is a base class for all Query modules.
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
setGeneratorMode(ApiPageSet $generatorPageSet)
Switch this module to generator mode.
getContinuationManager()
Get the continuation manager.
Definition: ApiBase.php:680
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
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:35
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
Definition: ApiBase.php:2212
executeGenerator( $resultPageSet)
Execute this module as a generator.
getPageSet()
Get the PageSet object to work on.
encodeParamName( $paramName)
Overrides ApiBase to prepend &#39;g&#39; to every generator parameter.