MediaWiki  master
ApiQueryLangLinks.php
Go to the documentation of this file.
1 <?php
24 
31 
32  public function __construct( ApiQuery $query, $moduleName ) {
33  parent::__construct( $query, $moduleName, 'll' );
34  }
35 
36  public function execute() {
37  if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
38  return;
39  }
40 
41  $params = $this->extractRequestParams();
42  $prop = array_flip( (array)$params['prop'] );
43 
44  if ( isset( $params['title'] ) && !isset( $params['lang'] ) ) {
45  $this->dieWithError(
46  [
47  'apierror-invalidparammix-mustusewith',
48  $this->encodeParamName( 'title' ),
49  $this->encodeParamName( 'lang' ),
50  ],
51  'invalidparammix'
52  );
53  }
54 
55  // Handle deprecated param
56  $this->requireMaxOneParameter( $params, 'url', 'prop' );
57  if ( $params['url'] ) {
58  $prop = [ 'url' => 1 ];
59  }
60 
61  $this->addFields( [
62  'll_from',
63  'll_lang',
64  'll_title'
65  ] );
66 
67  $this->addTables( 'langlinks' );
68  $this->addWhereFld( 'll_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
69  if ( !is_null( $params['continue'] ) ) {
70  $cont = explode( '|', $params['continue'] );
71  $this->dieContinueUsageIf( count( $cont ) != 2 );
72  $op = $params['dir'] == 'descending' ? '<' : '>';
73  $llfrom = intval( $cont[0] );
74  $lllang = $this->getDB()->addQuotes( $cont[1] );
75  $this->addWhere(
76  "ll_from $op $llfrom OR " .
77  "(ll_from = $llfrom AND " .
78  "ll_lang $op= $lllang)"
79  );
80  }
81 
82  // FIXME: (follow-up) To allow extensions to add to the language links, we need
83  // to load them all, add the extra links, then apply paging.
84  // Should not be terrible, it's not going to be more than a few hundred links.
85 
86  // Note that, since (ll_from, ll_lang) is a unique key, we don't need
87  // to sort by ll_title to ensure deterministic ordering.
88  $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
89  if ( isset( $params['lang'] ) ) {
90  $this->addWhereFld( 'll_lang', $params['lang'] );
91  if ( isset( $params['title'] ) ) {
92  $this->addWhereFld( 'll_title', $params['title'] );
93  }
94  $this->addOption( 'ORDER BY', 'll_from' . $sort );
95  } else {
96  // Don't order by ll_from if it's constant in the WHERE clause
97  if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
98  $this->addOption( 'ORDER BY', 'll_lang' . $sort );
99  } else {
100  $this->addOption( 'ORDER BY', [
101  'll_from' . $sort,
102  'll_lang' . $sort
103  ] );
104  }
105  }
106 
107  $this->addOption( 'LIMIT', $params['limit'] + 1 );
108  $res = $this->select( __METHOD__ );
109 
110  $count = 0;
111  foreach ( $res as $row ) {
112  if ( ++$count > $params['limit'] ) {
113  // We've reached the one extra which shows that
114  // there are additional pages to be had. Stop here...
115  $this->setContinueEnumParameter( 'continue', "{$row->ll_from}|{$row->ll_lang}" );
116  break;
117  }
118  $entry = [ 'lang' => $row->ll_lang ];
119  if ( isset( $prop['url'] ) ) {
120  $title = Title::newFromText( "{$row->ll_lang}:{$row->ll_title}" );
121  if ( $title ) {
122  $entry['url'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
123  }
124  }
125  if ( isset( $prop['langname'] ) ) {
126  $entry['langname'] = Language::fetchLanguageName( $row->ll_lang, $params['inlanguagecode'] );
127  }
128  if ( isset( $prop['autonym'] ) ) {
129  $entry['autonym'] = Language::fetchLanguageName( $row->ll_lang );
130  }
131  ApiResult::setContentValue( $entry, 'title', $row->ll_title );
132  $fit = $this->addPageSubItem( $row->ll_from, $entry );
133  if ( !$fit ) {
134  $this->setContinueEnumParameter( 'continue', "{$row->ll_from}|{$row->ll_lang}" );
135  break;
136  }
137  }
138  }
139 
140  public function getCacheMode( $params ) {
141  return 'public';
142  }
143 
144  public function getAllowedParams() {
145  return [
146  'prop' => [
147  ApiBase::PARAM_ISMULTI => true,
149  'url',
150  'langname',
151  'autonym',
152  ],
154  ],
155  'lang' => null,
156  'title' => null,
157  'dir' => [
158  ApiBase::PARAM_DFLT => 'ascending',
160  'ascending',
161  'descending'
162  ]
163  ],
164  'inlanguagecode' => MediaWikiServices::getInstance()->getContentLanguage()->getCode(),
165  'limit' => [
166  ApiBase::PARAM_DFLT => 10,
167  ApiBase::PARAM_TYPE => 'limit',
168  ApiBase::PARAM_MIN => 1,
171  ],
172  'continue' => [
173  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
174  ],
175  'url' => [
176  ApiBase::PARAM_DFLT => false,
178  ],
179  ];
180  }
181 
182  protected function getExamplesMessages() {
183  return [
184  'action=query&prop=langlinks&titles=Main%20Page&redirects='
185  => 'apihelp-query+langlinks-example-simple',
186  ];
187  }
188 
189  public function getHelpUrls() {
190  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Langlinks';
191  }
192 }
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:87
getDB()
Get the Query database connection (read-only)
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:254
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:1636
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:48
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:252
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:90
This is a base class for all Query modules.
$sort
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1972
const PROTO_CURRENT
Definition: Defines.php:222
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:770
getPageSet()
Get the PageSet object to work on.
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 MediaWikiServices
Definition: injection.txt:23
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
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:478
addPageSubItem( $pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
$res
Definition: database.txt:21
dieContinueUsageIf( $condition)
Die with the &#39;badcontinue&#39; error.
Definition: ApiBase.php:2140
static fetchLanguageName( $code, $inLanguage=null, $include='all')
Definition: Language.php:913
$params
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:949
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:96
This is the main query class.
Definition: ApiQuery.php:36
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
requireMaxOneParameter( $params, $required)
Die if more than one of a certain set of parameters is set and not false.
Definition: ApiBase.php:939
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:124
encodeParamName( $paramName)
This method mangles parameter name based on the prefix supplied to the constructor.
Definition: ApiBase.php:748
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
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:51
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
const PARAM_DEPRECATED
(boolean) Is the parameter deprecated (will show a warning)?
Definition: ApiBase.php:105
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:99
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:273
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.