MediaWiki  1.23.2
Go to the documentation of this file.
1 <?php
31 class ApiPatrol extends ApiBase {
36  public function execute() {
37  $params = $this->extractRequestParams();
38  $this->requireOnlyOneParameter( $params, 'rcid', 'revid' );
40  if ( isset( $params['rcid'] ) ) {
41  $rc = RecentChange::newFromID( $params['rcid'] );
42  if ( !$rc ) {
43  $this->dieUsageMsg( array( 'nosuchrcid', $params['rcid'] ) );
44  }
45  } else {
46  $rev = Revision::newFromId( $params['revid'] );
47  if ( !$rev ) {
48  $this->dieUsageMsg( array( 'nosuchrevid', $params['revid'] ) );
49  }
50  $rc = $rev->getRecentChange();
51  if ( !$rc ) {
52  $this->dieUsage(
53  'The revision ' . $params['revid'] . " can't be patrolled as it's too old",
54  'notpatrollable'
55  );
56  }
57  }
59  $retval = $rc->doMarkPatrolled( $this->getUser() );
61  if ( $retval ) {
62  $this->dieUsageMsg( reset( $retval ) );
63  }
65  $result = array( 'rcid' => intval( $rc->getAttribute( 'rc_id' ) ) );
66  ApiQueryBase::addTitleInfo( $result, $rc->getTitle() );
67  $this->getResult()->addValue( null, $this->getModuleName(), $result );
68  }
70  public function mustBePosted() {
71  return true;
72  }
74  public function isWriteMode() {
75  return true;
76  }
78  public function getAllowedParams() {
79  return array(
80  'token' => array(
81  ApiBase::PARAM_TYPE => 'string',
83  ),
84  'rcid' => array(
85  ApiBase::PARAM_TYPE => 'integer'
86  ),
87  'revid' => array(
88  ApiBase::PARAM_TYPE => 'integer'
89  ),
90  );
91  }
93  public function getParamDescription() {
94  return array(
95  'token' => 'Patrol token obtained from list=recentchanges',
96  'rcid' => 'Recentchanges ID to patrol',
97  'revid' => 'Revision ID to patrol',
98  );
99  }
101  public function getResultProperties() {
102  return array(
103  '' => array(
104  'rcid' => 'integer',
105  'ns' => 'namespace',
106  'title' => 'string'
107  )
108  );
109  }
111  public function getDescription() {
112  return 'Patrol a page or revision.';
113  }
115  public function getPossibleErrors() {
116  return array_merge(
117  parent::getPossibleErrors(),
118  parent::getRequireOnlyOneParameterErrorMessages( array( 'rcid', 'revid' ) ),
119  array(
120  array( 'nosuchrcid', 'rcid' ),
121  array( 'nosuchrevid', 'revid' ),
122  array(
123  'code' => 'notpatrollable',
124  'info' => "The revision can't be patrolled as it's too old"
125  )
126  )
127  );
128  }
130  public function needsToken() {
131  return true;
132  }
134  public function getTokenSalt() {
135  return 'patrol';
136  }
138  public function getExamples() {
139  return array(
140  'api.php?action=patrol&token=123abc&rcid=230672766',
141  'api.php?action=patrol&token=123abc&revid=230672766'
142  );
143  }
145  public function getHelpUrls() {
146  return '';
147  }
148 }
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
Definition: hooks.txt:1528
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
Definition: skin.txt:62
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
Definition: Revision.php:88
Definition: ApiBase.php:62
dieUsageMsg( $error)
Output the error message related to a certain array.
Definition: ApiBase.php:1929
Definition: ApiPatrol.php:145
Definition: ApiBase.php:50
Get the result object.
Definition: ApiBase.php:205
Definition: styleTest.css.php:40
Returns an array of parameter descriptions.
Definition: ApiPatrol.php:93
Get the User object.
Definition: ContextSource.php:132
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:42
Indicates whether this module requires write mode.
Definition: ApiPatrol.php:74
Returns the description string for this module.
Definition: ApiPatrol.php:111
Indicates whether this module must be called with a POST request.
Definition: ApiPatrol.php:70
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
Returns whether this module requires a token to execute It is used to show possible errors in action=...
Definition: ApiPatrol.php:130
Returns possible properties in the result, grouped by the value of the prop parameter that shows them...
Definition: ApiPatrol.php:101
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:687
Returns a list of all possible errors returned by the module.
Definition: ApiPatrol.php:115
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...
Definition: ApiBase.php:1363
requireOnlyOneParameter( $params)
Die if none or more than one of a certain set of parameters is set and not false.
Definition: ApiBase.php:722
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
Definition: hooks.txt:1337
Get the name of the module being executed by this instance.
Definition: ApiBase.php:148
Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the mo...
Definition: ApiPatrol.php:134
Allows user to patrol pages.
Definition: ApiPatrol.php:31
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiPatrol.php:78
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 incomplete not yet checked for validity & $retval
Definition: hooks.txt:237
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:339
Patrols the article or provides the reason the patrol failed.
Definition: ApiPatrol.php:36
Returns usage examples for this module.
Definition: ApiPatrol.php:138