MediaWiki  master
ApiQueryWatchlistRaw.php
Go to the documentation of this file.
1 <?php
24 
32 
33  public function __construct( ApiQuery $query, $moduleName ) {
34  parent::__construct( $query, $moduleName, 'wr' );
35  }
36 
37  public function execute() {
38  $this->run();
39  }
40 
41  public function executeGenerator( $resultPageSet ) {
42  $this->run( $resultPageSet );
43  }
44 
49  private function run( $resultPageSet = null ) {
50  $params = $this->extractRequestParams();
51 
52  $user = $this->getWatchlistUser( $params );
53 
54  $prop = array_flip( (array)$params['prop'] );
55  $show = array_flip( (array)$params['show'] );
56  if ( isset( $show[WatchedItemQueryService::FILTER_CHANGED] )
58  ) {
59  $this->dieWithError( 'apierror-show' );
60  }
61 
62  $options = [];
63  if ( $params['namespace'] ) {
64  $options['namespaceIds'] = $params['namespace'];
65  }
66  if ( isset( $show[WatchedItemQueryService::FILTER_CHANGED] ) ) {
68  }
69  if ( isset( $show[WatchedItemQueryService::FILTER_NOT_CHANGED] ) ) {
71  }
72 
73  if ( isset( $params['continue'] ) ) {
74  $cont = explode( '|', $params['continue'] );
75  $this->dieContinueUsageIf( count( $cont ) != 2 );
76  $ns = (int)$cont[0];
77  $this->dieContinueUsageIf( strval( $ns ) !== $cont[0] );
78  $title = $cont[1];
79  $options['startFrom'] = new TitleValue( $ns, $title );
80  }
81 
82  if ( isset( $params['fromtitle'] ) ) {
83  list( $ns, $title ) = $this->prefixedTitlePartToKey( $params['fromtitle'] );
84  $options['from'] = new TitleValue( $ns, $title );
85  }
86 
87  if ( isset( $params['totitle'] ) ) {
88  list( $ns, $title ) = $this->prefixedTitlePartToKey( $params['totitle'] );
89  $options['until'] = new TitleValue( $ns, $title );
90  }
91 
93  if ( $params['dir'] === 'descending' ) {
95  }
96  $options['limit'] = $params['limit'] + 1;
97 
98  $titles = [];
99  $count = 0;
100  $items = MediaWikiServices::getInstance()->getWatchedItemQueryService()
101  ->getWatchedItemsForUser( $user, $options );
102  foreach ( $items as $item ) {
103  $ns = $item->getLinkTarget()->getNamespace();
104  $dbKey = $item->getLinkTarget()->getDBkey();
105  if ( ++$count > $params['limit'] ) {
106  // We've reached the one extra which shows that there are
107  // additional pages to be had. Stop here...
108  $this->setContinueEnumParameter( 'continue', $ns . '|' . $dbKey );
109  break;
110  }
111  $t = Title::makeTitle( $ns, $dbKey );
112 
113  if ( is_null( $resultPageSet ) ) {
114  $vals = [];
115  ApiQueryBase::addTitleInfo( $vals, $t );
116  if ( isset( $prop['changed'] ) && !is_null( $item->getNotificationTimestamp() ) ) {
117  $vals['changed'] = wfTimestamp( TS_ISO_8601, $item->getNotificationTimestamp() );
118  }
119  $fit = $this->getResult()->addValue( $this->getModuleName(), null, $vals );
120  if ( !$fit ) {
121  $this->setContinueEnumParameter( 'continue', $ns . '|' . $dbKey );
122  break;
123  }
124  } else {
125  $titles[] = $t;
126  }
127  }
128  if ( is_null( $resultPageSet ) ) {
129  $this->getResult()->addIndexedTagName( $this->getModuleName(), 'wr' );
130  } else {
131  $resultPageSet->populateFromTitles( $titles );
132  }
133  }
134 
135  public function getAllowedParams() {
136  return [
137  'continue' => [
138  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
139  ],
140  'namespace' => [
141  ApiBase::PARAM_ISMULTI => true,
142  ApiBase::PARAM_TYPE => 'namespace'
143  ],
144  'limit' => [
145  ApiBase::PARAM_DFLT => 10,
146  ApiBase::PARAM_TYPE => 'limit',
147  ApiBase::PARAM_MIN => 1,
150  ],
151  'prop' => [
152  ApiBase::PARAM_ISMULTI => true,
154  'changed',
155  ],
157  ],
158  'show' => [
159  ApiBase::PARAM_ISMULTI => true,
163  ]
164  ],
165  'owner' => [
166  ApiBase::PARAM_TYPE => 'user'
167  ],
168  'token' => [
169  ApiBase::PARAM_TYPE => 'string',
170  ApiBase::PARAM_SENSITIVE => true,
171  ],
172  'dir' => [
173  ApiBase::PARAM_DFLT => 'ascending',
175  'ascending',
176  'descending'
177  ],
178  ],
179  'fromtitle' => [
180  ApiBase::PARAM_TYPE => 'string'
181  ],
182  'totitle' => [
183  ApiBase::PARAM_TYPE => 'string'
184  ],
185  ];
186  }
187 
188  protected function getExamplesMessages() {
189  return [
190  'action=query&list=watchlistraw'
191  => 'apihelp-query+watchlistraw-example-simple',
192  'action=query&generator=watchlistraw&gwrshow=changed&prop=info'
193  => 'apihelp-query+watchlistraw-example-generator',
194  ];
195  }
196 
197  public function getHelpUrls() {
198  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Watchlistraw';
199  }
200 }
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:94
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:261
executeGenerator( $resultPageSet)
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
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used $groups Array of ChangesListFilterGroup objects(added in 1.34) 'FileDeleteComplete' 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:1535
getResult()
Get the result object.
Definition: ApiBase.php:640
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
prefixedTitlePartToKey( $titlePart, $defaultNamespace=NS_MAIN)
Convert an input title or title prefix into a namespace constant and dbkey.
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
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:97
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:2009
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:761
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:164
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
dieContinueUsageIf( $condition)
Die with the &#39;badcontinue&#39; error.
Definition: ApiBase.php:2200
$params
run( $resultPageSet=null)
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:773
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:918
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:520
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
__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
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:131
const PARAM_SENSITIVE
(boolean) Is the parameter sensitive? Note &#39;password&#39;-type fields are always sensitive regardless of ...
Definition: ApiBase.php:200
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:592
getWatchlistUser( $params)
Gets the user for whom to get the watchlist.
Definition: ApiBase.php:1760
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
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:58
This query action allows clients to retrieve a list of pages on the logged-in user&#39;s watchlist...
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:106
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1460