Go to the documentation of this file.
39 if (
$user->isAnon() ) {
40 $this->
dieUsage(
'Anonymous users cannot use watchlist change notifications',
'notloggedin' );
42 if ( !
$user->isAllowed(
'editmywatchlist' ) ) {
43 $this->
dieUsage(
'You don\'t have permission to edit your watchlist',
'permissiondenied' );
50 if (
$params[
'entirewatchlist'] && $pageSet->getDataSource() !== null ) {
52 "Cannot use 'entirewatchlist' at the same time as '{$pageSet->getDataSource()}'",
60 if ( isset(
$params[
'timestamp'] ) ) {
64 if ( !
$params[
'entirewatchlist'] ) {
68 if ( isset(
$params[
'torevid'] ) ) {
69 if (
$params[
'entirewatchlist'] || $pageSet->getGoodTitleCount() > 1 ) {
70 $this->
dieUsage(
'torevid may only be used with a single page',
'multpages' );
72 $title = reset( $pageSet->getGoodTitles() );
79 } elseif ( isset(
$params[
'newerthanrevid'] ) ) {
80 if (
$params[
'entirewatchlist'] || $pageSet->getGoodTitleCount() > 1 ) {
81 $this->
dieUsage(
'newerthanrevid may only be used with a single page',
'multpages' );
83 $title = reset( $pageSet->getGoodTitles() );
84 $revid =
$title->getNextRevisionID(
$params[
'newerthanrevid'] );
94 if (
$params[
'entirewatchlist'] ) {
96 $dbw->update(
'watchlist',
array(
'wl_notificationtimestamp' =>
$timestamp ),
106 foreach ( $pageSet->getInvalidTitles()
as $title ) {
112 foreach ( $pageSet->getMissingPageIDs()
as $p ) {
114 $page[
'pageid'] = $p;
115 $page[
'missing'] =
'';
116 $page[
'notwatched'] =
'';
119 foreach ( $pageSet->getMissingRevisionIDs()
as $r ) {
122 $rev[
'missing'] =
'';
123 $rev[
'notwatched'] =
'';
129 $dbw->update(
'watchlist',
array(
'wl_notificationtimestamp' =>
$timestamp ),
130 array(
'wl_user' =>
$user->getID(),
$lb->constructSet(
'wl', $dbw ) ),
135 $timestamps =
array();
138 array(
'wl_namespace',
'wl_title',
'wl_notificationtimestamp' ),
139 array(
'wl_user' =>
$user->getID(),
$lb->constructSet(
'wl', $dbw ) ),
142 foreach (
$res as $row ) {
143 $timestamps[$row->wl_namespace][$row->wl_title] = $row->wl_notificationtimestamp;
148 foreach ( $pageSet->getTitles()
as $title ) {
149 $ns =
$title->getNamespace();
150 $dbkey =
$title->getDBkey();
152 'ns' => intval( $ns ),
153 'title' =>
$title->getPrefixedText(),
155 if ( !
$title->exists() ) {
158 if ( isset( $timestamps[$ns] ) && array_key_exists( $dbkey, $timestamps[$ns] ) ) {
159 $r[
'notificationtimestamp'] =
'';
160 if ( $timestamps[$ns][$dbkey] !==
null ) {
164 $r[
'notwatched'] =
'';
169 $apiResult->setIndexedTagName(
$result,
'page' );
179 if ( !isset( $this->mPageSet ) ) {
204 'entirewatchlist' =>
array(
208 'timestamp' =>
array(
214 'newerthanrevid' =>
array(
227 'entirewatchlist' =>
'Work on all watched pages',
228 'timestamp' =>
'Timestamp to which to set the notification timestamp',
229 'torevid' =>
'Revision to set the notification timestamp to (one page only)',
230 'newerthanrevid' =>
'Revision to set the notification timestamp newer than (one page only)',
231 'token' =>
'A token previously acquired via prop=info',
239 'notificationtimestamp' =>
array(
261 'invalid' =>
'boolean',
262 'missing' =>
'boolean',
263 'notwatched' =>
'boolean',
264 'notificationtimestamp' =>
array(
273 return array(
'Update the notification timestamp for watched pages.',
274 'This affects the highlighting of changed pages in the watchlist and history,',
275 'and the sending of email when the "Email me when a page on my watchlist is',
276 'changed" preference is enabled.'
284 parent::getPossibleErrors(),
285 $ps->getFinalPossibleErrors(),
287 array(
'timestamp',
'torevid',
'newerthanrevid' ) ),
289 array_merge(
array(
'entirewatchlist' ), array_keys( $ps->getFinalParams() ) ) ),
291 array(
'code' =>
'notloggedin',
'info'
292 =>
'Anonymous users cannot use watchlist change notifications' ),
293 array(
'code' =>
'multpages',
'info' =>
'torevid may only be used with a single page' ),
294 array(
'code' =>
'multpages',
'info' =>
'newerthanrevid may only be used with a single page' ),
301 'api.php?action=setnotificationtimestamp&entirewatchlist=&token=123ABC'
302 =>
'Reset the notification status for the entire watchlist',
303 'api.php?action=setnotificationtimestamp&titles=Main_page&token=123ABC'
304 =>
'Reset the notification status for "Main page"',
305 'api.php?action=setnotificationtimestamp&titles=Main_page&' .
306 'timestamp=2012-01-01T00:00:00Z&token=123ABC'
307 =>
'Set the notification timestamp for "Main page" so all edits ' .
308 'since 1 January 2012 are unviewed',
313 return 'https://www.mediawiki.org/wiki/API:SetNotificationTimestamp';
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. $title:Title object for the current page $request:WebRequest $ignoreRedirect:boolean to skip redirect check $target:Title/string of redirect target $article:Article object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) $article:article(object) being checked 'IsTrustedProxy':Override the result of wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of User::isValidEmailAddr(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetMagic':DEPRECATED, use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetSpecialPageAliases':DEPRECATED, use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Associative array mapping language codes to prefixed links of the form "language:title". & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LinkBegin':Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Class representing a list of titles The execute() method checks them all for existence and adds them ...
getParamDescription()
Returns an array of parameter descriptions.
getTokenSalt()
Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the mo...
& wfGetDB( $db, $groups=array(), $wiki=false)
Get a Database object.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
getResult()
Get the result object.
getResultProperties()
Returns possible properties in the result, grouped by the value of the prop parameter that shows them...
mustBePosted()
Indicates whether this module must be called with a POST request.
it s the revision text itself In either if gzip is the revision text is gzipped $flags
getUser()
Get the User object.
This class contains a list of pages that the client has requested.
This abstract class implements many basic API functions, and is the base of all API classes.
static getTimestampFromId( $title, $id)
Get rev_timestamp from rev_id, without loading the rest of the row.
getPossibleErrors()
Returns a list of all possible errors returned by the module.
if( $wgAPIRequestLog) $lb
getExamples()
Returns usage examples for this module.
const TS_ISO_8601
ISO 8601 format with no timezone: 1986-02-09T20:00:00Z.
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
getPageSet()
Get a cached instance of an ApiPageSet object.
getRequireOnlyOneParameterErrorMessages( $params)
Generates the possible errors requireOnlyOneParameter() can die with.
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
presenting them properly to the user as errors is done by the caller $title
dieUsage( $description, $errorCode, $httpRespCode=0, $extradata=null)
Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an...
getDescription()
Returns the description string for this module.
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 account $user
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
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
getModuleName()
Get the name of the module being executed by this instance.
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
API interface for setting the wl_notificationtimestamp field.
needsToken()
Returns whether this module requires a token to execute It is used to show possible errors in action=...
getAllowedParams( $flags=0)
getRequireMaxOneParameterErrorMessages( $params)
Generates the possible error requireMaxOneParameter() can die with.
requireMaxOneParameter( $params)
Die if more than one of a certain set of parameters is set and not false.
isWriteMode()
Indicates whether this module requires write mode.