MediaWiki master
ApiQueryLangBacklinks.php
Go to the documentation of this file.
1<?php
29
35
40 public function __construct( ApiQuery $query, $moduleName ) {
41 parent::__construct( $query, $moduleName, 'lbl' );
42 }
43
44 public function execute() {
45 $this->run();
46 }
47
48 public function executeGenerator( $resultPageSet ) {
49 $this->run( $resultPageSet );
50 }
51
56 public function run( $resultPageSet = null ) {
58
59 if ( isset( $params['title'] ) && !isset( $params['lang'] ) ) {
60 $this->dieWithError(
61 [
62 'apierror-invalidparammix-mustusewith',
63 $this->encodeParamName( 'title' ),
64 $this->encodeParamName( 'lang' )
65 ],
66 'nolang'
67 );
68 }
69
70 if ( $params['continue'] !== null ) {
71 $cont = $this->parseContinueParamOrDie( $params['continue'], [ 'string', 'string', 'int' ] );
72 $db = $this->getDB();
73 $op = $params['dir'] == 'descending' ? '<=' : '>=';
74 $this->addWhere( $db->buildComparison( $op, [
75 'll_lang' => $cont[0],
76 'll_title' => $cont[1],
77 'll_from' => $cont[2],
78 ] ) );
79 }
80
81 $prop = array_fill_keys( $params['prop'], true );
82 $lllang = isset( $prop['lllang'] );
83 $lltitle = isset( $prop['lltitle'] );
84
85 $this->addTables( [ 'langlinks', 'page' ] );
86 $this->addWhere( 'll_from = page_id' );
87
88 $this->addFields( [ 'page_id', 'page_title', 'page_namespace', 'page_is_redirect',
89 'll_from', 'll_lang', 'll_title' ] );
90
91 $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
92 if ( isset( $params['lang'] ) ) {
93 $this->addWhereFld( 'll_lang', $params['lang'] );
94 if ( isset( $params['title'] ) ) {
95 $this->addWhereFld( 'll_title', $params['title'] );
96 $this->addOption( 'ORDER BY', 'll_from' . $sort );
97 } else {
98 $this->addOption( 'ORDER BY', [
99 'll_title' . $sort,
100 'll_from' . $sort
101 ] );
102 }
103 } else {
104 $this->addOption( 'ORDER BY', [
105 'll_lang' . $sort,
106 'll_title' . $sort,
107 'll_from' . $sort
108 ] );
109 }
110
111 $this->addOption( 'LIMIT', $params['limit'] + 1 );
112
113 $res = $this->select( __METHOD__ );
114
115 $pages = [];
116
117 $count = 0;
118 $result = $this->getResult();
119
120 if ( $resultPageSet === null ) {
121 $this->executeGenderCacheFromResultWrapper( $res, __METHOD__ );
122 }
123
124 foreach ( $res as $row ) {
125 if ( ++$count > $params['limit'] ) {
126 // We've reached the one extra which shows that there are
127 // additional pages to be had. Stop here... Continue string
128 // preserved in case the redirect query doesn't pass the limit.
130 'continue',
131 "{$row->ll_lang}|{$row->ll_title}|{$row->ll_from}"
132 );
133 break;
134 }
135
136 if ( $resultPageSet !== null ) {
137 $pages[] = Title::newFromRow( $row );
138 } else {
139 $entry = [ 'pageid' => (int)$row->page_id ];
140
141 $title = Title::makeTitle( $row->page_namespace, $row->page_title );
142 ApiQueryBase::addTitleInfo( $entry, $title );
143
144 if ( $row->page_is_redirect ) {
145 $entry['redirect'] = true;
146 }
147
148 if ( $lllang ) {
149 $entry['lllang'] = $row->ll_lang;
150 }
151
152 if ( $lltitle ) {
153 $entry['lltitle'] = $row->ll_title;
154 }
155
156 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $entry );
157 if ( !$fit ) {
159 'continue',
160 "{$row->ll_lang}|{$row->ll_title}|{$row->ll_from}"
161 );
162 break;
163 }
164 }
165 }
166
167 if ( $resultPageSet === null ) {
168 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'll' );
169 } else {
170 $resultPageSet->populateFromTitles( $pages );
171 }
172 }
173
174 public function getCacheMode( $params ) {
175 return 'public';
176 }
177
178 public function getAllowedParams() {
179 return [
180 'lang' => null,
181 'title' => null,
182 'continue' => [
183 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
184 ],
185 'limit' => [
186 ParamValidator::PARAM_DEFAULT => 10,
187 ParamValidator::PARAM_TYPE => 'limit',
188 IntegerDef::PARAM_MIN => 1,
189 IntegerDef::PARAM_MAX => ApiBase::LIMIT_BIG1,
190 IntegerDef::PARAM_MAX2 => ApiBase::LIMIT_BIG2
191 ],
192 'prop' => [
193 ParamValidator::PARAM_ISMULTI => true,
194 ParamValidator::PARAM_DEFAULT => '',
195 ParamValidator::PARAM_TYPE => [
196 'lllang',
197 'lltitle',
198 ],
200 ],
201 'dir' => [
202 ParamValidator::PARAM_DEFAULT => 'ascending',
203 ParamValidator::PARAM_TYPE => [
204 'ascending',
205 'descending'
206 ]
207 ],
208 ];
209 }
210
211 protected function getExamplesMessages() {
212 return [
213 'action=query&list=langbacklinks&lbltitle=Test&lbllang=fr'
214 => 'apihelp-query+langbacklinks-example-simple',
215 'action=query&generator=langbacklinks&glbltitle=Test&glbllang=fr&prop=info'
216 => 'apihelp-query+langbacklinks-example-generator',
217 ];
218 }
219
220 public function getHelpUrls() {
221 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Langbacklinks';
222 }
223}
array $params
The job parameters.
run()
Run the job.
dieWithError( $msg, $code=null, $data=null, $httpCode=0)
Abort execution with an error.
Definition ApiBase.php:1533
parseContinueParamOrDie(string $continue, array $types)
Parse the 'continue' parameter in the usual format and validate the types of each part,...
Definition ApiBase.php:1725
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, or 'string' with PARAM_ISMULTI,...
Definition ApiBase.php:211
const LIMIT_BIG1
Fast query, standard limit.
Definition ApiBase.php:236
getResult()
Get the result object.
Definition ApiBase.php:671
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:811
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition ApiBase.php:171
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition ApiBase.php:238
getModuleName()
Get the name of the module being executed by this instance.
Definition ApiBase.php:532
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
addFields( $value)
Add a set of fields to select to the internal array.
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)
executeGenderCacheFromResultWrapper(IResultWrapper $res, $fname=__METHOD__, $fieldPrefix='page')
Preprocess the result set to fill the GenderCache with the necessary information before using self::a...
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 ] )
addWhere( $value)
Add a set of WHERE clauses to the internal array.
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
encodeParamName( $paramName)
Overrides ApiBase to prepend 'g' to every generator parameter.
This is the main query class.
Definition ApiQuery.php:43
Represents a title within MediaWiki.
Definition Title.php:78
Service for formatting and validating API parameters.
Type definition for integer types.