MediaWiki  1.28.0
ApiQueryIWLinks.php
Go to the documentation of this file.
1 <?php
34 
35  public function __construct( ApiQuery $query, $moduleName ) {
36  parent::__construct( $query, $moduleName, 'iw' );
37  }
38 
39  public function execute() {
40  if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
41  return;
42  }
43 
44  $params = $this->extractRequestParams();
45  $prop = array_flip( (array)$params['prop'] );
46 
47  if ( isset( $params['title'] ) && !isset( $params['prefix'] ) ) {
48  $this->dieUsageMsg( [ 'missingparam', 'prefix' ] );
49  }
50 
51  // Handle deprecated param
52  $this->requireMaxOneParameter( $params, 'url', 'prop' );
53  if ( $params['url'] ) {
54  $prop = [ 'url' => 1 ];
55  }
56 
57  $this->addFields( [
58  'iwl_from',
59  'iwl_prefix',
60  'iwl_title'
61  ] );
62 
63  $this->addTables( 'iwlinks' );
64  $this->addWhereFld( 'iwl_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
65 
66  if ( !is_null( $params['continue'] ) ) {
67  $cont = explode( '|', $params['continue'] );
68  $this->dieContinueUsageIf( count( $cont ) != 3 );
69  $op = $params['dir'] == 'descending' ? '<' : '>';
70  $db = $this->getDB();
71  $iwlfrom = intval( $cont[0] );
72  $iwlprefix = $db->addQuotes( $cont[1] );
73  $iwltitle = $db->addQuotes( $cont[2] );
74  $this->addWhere(
75  "iwl_from $op $iwlfrom OR " .
76  "(iwl_from = $iwlfrom AND " .
77  "(iwl_prefix $op $iwlprefix OR " .
78  "(iwl_prefix = $iwlprefix AND " .
79  "iwl_title $op= $iwltitle)))"
80  );
81  }
82 
83  $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
84  if ( isset( $params['prefix'] ) ) {
85  $this->addWhereFld( 'iwl_prefix', $params['prefix'] );
86  if ( isset( $params['title'] ) ) {
87  $this->addWhereFld( 'iwl_title', $params['title'] );
88  $this->addOption( 'ORDER BY', 'iwl_from' . $sort );
89  } else {
90  $this->addOption( 'ORDER BY', [
91  'iwl_from' . $sort,
92  'iwl_title' . $sort
93  ] );
94  }
95  } else {
96  // Don't order by iwl_from if it's constant in the WHERE clause
97  if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
98  $this->addOption( 'ORDER BY', 'iwl_prefix' . $sort );
99  } else {
100  $this->addOption( 'ORDER BY', [
101  'iwl_from' . $sort,
102  'iwl_prefix' . $sort,
103  'iwl_title' . $sort
104  ] );
105  }
106  }
107 
108  $this->addOption( 'LIMIT', $params['limit'] + 1 );
109  $res = $this->select( __METHOD__ );
110 
111  $count = 0;
112  foreach ( $res as $row ) {
113  if ( ++$count > $params['limit'] ) {
114  // We've reached the one extra which shows that
115  // there are additional pages to be had. Stop here...
117  'continue',
118  "{$row->iwl_from}|{$row->iwl_prefix}|{$row->iwl_title}"
119  );
120  break;
121  }
122  $entry = [ 'prefix' => $row->iwl_prefix ];
123 
124  if ( isset( $prop['url'] ) ) {
125  $title = Title::newFromText( "{$row->iwl_prefix}:{$row->iwl_title}" );
126  if ( $title ) {
127  $entry['url'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
128  }
129  }
130 
131  ApiResult::setContentValue( $entry, 'title', $row->iwl_title );
132  $fit = $this->addPageSubItem( $row->iwl_from, $entry );
133  if ( !$fit ) {
135  'continue',
136  "{$row->iwl_from}|{$row->iwl_prefix}|{$row->iwl_title}"
137  );
138  break;
139  }
140  }
141  }
142 
143  public function getCacheMode( $params ) {
144  return 'public';
145  }
146 
147  public function getAllowedParams() {
148  return [
149  'prop' => [
150  ApiBase::PARAM_ISMULTI => true,
152  'url',
153  ],
155  ],
156  'prefix' => null,
157  'title' => null,
158  'dir' => [
159  ApiBase::PARAM_DFLT => 'ascending',
161  'ascending',
162  'descending'
163  ]
164  ],
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=iwlinks&titles=Main%20Page'
185  => 'apihelp-query+iwlinks-example-simple',
186  ];
187  }
188 
189  public function getHelpUrls() {
190  return 'https://www.mediawiki.org/wiki/API:Iwlinks';
191  }
192 }
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:179
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:740
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:177
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:678
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
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:2229
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.
$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:2192