summaryrefslogtreecommitdiff
path: root/includes/api/ApiWatch.php
diff options
context:
space:
mode:
Diffstat (limited to 'includes/api/ApiWatch.php')
-rw-r--r--includes/api/ApiWatch.php99
1 files changed, 99 insertions, 0 deletions
diff --git a/includes/api/ApiWatch.php b/includes/api/ApiWatch.php
new file mode 100644
index 00000000..ab122fea
--- /dev/null
+++ b/includes/api/ApiWatch.php
@@ -0,0 +1,99 @@
+<?php
+
+/*
+ * Created on Jan 4, 2008
+ *
+ * API for MediaWiki 1.8+
+ *
+ * Copyright (C) 2008 Yuri Astrakhan <Firstname><Lastname>@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.,
+ * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ */
+
+if (!defined('MEDIAWIKI')) {
+ // Eclipse helper - will be ignored in production
+ require_once ('ApiBase.php');
+}
+
+/**
+ * API module to allow users to log out of the wiki. API equivalent of
+ * Special:Userlogout.
+ *
+ * @ingroup API
+ */
+class ApiWatch extends ApiBase {
+
+ public function __construct($main, $action) {
+ parent :: __construct($main, $action);
+ }
+
+ public function execute() {
+ global $wgUser;
+ $this->getMain()->requestWriteMode();
+ if(!$wgUser->isLoggedIn())
+ $this->dieUsage('You must be logged-in to have a watchlist', 'notloggedin');
+ $params = $this->extractRequestParams();
+ $title = Title::newFromText($params['title']);
+ if(!$title)
+ $this->dieUsageMsg(array('invalidtitle', $params['title']));
+ $article = new Article($title);
+ $res = array('title' => $title->getPrefixedText());
+ if($params['unwatch'])
+ {
+ $res['unwatched'] = '';
+ $success = $article->doUnwatch();
+ }
+ else
+ {
+ $res['watched'] = '';
+ $success = $article->doWatch();
+ }
+ if(!$success)
+ $this->dieUsageMsg(array('hookaborted'));
+ $this->getResult()->addValue(null, $this->getModuleName(), $res);
+ }
+
+ public function getAllowedParams() {
+ return array (
+ 'title' => null,
+ 'unwatch' => false,
+ );
+ }
+
+ public function getParamDescription() {
+ return array (
+ 'title' => 'The page to (un)watch',
+ 'unwatch' => 'If set the page will be unwatched rather than watched',
+ );
+ }
+
+ public function getDescription() {
+ return array (
+ 'Add or remove a page from/to the current user\'s watchlist'
+ );
+ }
+
+ protected function getExamples() {
+ return array(
+ 'api.php?action=watch&title=Main_Page',
+ 'api.php?action=watch&title=Main_Page&unwatch',
+ );
+ }
+
+ public function getVersion() {
+ return __CLASS__ . ': $Id: ApiWatch.php 40460 2008-09-04 22:20:32Z ialex $';
+ }
+}