MediaWiki  1.33.0
Go to the documentation of this file.
1 <?php
32  public function __construct( ApiQuery $query, $moduleName ) {
33  parent::__construct( $query, $moduleName, 'iwbl' );
34  }
36  public function execute() {
37  $this->run();
38  }
40  public function executeGenerator( $resultPageSet ) {
41  $this->run( $resultPageSet );
42  }
48  public function run( $resultPageSet = null ) {
49  $params = $this->extractRequestParams();
51  if ( isset( $params['title'] ) && !isset( $params['prefix'] ) ) {
52  $this->dieWithError(
53  [
54  'apierror-invalidparammix-mustusewith',
55  $this->encodeParamName( 'title' ),
56  $this->encodeParamName( 'prefix' ),
57  ],
58  'invalidparammix'
59  );
60  }
62  if ( !is_null( $params['continue'] ) ) {
63  $cont = explode( '|', $params['continue'] );
64  $this->dieContinueUsageIf( count( $cont ) != 3 );
66  $db = $this->getDB();
67  $op = $params['dir'] == 'descending' ? '<' : '>';
68  $prefix = $db->addQuotes( $cont[0] );
69  $title = $db->addQuotes( $cont[1] );
70  $from = (int)$cont[2];
71  $this->addWhere(
72  "iwl_prefix $op $prefix OR " .
73  "(iwl_prefix = $prefix AND " .
74  "(iwl_title $op $title OR " .
75  "(iwl_title = $title AND " .
76  "iwl_from $op= $from)))"
77  );
78  }
80  $prop = array_flip( $params['prop'] );
81  $iwprefix = isset( $prop['iwprefix'] );
82  $iwtitle = isset( $prop['iwtitle'] );
84  $this->addTables( [ 'iwlinks', 'page' ] );
85  $this->addWhere( 'iwl_from = page_id' );
87  $this->addFields( [ 'page_id', 'page_title', 'page_namespace', 'page_is_redirect',
88  'iwl_from', 'iwl_prefix', 'iwl_title' ] );
90  $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
91  if ( isset( $params['prefix'] ) ) {
92  $this->addWhereFld( 'iwl_prefix', $params['prefix'] );
93  if ( isset( $params['title'] ) ) {
94  $this->addWhereFld( 'iwl_title', $params['title'] );
95  $this->addOption( 'ORDER BY', 'iwl_from' . $sort );
96  } else {
97  $this->addOption( 'ORDER BY', [
98  'iwl_title' . $sort,
99  'iwl_from' . $sort
100  ] );
101  }
102  } else {
103  $this->addOption( 'ORDER BY', [
104  'iwl_prefix' . $sort,
105  'iwl_title' . $sort,
106  'iwl_from' . $sort
107  ] );
108  }
110  $this->addOption( 'LIMIT', $params['limit'] + 1 );
112  $res = $this->select( __METHOD__ );
114  $pages = [];
116  $count = 0;
117  $result = $this->getResult();
118  foreach ( $res as $row ) {
119  if ( ++$count > $params['limit'] ) {
120  // We've reached the one extra which shows that there are
121  // additional pages to be had. Stop here...
122  // Continue string preserved in case the redirect query doesn't
123  // pass the limit
125  'continue',
126  "{$row->iwl_prefix}|{$row->iwl_title}|{$row->iwl_from}"
127  );
128  break;
129  }
131  if ( !is_null( $resultPageSet ) ) {
132  $pages[] = Title::newFromRow( $row );
133  } else {
134  $entry = [ 'pageid' => (int)$row->page_id ];
136  $title = Title::makeTitle( $row->page_namespace, $row->page_title );
139  if ( $row->page_is_redirect ) {
140  $entry['redirect'] = true;
141  }
143  if ( $iwprefix ) {
144  $entry['iwprefix'] = $row->iwl_prefix;
145  }
147  if ( $iwtitle ) {
148  $entry['iwtitle'] = $row->iwl_title;
149  }
151  $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $entry );
152  if ( !$fit ) {
154  'continue',
155  "{$row->iwl_prefix}|{$row->iwl_title}|{$row->iwl_from}"
156  );
157  break;
158  }
159  }
160  }
162  if ( is_null( $resultPageSet ) ) {
163  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'iw' );
164  } else {
165  $resultPageSet->populateFromTitles( $pages );
166  }
167  }
169  public function getCacheMode( $params ) {
170  return 'public';
171  }
173  public function getAllowedParams() {
174  return [
175  'prefix' => null,
176  'title' => null,
177  'continue' => [
178  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
179  ],
180  'limit' => [
181  ApiBase::PARAM_DFLT => 10,
182  ApiBase::PARAM_TYPE => 'limit',
183  ApiBase::PARAM_MIN => 1,
186  ],
187  'prop' => [
188  ApiBase::PARAM_ISMULTI => true,
189  ApiBase::PARAM_DFLT => '',
191  'iwprefix',
192  'iwtitle',
193  ],
195  ],
196  'dir' => [
197  ApiBase::PARAM_DFLT => 'ascending',
199  'ascending',
200  'descending'
201  ]
202  ],
203  ];
204  }
206  protected function getExamplesMessages() {
207  return [
208  'action=query&list=iwbacklinks&iwbltitle=Test&iwblprefix=wikibooks'
209  => 'apihelp-query+iwbacklinks-example-simple',
210  'action=query&generator=iwbacklinks&giwbltitle=Test&giwblprefix=wikibooks&prop=info'
211  => 'apihelp-query+iwbacklinks-example-generator',
212  ];
213  }
215  public function getHelpUrls() {
216  return '';
217  }
218 }
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:190
This is the main query class.
Definition: ApiQuery.php:36
encodeParamName( $paramName)
Overrides ApiBase to prepend 'g' to every generator parameter.
Definition: ApiQueryGeneratorBase.php:71
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1990
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:124
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. '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. '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 '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 since 1.28! 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:1983
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:87
Get the result object.
Definition: ApiBase.php:632
Definition: styleTest.css.php:44
Definition: database.txt:21
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:347
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
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
Definition: ApiQueryGeneratorBase.php:84
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:1588
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:99
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
static newFromRow( $row)
Make a Title object from a DB row.
Definition: Title.php:506
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:252
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:105
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:90
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:158
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:372
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:743
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:576
Definition: profileinfo.php:328
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition: ApiBase.php:2176
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
Definition: ApiQueryBase.php:258
Definition: ApiQueryGeneratorBase.php:26
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:254
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:48
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:9
Get the name of the module being executed by this instance.
Definition: ApiBase.php:512
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:51
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
Definition: ApiBase.php:96
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:225
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
Definition: ApiBase.php:157
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:510