Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F6119155
ApiPatrol.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
3 KB
Referenced Files
None
Subscribers
None
ApiPatrol.php
View Options
<?php
/**
* API for MediaWiki 1.14+
*
* Copyright © 2008 Soxred93 soxred93@gmail.com,
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace
MediaWiki\Api
;
use
ChangeTags
;
use
MediaWiki\Revision\RevisionStore
;
use
RecentChange
;
use
Wikimedia\ParamValidator\ParamValidator
;
/**
* Allows user to patrol pages
* @ingroup API
*/
class
ApiPatrol
extends
ApiBase
{
private
RevisionStore
$revisionStore
;
public
function
__construct
(
ApiMain
$main
,
string
$action
,
RevisionStore
$revisionStore
)
{
parent
::
__construct
(
$main
,
$action
);
$this
->
revisionStore
=
$revisionStore
;
}
/**
* Patrols the article or provides the reason the patrol failed.
*/
public
function
execute
()
{
$params
=
$this
->
extractRequestParams
();
$this
->
requireOnlyOneParameter
(
$params
,
'rcid'
,
'revid'
);
if
(
isset
(
$params
[
'rcid'
]
)
)
{
$rc
=
RecentChange
::
newFromId
(
$params
[
'rcid'
]
);
if
(
!
$rc
)
{
$this
->
dieWithError
(
[
'apierror-nosuchrcid'
,
$params
[
'rcid'
]
]
);
}
}
else
{
$rev
=
$this
->
revisionStore
->
getRevisionById
(
$params
[
'revid'
]
);
if
(
!
$rev
)
{
$this
->
dieWithError
(
[
'apierror-nosuchrevid'
,
$params
[
'revid'
]
]
);
}
$rc
=
$this
->
revisionStore
->
getRecentChange
(
$rev
);
if
(
!
$rc
)
{
$this
->
dieWithError
(
[
'apierror-notpatrollable'
,
$params
[
'revid'
]
]
);
}
}
$user
=
$this
->
getUser
();
$tags
=
$params
[
'tags'
];
// Check if user can add tags
if
(
$tags
!==
null
)
{
$ableToTag
=
ChangeTags
::
canAddTagsAccompanyingChange
(
$tags
,
$this
->
getAuthority
()
);
if
(
!
$ableToTag
->
isOK
()
)
{
$this
->
dieStatus
(
$ableToTag
);
}
}
$status
=
$rc
->
markPatrolled
(
$user
,
$tags
);
if
(
!
$status
->
isGood
()
)
{
$this
->
dieStatus
(
$status
);
}
$result
=
[
'rcid'
=>
(
int
)
$rc
->
getAttribute
(
'rc_id'
)
];
ApiQueryBase
::
addTitleInfo
(
$result
,
$rc
->
getTitle
()
);
$this
->
getResult
()->
addValue
(
null
,
$this
->
getModuleName
(),
$result
);
}
public
function
mustBePosted
()
{
return
true
;
}
public
function
isWriteMode
()
{
return
true
;
}
public
function
getAllowedParams
()
{
return
[
'rcid'
=>
[
ParamValidator
::
PARAM_TYPE
=>
'integer'
],
'revid'
=>
[
ParamValidator
::
PARAM_TYPE
=>
'integer'
],
'tags'
=>
[
ParamValidator
::
PARAM_TYPE
=>
'tags'
,
ParamValidator
::
PARAM_ISMULTI
=>
true
,
],
];
}
public
function
needsToken
()
{
return
'patrol'
;
}
protected
function
getExamplesMessages
()
{
return
[
'action=patrol&token=123ABC&rcid=230672766'
=>
'apihelp-patrol-example-rcid'
,
'action=patrol&token=123ABC&revid=230672766'
=>
'apihelp-patrol-example-revid'
,
];
}
public
function
getHelpUrls
()
{
return
'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Patrol'
;
}
}
/** @deprecated class alias since 1.43 */
class_alias
(
ApiPatrol
::
class
,
'ApiPatrol'
);
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Oct 7 2026, 03:17 (6 w, 3 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
83/8a/25994824785c833f808675b9a3c1
Default Alt Text
ApiPatrol.php (3 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment