ApiWatch.php

Go to the documentation of this file.

<?php
class ApiWatch extends ApiBase {

        public function __construct( $main, $action ) {
                parent::__construct( $main, $action );
        }

        public function execute() {
                $user = $this->getUser();
                if ( !$user->isLoggedIn() ) {
                        $this->dieUsage( 'You must be logged-in to have a watchlist', 'notloggedin' );
                }

                $params = $this->extractRequestParams();
                $title = Title::newFromText( $params['title'] );

                if ( !$title || $title->getNamespace() < 0 ) {
                        $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
                }

                $res = array( 'title' => $title->getPrefixedText() );

                if ( $params['unwatch'] ) {
                        $res['unwatched'] = '';
                        $res['message'] = $this->msg( 'removedwatchtext', $title->getPrefixedText() )->title( $title )->parseAsBlock();
                        $success = UnwatchAction::doUnwatch( $title, $user );
                } else {
                        $res['watched'] = '';
                        $res['message'] = $this->msg( 'addedwatchtext', $title->getPrefixedText() )->title( $title )->parseAsBlock();
                        $success = WatchAction::doWatch( $title, $user );
                }
                if ( !$success ) {
                        $this->dieUsageMsg( 'hookaborted' );
                }
                $this->getResult()->addValue( null, $this->getModuleName(), $res );
        }

        public function mustBePosted() {
                return true;
        }

        public function isWriteMode() {
                return true;
        }

        public function needsToken() {
                return true;
        }

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

        public function getAllowedParams() {
                return array(
                        'title' => array(
                                ApiBase::PARAM_TYPE => 'string',
                                ApiBase::PARAM_REQUIRED => true
                        ),
                        'unwatch' => false,
                        'token' => array(
                                ApiBase::PARAM_TYPE => 'string',
                                ApiBase::PARAM_REQUIRED => true
                        ),
                );
        }

        public function getParamDescription() {
                return array(
                        'title' => 'The page to (un)watch',
                        'unwatch' => 'If set the page will be unwatched rather than watched',
                        'token' => 'A token previously acquired via prop=info',
                );
        }

        public function getResultProperties() {
                return array(
                        '' => array(
                                'title' => 'string',
                                'unwatched' => 'boolean',
                                'watched' => 'boolean',
                                'message' => 'string'
                        )
                );
        }

        public function getDescription() {
                return 'Add or remove a page from/to the current user\'s watchlist';
        }

        public function getPossibleErrors() {
                return array_merge( parent::getPossibleErrors(), array(
                        array( 'code' => 'notloggedin', 'info' => 'You must be logged-in to have a watchlist' ),
                        array( 'invalidtitle', 'title' ),
                        array( 'hookaborted' ),
                ) );
        }

        public function getExamples() {
                return array(
                        'api.php?action=watch&title=Main_Page' => 'Watch the page "Main Page"',
                        'api.php?action=watch&title=Main_Page&unwatch=' => 'Unwatch the page "Main Page"',
                );
        }

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

        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }
}