MediaWiki  master
ApiQueryIWLinks.php
Go to the documentation of this file.
1 <?php
32 
33  public function __construct( ApiQuery $query, $moduleName ) {
34  parent::__construct( $query, $moduleName, 'iw' );
35  }
36 
37  public function execute() {
38  if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
39  return;
40  }
41 
42  $params = $this->extractRequestParams();
43  $prop = array_flip( (array)$params['prop'] );
44 
45  if ( isset( $params['title'] ) && !isset( $params['prefix'] ) ) {
46  $this->dieWithError(
47  [
48  'apierror-invalidparammix-mustusewith',
49  $this->encodeParamName( 'title' ),
50  $this->encodeParamName( 'prefix' ),
51  ],
52  'invalidparammix'
53  );
54  }
55 
56  // Handle deprecated param
57  $this->requireMaxOneParameter( $params, 'url', 'prop' );
58  if ( $params['url'] ) {
59  $prop = [ 'url' => 1 ];
60  }
61 
62  $this->addFields( [
63  'iwl_from',
64  'iwl_prefix',
65  'iwl_title'
66  ] );
67 
68  $this->addTables( 'iwlinks' );
69  $this->addWhereFld( 'iwl_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
70 
71  if ( !is_null( $params['continue'] ) ) {
72  $cont = explode( '|', $params['continue'] );
73  $this->dieContinueUsageIf( count( $cont ) != 3 );
74  $op = $params['dir'] == 'descending' ? '<' : '>';
75  $db = $this->getDB();
76  $iwlfrom = (int)$cont[0];
77  $iwlprefix = $db->addQuotes( $cont[1] );
78  $iwltitle = $db->addQuotes( $cont[2] );
79  $this->addWhere(
80  "iwl_from $op $iwlfrom OR " .
81  "(iwl_from = $iwlfrom AND " .
82  "(iwl_prefix $op $iwlprefix OR " .
83  "(iwl_prefix = $iwlprefix AND " .
84  "iwl_title $op= $iwltitle)))"
85  );
86  }
87 
88  $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
89  if ( isset( $params['prefix'] ) ) {
90  $this->addWhereFld( 'iwl_prefix', $params['prefix'] );
91  if ( isset( $params['title'] ) ) {
92  $this->addWhereFld( 'iwl_title', $params['title'] );
93  $this->addOption( 'ORDER BY', 'iwl_from' . $sort );
94  } else {
95  $this->addOption( 'ORDER BY', [
96  'iwl_from' . $sort,
97  'iwl_title' . $sort
98  ] );
99  }
100  } else {
101  // Don't order by iwl_from if it's constant in the WHERE clause
102  if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
103  $this->addOption( 'ORDER BY', 'iwl_prefix' . $sort );
104  } else {
105  $this->addOption( 'ORDER BY', [
106  'iwl_from' . $sort,
107  'iwl_prefix' . $sort,
108  'iwl_title' . $sort
109  ] );
110  }
111  }
112 
113  $this->addOption( 'LIMIT', $params['limit'] + 1 );
114  $res = $this->select( __METHOD__ );
115 
116  $count = 0;
117  foreach ( $res as $row ) {
118  if ( ++$count > $params['limit'] ) {
119  // We've reached the one extra which shows that
120  // there are additional pages to be had. Stop here...
122  'continue',
123  "{$row->iwl_from}|{$row->iwl_prefix}|{$row->iwl_title}"
124  );
125  break;
126  }
127  $entry = [ 'prefix' => $row->iwl_prefix ];
128 
129  if ( isset( $prop['url'] ) ) {
130  $title = Title::newFromText( "{$row->iwl_prefix}:{$row->iwl_title}" );
131  if ( $title ) {
132  $entry['url'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
133  }
134  }
135 
136  ApiResult::setContentValue( $entry, 'title', $row->iwl_title );
137  $fit = $this->addPageSubItem( $row->iwl_from, $entry );
138  if ( !$fit ) {
140  'continue',
141  "{$row->iwl_from}|{$row->iwl_prefix}|{$row->iwl_title}"
142  );
143  break;
144  }
145  }
146  }
147 
148  public function getCacheMode( $params ) {
149  return 'public';
150  }
151 
152  public function getAllowedParams() {
153  return [
154  'prop' => [
155  ApiBase::PARAM_ISMULTI => true,
157  'url',
158  ],
160  ],
161  'prefix' => null,
162  'title' => null,
163  'dir' => [
164  ApiBase::PARAM_DFLT => 'ascending',
166  'ascending',
167  'descending'
168  ]
169  ],
170  'limit' => [
171  ApiBase::PARAM_DFLT => 10,
172  ApiBase::PARAM_TYPE => 'limit',
173  ApiBase::PARAM_MIN => 1,
176  ],
177  'continue' => [
178  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
179  ],
180  'url' => [
181  ApiBase::PARAM_DFLT => false,
183  ],
184  ];
185  }
186 
187  protected function getExamplesMessages() {
188  return [
189  'action=query&prop=iwlinks&titles=Main%20Page'
190  => 'apihelp-query+iwlinks-example-simple',
191  ];
192  }
193 
194  public function getHelpUrls() {
195  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Iwlinks';
196  }
197 }
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
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:1585
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
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:97
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:2008
const PROTO_CURRENT
Definition: Defines.php:218
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:760
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:164
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:2199
$params
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
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: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:930
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:131
encodeParamName( $paramName)
This method mangles parameter name based on the prefix supplied to the constructor.
Definition: ApiBase.php:738
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:58
addWhereFld( $field, $value)
Equivalent to addWhere( [ $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:112
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:106
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:319
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.