ApiPatrol.php

Go to the documentation of this file.

<?php
class ApiPatrol extends ApiBase {

        public function execute() {
                $params = $this->extractRequestParams();

                $rc = RecentChange::newFromID( $params['rcid'] );
                if ( !$rc instanceof RecentChange ) {
                        $this->dieUsageMsg( array( 'nosuchrcid', $params['rcid'] ) );
                }
                $retval = $rc->doMarkPatrolled( $this->getUser() );

                if ( $retval ) {
                        $this->dieUsageMsg( reset( $retval ) );
                }

                $result = array( 'rcid' => intval( $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 array(
                        'token' => array(
                                ApiBase::PARAM_TYPE => 'string',
                                ApiBase::PARAM_REQUIRED => true
                        ),
                        'rcid' => array(
                                ApiBase::PARAM_TYPE => 'integer',
                                ApiBase::PARAM_REQUIRED => true
                        ),
                );
        }

        public function getParamDescription() {
                return array(
                        'token' => 'Patrol token obtained from list=recentchanges',
                        'rcid' => 'Recentchanges ID to patrol',
                );
        }

        public function getResultProperties() {
                return array(
                        '' => array(
                                'rcid' => 'integer',
                                'ns' => 'namespace',
                                'title' => 'string'
                        )
                );
        }

        public function getDescription() {
                return 'Patrol a page or revision';
        }

        public function getPossibleErrors() {
                return array_merge( parent::getPossibleErrors(), array(
                        array( 'nosuchrcid', 'rcid' ),
                ) );
        }

        public function needsToken() {
                return true;
        }

        public function getTokenSalt() {
                return 'patrol';
        }

        public function getExamples() {
                return array(
                        'api.php?action=patrol&token=123abc&rcid=230672766'
                );
        }

        public function getHelpUrls() {
                return 'https://www.mediawiki.org/wiki/API:Patrol';
        }
}