MediaWiki  1.28.1
ApiQueryWatchlistRaw.php
Go to the documentation of this file.
1 <?php
28 
36 
37  public function __construct( ApiQuery $query, $moduleName ) {
38  parent::__construct( $query, $moduleName, 'wr' );
39  }
40 
41  public function execute() {
42  $this->run();
43  }
44 
45  public function executeGenerator( $resultPageSet ) {
46  $this->run( $resultPageSet );
47  }
48 
53  private function run( $resultPageSet = null ) {
54  $params = $this->extractRequestParams();
55 
56  $user = $this->getWatchlistUser( $params );
57 
58  $prop = array_flip( (array)$params['prop'] );
59  $show = array_flip( (array)$params['show'] );
60  if ( isset( $show[WatchedItemQueryService::FILTER_CHANGED] )
62  ) {
63  $this->dieUsageMsg( 'show' );
64  }
65 
66  $options = [];
67  if ( $params['namespace'] ) {
68  $options['namespaceIds'] = $params['namespace'];
69  }
70  if ( isset( $show[WatchedItemQueryService::FILTER_CHANGED] ) ) {
72  }
73  if ( isset( $show[WatchedItemQueryService::FILTER_NOT_CHANGED] ) ) {
75  }
76 
77  if ( isset( $params['continue'] ) ) {
78  $cont = explode( '|', $params['continue'] );
79  $this->dieContinueUsageIf( count( $cont ) != 2 );
80  $ns = intval( $cont[0] );
81  $this->dieContinueUsageIf( strval( $ns ) !== $cont[0] );
82  $title = $cont[1];
83  $options['startFrom'] = new TitleValue( $ns, $title );
84  }
85 
86  if ( isset( $params['fromtitle'] ) ) {
87  list( $ns, $title ) = $this->prefixedTitlePartToKey( $params['fromtitle'] );
88  $options['from'] = new TitleValue( $ns, $title );
89  }
90 
91  if ( isset( $params['totitle'] ) ) {
92  list( $ns, $title ) = $this->prefixedTitlePartToKey( $params['totitle'] );
93  $options['until'] = new TitleValue( $ns, $title );
94  }
95 
97  if ( $params['dir'] === 'descending' ) {
99  }
100  $options['limit'] = $params['limit'] + 1;
101 
102  $titles = [];
103  $count = 0;
104  $items = MediaWikiServices::getInstance()->getWatchedItemQueryService()
105  ->getWatchedItemsForUser( $user, $options );
106  foreach ( $items as $item ) {
107  $ns = $item->getLinkTarget()->getNamespace();
108  $dbKey = $item->getLinkTarget()->getDBkey();
109  if ( ++$count > $params['limit'] ) {
110  // We've reached the one extra which shows that there are
111  // additional pages to be had. Stop here...
112  $this->setContinueEnumParameter( 'continue', $ns . '|' . $dbKey );
113  break;
114  }
115  $t = Title::makeTitle( $ns, $dbKey );
116 
117  if ( is_null( $resultPageSet ) ) {
118  $vals = [];
119  ApiQueryBase::addTitleInfo( $vals, $t );
120  if ( isset( $prop['changed'] ) && !is_null( $item->getNotificationTimestamp() ) ) {
121  $vals['changed'] = wfTimestamp( TS_ISO_8601, $item->getNotificationTimestamp() );
122  }
123  $fit = $this->getResult()->addValue( $this->getModuleName(), null, $vals );
124  if ( !$fit ) {
125  $this->setContinueEnumParameter( 'continue', $ns . '|' . $dbKey );
126  break;
127  }
128  } else {
129  $titles[] = $t;
130  }
131  }
132  if ( is_null( $resultPageSet ) ) {
133  $this->getResult()->addIndexedTagName( $this->getModuleName(), 'wr' );
134  } else {
135  $resultPageSet->populateFromTitles( $titles );
136  }
137  }
138 
139  public function getAllowedParams() {
140  return [
141  'continue' => [
142  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
143  ],
144  'namespace' => [
145  ApiBase::PARAM_ISMULTI => true,
146  ApiBase::PARAM_TYPE => 'namespace'
147  ],
148  'limit' => [
149  ApiBase::PARAM_DFLT => 10,
150  ApiBase::PARAM_TYPE => 'limit',
151  ApiBase::PARAM_MIN => 1,
154  ],
155  'prop' => [
156  ApiBase::PARAM_ISMULTI => true,
158  'changed',
159  ],
161  ],
162  'show' => [
163  ApiBase::PARAM_ISMULTI => true,
167  ]
168  ],
169  'owner' => [
170  ApiBase::PARAM_TYPE => 'user'
171  ],
172  'token' => [
173  ApiBase::PARAM_TYPE => 'string',
174  ApiBase::PARAM_SENSITIVE => true,
175  ],
176  'dir' => [
177  ApiBase::PARAM_DFLT => 'ascending',
179  'ascending',
180  'descending'
181  ],
182  ],
183  'fromtitle' => [
184  ApiBase::PARAM_TYPE => 'string'
185  ],
186  'totitle' => [
187  ApiBase::PARAM_TYPE => 'string'
188  ],
189  ];
190  }
191 
192  protected function getExamplesMessages() {
193  return [
194  'action=query&list=watchlistraw'
195  => 'apihelp-query+watchlistraw-example-simple',
196  'action=query&generator=watchlistraw&gwrshow=changed&prop=info'
197  => 'apihelp-query+watchlistraw-example-generator',
198  ];
199  }
200 
201  public function getHelpUrls() {
202  return 'https://www.mediawiki.org/wiki/API:Watchlistraw';
203  }
204 }
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:186
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
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
getResult()
Get the result object.
Definition: ApiBase.php:584
getWatchlistUser($params)
Gets the user for whom to get the watchlist.
Definition: ApiBase.php:1465
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: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
Represents a page (or page fragment) title within MediaWiki.
Definition: TitleValue.php:36
extractRequestParams($parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:685
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
setContinueEnumParameter($paramName, $paramValue)
Overridden to set the generator param if in generator mode.
const TS_ISO_8601
ISO 8601 format with no timezone: 1986-02-09T20:00:00Z.
Definition: defines.php:28
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
$params
prefixedTitlePartToKey($titlePart, $defaultNamespace=NS_MAIN)
Convert an input title or title prefix into a namespace constant and dbkey.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:464
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
__construct(ApiQuery $query, $moduleName)
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
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:125
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
executeGenerator($resultPageSet)
const PARAM_SENSITIVE
(boolean) Is the parameter sensitive? Note 'password'-type fields are always sensitive regardless of ...
Definition: ApiBase.php:179
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
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition: linkcache.txt:17
run($resultPageSet=null)
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:53
$count
This query action allows clients to retrieve a list of pages on the logged-in user's watchlist...
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:100
static addTitleInfo(&$arr, $title, $prefix= '')
Add information (title and namespace) about a Title object to a result array.
static makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:511
dieUsageMsg($error)
Output the error message related to a certain array.
Definition: ApiBase.php:2203