MediaWiki  master
ApiQueryLangBacklinks.php
Go to the documentation of this file.
1 <?php
31 
36  public function __construct( ApiQuery $query, $moduleName ) {
37  parent::__construct( $query, $moduleName, 'lbl' );
38  }
39 
40  public function execute() {
41  $this->run();
42  }
43 
44  public function executeGenerator( $resultPageSet ) {
45  $this->run( $resultPageSet );
46  }
47 
52  public function run( $resultPageSet = null ) {
53  $params = $this->extractRequestParams();
54 
55  if ( isset( $params['title'] ) && !isset( $params['lang'] ) ) {
56  $this->dieWithError(
57  [
58  'apierror-invalidparammix-mustusewith',
59  $this->encodeParamName( 'title' ),
60  $this->encodeParamName( 'lang' )
61  ],
62  'nolang'
63  );
64  }
65 
66  if ( $params['continue'] !== null ) {
67  $cont = explode( '|', $params['continue'] );
68  $this->dieContinueUsageIf( count( $cont ) != 3 );
69 
70  $db = $this->getDB();
71  $op = $params['dir'] == 'descending' ? '<' : '>';
72  $prefix = $db->addQuotes( $cont[0] );
73  $title = $db->addQuotes( $cont[1] );
74  $from = (int)$cont[2];
75  $this->addWhere(
76  "ll_lang $op $prefix OR " .
77  "(ll_lang = $prefix AND " .
78  "(ll_title $op $title OR " .
79  "(ll_title = $title AND " .
80  "ll_from $op= $from)))"
81  );
82  }
83 
84  $prop = array_fill_keys( $params['prop'], true );
85  $lllang = isset( $prop['lllang'] );
86  $lltitle = isset( $prop['lltitle'] );
87 
88  $this->addTables( [ 'langlinks', 'page' ] );
89  $this->addWhere( 'll_from = page_id' );
90 
91  $this->addFields( [ 'page_id', 'page_title', 'page_namespace', 'page_is_redirect',
92  'll_from', 'll_lang', 'll_title' ] );
93 
94  $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
95  if ( isset( $params['lang'] ) ) {
96  $this->addWhereFld( 'll_lang', $params['lang'] );
97  if ( isset( $params['title'] ) ) {
98  $this->addWhereFld( 'll_title', $params['title'] );
99  $this->addOption( 'ORDER BY', 'll_from' . $sort );
100  } else {
101  $this->addOption( 'ORDER BY', [
102  'll_title' . $sort,
103  'll_from' . $sort
104  ] );
105  }
106  } else {
107  $this->addOption( 'ORDER BY', [
108  'll_lang' . $sort,
109  'll_title' . $sort,
110  'll_from' . $sort
111  ] );
112  }
113 
114  $this->addOption( 'LIMIT', $params['limit'] + 1 );
115 
116  $res = $this->select( __METHOD__ );
117 
118  $pages = [];
119 
120  $count = 0;
121  $result = $this->getResult();
122 
123  if ( $resultPageSet === null ) {
124  $this->executeGenderCacheFromResultWrapper( $res, __METHOD__ );
125  }
126 
127  foreach ( $res as $row ) {
128  if ( ++$count > $params['limit'] ) {
129  // We've reached the one extra which shows that there are
130  // additional pages to be had. Stop here... Continue string
131  // preserved in case the redirect query doesn't pass the limit.
133  'continue',
134  "{$row->ll_lang}|{$row->ll_title}|{$row->ll_from}"
135  );
136  break;
137  }
138 
139  if ( $resultPageSet !== null ) {
140  $pages[] = Title::newFromRow( $row );
141  } else {
142  $entry = [ 'pageid' => (int)$row->page_id ];
143 
144  $title = Title::makeTitle( $row->page_namespace, $row->page_title );
146 
147  if ( $row->page_is_redirect ) {
148  $entry['redirect'] = true;
149  }
150 
151  if ( $lllang ) {
152  $entry['lllang'] = $row->ll_lang;
153  }
154 
155  if ( $lltitle ) {
156  $entry['lltitle'] = $row->ll_title;
157  }
158 
159  $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $entry );
160  if ( !$fit ) {
162  'continue',
163  "{$row->ll_lang}|{$row->ll_title}|{$row->ll_from}"
164  );
165  break;
166  }
167  }
168  }
169 
170  if ( $resultPageSet === null ) {
171  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'll' );
172  } else {
173  $resultPageSet->populateFromTitles( $pages );
174  }
175  }
176 
177  public function getCacheMode( $params ) {
178  return 'public';
179  }
180 
181  public function getAllowedParams() {
182  return [
183  'lang' => null,
184  'title' => null,
185  'continue' => [
186  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
187  ],
188  'limit' => [
189  ApiBase::PARAM_DFLT => 10,
190  ApiBase::PARAM_TYPE => 'limit',
191  ApiBase::PARAM_MIN => 1,
194  ],
195  'prop' => [
196  ApiBase::PARAM_ISMULTI => true,
197  ApiBase::PARAM_DFLT => '',
199  'lllang',
200  'lltitle',
201  ],
203  ],
204  'dir' => [
205  ApiBase::PARAM_DFLT => 'ascending',
207  'ascending',
208  'descending'
209  ]
210  ],
211  ];
212  }
213 
214  protected function getExamplesMessages() {
215  return [
216  'action=query&list=langbacklinks&lbltitle=Test&lbllang=fr'
217  => 'apihelp-query+langbacklinks-example-simple',
218  'action=query&generator=langbacklinks&glbltitle=Test&glbllang=fr&prop=info'
219  => 'apihelp-query+langbacklinks-example-generator',
220  ];
221  }
222 
223  public function getHelpUrls() {
224  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Langbacklinks';
225  }
226 }
ApiQueryBase\addFields
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:212
ApiQuery
This is the main query class.
Definition: ApiQuery.php:39
ApiQueryGeneratorBase\encodeParamName
encodeParamName( $paramName)
Overrides ApiBase to prepend 'g' to every generator parameter.
Definition: ApiQueryGeneratorBase.php:70
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1436
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:162
ApiBase\PARAM_TYPE
const PARAM_TYPE
Definition: ApiBase.php:81
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:628
ApiQueryBase\addOption
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:378
$res
$res
Definition: testCompression.php:57
ApiQueryGeneratorBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
Definition: ApiQueryGeneratorBase.php:83
ApiBase\PARAM_MIN
const PARAM_MIN
Definition: ApiBase.php:93
ApiQueryBase\executeGenderCacheFromResultWrapper
executeGenderCacheFromResultWrapper(IResultWrapper $res, $fname=__METHOD__, $fieldPrefix='page')
Preprocess the result set to fill the GenderCache with the necessary information before using self::a...
Definition: ApiQueryBase.php:626
Title\newFromRow
static newFromRow( $row)
Make a Title object from a DB row.
Definition: Title.php:595
ApiBase\LIMIT_BIG1
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:220
ApiQueryBase\getDB
getDB()
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:117
ApiBase\PARAM_MAX
const PARAM_MAX
Definition: ApiBase.php:85
ApiQueryBase\addTables
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:182
ApiQueryBase\select
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:399
ApiBase\extractRequestParams
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:764
$title
$title
Definition: testCompression.php:38
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:666
ApiBase\dieContinueUsageIf
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition: ApiBase.php:1626
ApiQueryBase\addWhereFld
addWhereFld( $field, $value)
Equivalent to addWhere( [ $field => $value ] )
Definition: ApiQueryBase.php:282
ApiQueryGeneratorBase
Definition: ApiQueryGeneratorBase.php:28
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:222
ApiBase\PARAM_DFLT
const PARAM_DFLT
Definition: ApiBase.php:73
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:497
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
Definition: ApiBase.php:77
ApiBase\PARAM_MAX2
const PARAM_MAX2
Definition: ApiBase.php:89
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:245
ApiBase\PARAM_HELP_MSG_PER_VALUE
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
ApiQueryBase\addTitleInfo
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:466