MediaWiki  1.28.1
ApiQueryLangLinks.php
Go to the documentation of this file.
1 <?php
33 
34  public function __construct( ApiQuery $query, $moduleName ) {
35  parent::__construct( $query, $moduleName, 'll' );
36  }
37 
38  public function execute() {
39  if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
40  return;
41  }
42 
43  $params = $this->extractRequestParams();
44  $prop = array_flip( (array)$params['prop'] );
45 
46  if ( isset( $params['title'] ) && !isset( $params['lang'] ) ) {
47  $this->dieUsageMsg( [ 'missingparam', 'lang' ] );
48  }
49 
50  // Handle deprecated param
51  $this->requireMaxOneParameter( $params, 'url', 'prop' );
52  if ( $params['url'] ) {
53  $prop = [ 'url' => 1 ];
54  }
55 
56  $this->addFields( [
57  'll_from',
58  'll_lang',
59  'll_title'
60  ] );
61 
62  $this->addTables( 'langlinks' );
63  $this->addWhereFld( 'll_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
64  if ( !is_null( $params['continue'] ) ) {
65  $cont = explode( '|', $params['continue'] );
66  $this->dieContinueUsageIf( count( $cont ) != 2 );
67  $op = $params['dir'] == 'descending' ? '<' : '>';
68  $llfrom = intval( $cont[0] );
69  $lllang = $this->getDB()->addQuotes( $cont[1] );
70  $this->addWhere(
71  "ll_from $op $llfrom OR " .
72  "(ll_from = $llfrom AND " .
73  "ll_lang $op= $lllang)"
74  );
75  }
76 
77  // FIXME: (follow-up) To allow extensions to add to the language links, we need
78  // to load them all, add the extra links, then apply paging.
79  // Should not be terrible, it's not going to be more than a few hundred links.
80 
81  // Note that, since (ll_from, ll_lang) is a unique key, we don't need
82  // to sort by ll_title to ensure deterministic ordering.
83  $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
84  if ( isset( $params['lang'] ) ) {
85  $this->addWhereFld( 'll_lang', $params['lang'] );
86  if ( isset( $params['title'] ) ) {
87  $this->addWhereFld( 'll_title', $params['title'] );
88  }
89  $this->addOption( 'ORDER BY', 'll_from' . $sort );
90  } else {
91  // Don't order by ll_from if it's constant in the WHERE clause
92  if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
93  $this->addOption( 'ORDER BY', 'll_lang' . $sort );
94  } else {
95  $this->addOption( 'ORDER BY', [
96  'll_from' . $sort,
97  'll_lang' . $sort
98  ] );
99  }
100  }
101 
102  $this->addOption( 'LIMIT', $params['limit'] + 1 );
103  $res = $this->select( __METHOD__ );
104 
105  $count = 0;
106  foreach ( $res as $row ) {
107  if ( ++$count > $params['limit'] ) {
108  // We've reached the one extra which shows that
109  // there are additional pages to be had. Stop here...
110  $this->setContinueEnumParameter( 'continue', "{$row->ll_from}|{$row->ll_lang}" );
111  break;
112  }
113  $entry = [ 'lang' => $row->ll_lang ];
114  if ( isset( $prop['url'] ) ) {
115  $title = Title::newFromText( "{$row->ll_lang}:{$row->ll_title}" );
116  if ( $title ) {
117  $entry['url'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
118  }
119  }
120  if ( isset( $prop['langname'] ) ) {
121  $entry['langname'] = Language::fetchLanguageName( $row->ll_lang, $params['inlanguagecode'] );
122  }
123  if ( isset( $prop['autonym'] ) ) {
124  $entry['autonym'] = Language::fetchLanguageName( $row->ll_lang );
125  }
126  ApiResult::setContentValue( $entry, 'title', $row->ll_title );
127  $fit = $this->addPageSubItem( $row->ll_from, $entry );
128  if ( !$fit ) {
129  $this->setContinueEnumParameter( 'continue', "{$row->ll_from}|{$row->ll_lang}" );
130  break;
131  }
132  }
133  }
134 
135  public function getCacheMode( $params ) {
136  return 'public';
137  }
138 
139  public function getAllowedParams() {
141  return [
142  'prop' => [
143  ApiBase::PARAM_ISMULTI => true,
145  'url',
146  'langname',
147  'autonym',
148  ],
150  ],
151  'lang' => null,
152  'title' => null,
153  'dir' => [
154  ApiBase::PARAM_DFLT => 'ascending',
156  'ascending',
157  'descending'
158  ]
159  ],
160  'inlanguagecode' => $wgContLang->getCode(),
161  'limit' => [
162  ApiBase::PARAM_DFLT => 10,
163  ApiBase::PARAM_TYPE => 'limit',
164  ApiBase::PARAM_MIN => 1,
167  ],
168  'continue' => [
169  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
170  ],
171  'url' => [
172  ApiBase::PARAM_DFLT => false,
174  ],
175  ];
176  }
177 
178  protected function getExamplesMessages() {
179  return [
180  'action=query&prop=langlinks&titles=Main%20Page&redirects='
181  => 'apihelp-query+langlinks-example-simple',
182  ];
183  }
184 
185  public function getHelpUrls() {
186  return 'https://www.mediawiki.org/wiki/API:Langlinks';
187  }
188 }
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
getDB()
Get the Query database connection (read-only)
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:186
the array() calling protocol came about after MediaWiki 1.4rc1.
null for the local 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:1555
addWhereFld($field, $value)
Equivalent to addWhere(array($field => $value))
addPageSubItem($pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
requireMaxOneParameter($params, $required)
Die if more than one of a certain set of parameters is set and not false.
Definition: ApiBase.php:747
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:50
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:184
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:91
This is a base class for all Query modules.
$sort
extractRequestParams($parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:685
const PROTO_CURRENT
Definition: Defines.php:226
getPageSet()
Get the PageSet object to work on.
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:157
select($method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:262
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
wfExpandUrl($url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
addWhere($value)
Add a set of WHERE clauses to the internal array.
static setContentValue(array &$arr, $name, $value, $flags=0)
Add an output value to the array by name and mark as META_CONTENT.
Definition: ApiResult.php:480
$res
Definition: database.txt:21
addOption($name, $value=null)
Add an option such as LIMIT or USE INDEX.
$params
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE 'limit'.
Definition: ApiBase.php:97
This is the main query class.
Definition: ApiQuery.php:38
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
dieContinueUsageIf($condition)
Die with the $prefix.
Definition: ApiBase.php:2240
static fetchLanguageName($code, $inLanguage=null, $include= 'all')
Definition: Language.php:888
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:125
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
addFields($value)
Add a set of fields to select to the internal array.
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:53
setContinueEnumParameter($paramName, $paramValue)
Set a query-continue value.
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition: design.txt:56
$count
const PARAM_DEPRECATED
(boolean) Is the parameter deprecated (will show a warning)?
Definition: ApiBase.php:106
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:100
addTables($tables, $alias=null)
Add a set of tables to the internal array.
dieUsageMsg($error)
Output the error message related to a certain array.
Definition: ApiBase.php:2203