ApiPatrol.php

Go to the documentation of this file.

<?php
class ApiPatrol extends ApiBase {

    public function execute() {
        $params = $this->extractRequestParams();
        $this->requireOnlyOneParameter( $params, 'rcid', 'revid' );

        if ( isset( $params['rcid'] ) ) {
            $rc = RecentChange::newFromID( $params['rcid'] );
            if ( !$rc ) {
                $this->dieUsageMsg( array( 'nosuchrcid', $params['rcid'] ) );
            }
        } else {
            $rev = Revision::newFromId( $params['revid'] );
            if ( !$rev ) {
                $this->dieUsageMsg( array( 'nosuchrevid', $params['revid'] ) );
            }
            $rc = $rev->getRecentChange();
            if ( !$rc ) {
                $this->dieUsage(
                    'The revision ' . $params['revid'] . " can't be patrolled as it's too old",
                    'notpatrollable'
                );
            }
        }

        $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'
            ),
            'revid' => array(
                ApiBase::PARAM_TYPE => 'integer'
            ),
        );
    }

    public function getParamDescription() {
        return array(
            'token' => 'Patrol token obtained from list=recentchanges',
            'rcid' => 'Recentchanges ID to patrol',
            'revid' => 'Revision 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(),
            parent::getRequireOnlyOneParameterErrorMessages( array( 'rcid', 'revid' ) ),
            array(
                array( 'nosuchrcid', 'rcid' ),
                array( 'nosuchrevid', 'revid' ),
                array(
                    'code' => 'notpatrollable',
                    'info' => "The revision can't be patrolled as it's too old"
                )
        ) );
    }

    public function needsToken() {
        return true;
    }

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

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

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