MediaWiki  master
ApiQueryLangBacklinks.php
Go to the documentation of this file.
1 <?php
31 
32  public function __construct( ApiQuery $query, $moduleName ) {
33  parent::__construct( $query, $moduleName, 'lbl' );
34  }
35 
36  public function execute() {
37  $this->run();
38  }
39 
40  public function executeGenerator( $resultPageSet ) {
41  $this->run( $resultPageSet );
42  }
43 
48  public function run( $resultPageSet = null ) {
49  $params = $this->extractRequestParams();
50 
51  if ( isset( $params['title'] ) && !isset( $params['lang'] ) ) {
52  $this->dieWithError(
53  [
54  'apierror-invalidparammix-mustusewith',
55  $this->encodeParamName( 'title' ),
56  $this->encodeParamName( 'lang' )
57  ],
58  'nolang'
59  );
60  }
61 
62  if ( !is_null( $params['continue'] ) ) {
63  $cont = explode( '|', $params['continue'] );
64  $this->dieContinueUsageIf( count( $cont ) != 3 );
65 
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  "ll_lang $op $prefix OR " .
73  "(ll_lang = $prefix AND " .
74  "(ll_title $op $title OR " .
75  "(ll_title = $title AND " .
76  "ll_from $op= $from)))"
77  );
78  }
79 
80  $prop = array_flip( $params['prop'] );
81  $lllang = isset( $prop['lllang'] );
82  $lltitle = isset( $prop['lltitle'] );
83 
84  $this->addTables( [ 'langlinks', 'page' ] );
85  $this->addWhere( 'll_from = page_id' );
86 
87  $this->addFields( [ 'page_id', 'page_title', 'page_namespace', 'page_is_redirect',
88  'll_from', 'll_lang', 'll_title' ] );
89 
90  $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
91  if ( isset( $params['lang'] ) ) {
92  $this->addWhereFld( 'll_lang', $params['lang'] );
93  if ( isset( $params['title'] ) ) {
94  $this->addWhereFld( 'll_title', $params['title'] );
95  $this->addOption( 'ORDER BY', 'll_from' . $sort );
96  } else {
97  $this->addOption( 'ORDER BY', [
98  'll_title' . $sort,
99  'll_from' . $sort
100  ] );
101  }
102  } else {
103  $this->addOption( 'ORDER BY', [
104  'll_lang' . $sort,
105  'll_title' . $sort,
106  'll_from' . $sort
107  ] );
108  }
109 
110  $this->addOption( 'LIMIT', $params['limit'] + 1 );
111 
112  $res = $this->select( __METHOD__ );
113 
114  $pages = [];
115 
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... Continue string
122  // preserved in case the redirect query doesn't pass the limit.
124  'continue',
125  "{$row->ll_lang}|{$row->ll_title}|{$row->ll_from}"
126  );
127  break;
128  }
129 
130  if ( !is_null( $resultPageSet ) ) {
131  $pages[] = Title::newFromRow( $row );
132  } else {
133  $entry = [ 'pageid' => (int)$row->page_id ];
134 
135  $title = Title::makeTitle( $row->page_namespace, $row->page_title );
137 
138  if ( $row->page_is_redirect ) {
139  $entry['redirect'] = true;
140  }
141 
142  if ( $lllang ) {
143  $entry['lllang'] = $row->ll_lang;
144  }
145 
146  if ( $lltitle ) {
147  $entry['lltitle'] = $row->ll_title;
148  }
149 
150  $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $entry );
151  if ( !$fit ) {
153  'continue',
154  "{$row->ll_lang}|{$row->ll_title}|{$row->ll_from}"
155  );
156  break;
157  }
158  }
159  }
160 
161  if ( is_null( $resultPageSet ) ) {
162  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'll' );
163  } else {
164  $resultPageSet->populateFromTitles( $pages );
165  }
166  }
167 
168  public function getCacheMode( $params ) {
169  return 'public';
170  }
171 
172  public function getAllowedParams() {
173  return [
174  'lang' => null,
175  'title' => null,
176  'continue' => [
177  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
178  ],
179  'limit' => [
180  ApiBase::PARAM_DFLT => 10,
181  ApiBase::PARAM_TYPE => 'limit',
182  ApiBase::PARAM_MIN => 1,
185  ],
186  'prop' => [
187  ApiBase::PARAM_ISMULTI => true,
188  ApiBase::PARAM_DFLT => '',
190  'lllang',
191  'lltitle',
192  ],
194  ],
195  'dir' => [
196  ApiBase::PARAM_DFLT => 'ascending',
198  'ascending',
199  'descending'
200  ]
201  ],
202  ];
203  }
204 
205  protected function getExamplesMessages() {
206  return [
207  'action=query&list=langbacklinks&lbltitle=Test&lbllang=fr'
208  => 'apihelp-query+langbacklinks-example-simple',
209  'action=query&generator=langbacklinks&glbltitle=Test&glbllang=fr&prop=info'
210  => 'apihelp-query+langbacklinks-example-generator',
211  ];
212  }
213 
214  public function getHelpUrls() {
215  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Langbacklinks';
216  }
217 }
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:94
getDB()
Get the Query database connection (read-only)
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:261
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
getResult()
Get the result object.
Definition: ApiBase.php:640
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:55
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:259
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:97
$sort
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:2005
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:761
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:164
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
static newFromRow( $row)
Make a Title object from a DB row.
Definition: Title.php:518
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
dieContinueUsageIf( $condition)
Die with the &#39;badcontinue&#39; error.
Definition: ApiBase.php:2199
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:520
addFields( $value)
Add a set of fields to select to the internal array.
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE &#39;limit&#39;.
Definition: ApiBase.php:103
This is the main query class.
Definition: ApiQuery.php:37
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:131
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:586
addWhere( $value)
Add a set of WHERE clauses to the internal array.
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:58
addWhereFld( $field, $value)
Equivalent to addWhere( [ $field => $value ] )
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:106
encodeParamName( $paramName)
Overrides ApiBase to prepend &#39;g&#39; to every generator parameter.