MediaWiki REL1_37
ApiQueryIWLinks.php
Go to the documentation of this file.
1<?php
32
33 public function __construct( ApiQuery $query, $moduleName ) {
34 parent::__construct( $query, $moduleName, 'iw' );
35 }
36
37 public function execute() {
38 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
39 return;
40 }
41
42 $params = $this->extractRequestParams();
43 $prop = array_fill_keys( (array)$params['prop'], true );
44
45 if ( isset( $params['title'] ) && !isset( $params['prefix'] ) ) {
46 $this->dieWithError(
47 [
48 'apierror-invalidparammix-mustusewith',
49 $this->encodeParamName( 'title' ),
50 $this->encodeParamName( 'prefix' ),
51 ],
52 'invalidparammix'
53 );
54 }
55
56 // Handle deprecated param
57 $this->requireMaxOneParameter( $params, 'url', 'prop' );
58 if ( $params['url'] ) {
59 $prop = [ 'url' => 1 ];
60 }
61
62 $this->addFields( [
63 'iwl_from',
64 'iwl_prefix',
65 'iwl_title'
66 ] );
67
68 $this->addTables( 'iwlinks' );
69 $this->addWhereFld( 'iwl_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
70
71 if ( $params['continue'] !== null ) {
72 $cont = explode( '|', $params['continue'] );
73 $this->dieContinueUsageIf( count( $cont ) != 3 );
74 $op = $params['dir'] == 'descending' ? '<' : '>';
75 $db = $this->getDB();
76 $iwlfrom = (int)$cont[0];
77 $iwlprefix = $db->addQuotes( $cont[1] );
78 $iwltitle = $db->addQuotes( $cont[2] );
79 $this->addWhere(
80 "iwl_from $op $iwlfrom OR " .
81 "(iwl_from = $iwlfrom AND " .
82 "(iwl_prefix $op $iwlprefix OR " .
83 "(iwl_prefix = $iwlprefix AND " .
84 "iwl_title $op= $iwltitle)))"
85 );
86 }
87
88 $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
89 if ( isset( $params['prefix'] ) ) {
90 $this->addWhereFld( 'iwl_prefix', $params['prefix'] );
91 if ( isset( $params['title'] ) ) {
92 $this->addWhereFld( 'iwl_title', $params['title'] );
93 $this->addOption( 'ORDER BY', 'iwl_from' . $sort );
94 } else {
95 $this->addOption( 'ORDER BY', [
96 'iwl_from' . $sort,
97 'iwl_title' . $sort
98 ] );
99 }
100 } else {
101 // Don't order by iwl_from if it's constant in the WHERE clause
102 if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
103 $this->addOption( 'ORDER BY', 'iwl_prefix' . $sort );
104 } else {
105 $this->addOption( 'ORDER BY', [
106 'iwl_from' . $sort,
107 'iwl_prefix' . $sort,
108 'iwl_title' . $sort
109 ] );
110 }
111 }
112
113 $this->addOption( 'LIMIT', $params['limit'] + 1 );
114 $res = $this->select( __METHOD__ );
115
116 $count = 0;
117 foreach ( $res as $row ) {
118 if ( ++$count > $params['limit'] ) {
119 // We've reached the one extra which shows that
120 // there are additional pages to be had. Stop here...
122 'continue',
123 "{$row->iwl_from}|{$row->iwl_prefix}|{$row->iwl_title}"
124 );
125 break;
126 }
127 $entry = [ 'prefix' => $row->iwl_prefix ];
128
129 if ( isset( $prop['url'] ) ) {
130 $title = Title::newFromText( "{$row->iwl_prefix}:{$row->iwl_title}" );
131 if ( $title ) {
132 $entry['url'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
133 }
134 }
135
136 ApiResult::setContentValue( $entry, 'title', $row->iwl_title );
137 $fit = $this->addPageSubItem( $row->iwl_from, $entry );
138 if ( !$fit ) {
140 'continue',
141 "{$row->iwl_from}|{$row->iwl_prefix}|{$row->iwl_title}"
142 );
143 break;
144 }
145 }
146 }
147
148 public function getCacheMode( $params ) {
149 return 'public';
150 }
151
152 public function getAllowedParams() {
153 return [
154 'prop' => [
157 'url',
158 ],
160 ],
161 'prefix' => null,
162 'title' => null,
163 'dir' => [
164 ApiBase::PARAM_DFLT => 'ascending',
166 'ascending',
167 'descending'
168 ]
169 ],
170 'limit' => [
172 ApiBase::PARAM_TYPE => 'limit',
176 ],
177 'continue' => [
178 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
179 ],
180 'url' => [
181 ApiBase::PARAM_DFLT => false,
183 ],
184 ];
185 }
186
187 protected function getExamplesMessages() {
188 return [
189 'action=query&prop=iwlinks&titles=Main%20Page'
190 => 'apihelp-query+iwlinks-example-simple',
191 ];
192 }
193
194 public function getHelpUrls() {
195 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Iwlinks';
196 }
197}
const PROTO_CURRENT
Definition Defines.php:195
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
dieWithError( $msg, $code=null, $data=null, $httpCode=0)
Abort execution with an error.
Definition ApiBase.php:1436
const PARAM_MAX2
Definition ApiBase.php:89
const PARAM_DEPRECATED
Definition ApiBase.php:101
encodeParamName( $paramName)
This method mangles parameter name based on the prefix supplied to the constructor.
Definition ApiBase.php:742
const PARAM_MAX
Definition ApiBase.php:85
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition ApiBase.php:1620
const PARAM_TYPE
Definition ApiBase.php:81
const PARAM_DFLT
Definition ApiBase.php:73
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
Definition ApiBase.php:195
const PARAM_MIN
Definition ApiBase.php:93
const LIMIT_BIG1
Fast query, standard limit.
Definition ApiBase.php:220
requireMaxOneParameter( $params,... $required)
Die if more than one of a certain set of parameters is set and not false.
Definition ApiBase.php:936
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:764
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition ApiBase.php:162
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition ApiBase.php:222
const PARAM_ISMULTI
Definition ApiBase.php:77
This is a base class for all Query modules.
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.
addFields( $value)
Add a set of fields to select to the internal array.
addPageSubItem( $pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
getDB()
Get the Query database connection (read-only)
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
addWhereFld( $field, $value)
Equivalent to addWhere( [ $field => $value ] )
getPageSet()
Get the PageSet object to work on.
addWhere( $value)
Add a set of WHERE clauses to the internal array.
This is the main query class.
Definition ApiQuery.php:37