summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'CommentStreams/includes/ApiCSWatch.php')
-rw-r--r--CommentStreams/includes/ApiCSWatch.php76
1 files changed, 76 insertions, 0 deletions
diff --git a/CommentStreams/includes/ApiCSWatch.php b/CommentStreams/includes/ApiCSWatch.php
new file mode 100644
index 00000000..a1a67072
--- /dev/null
+++ b/CommentStreams/includes/ApiCSWatch.php
@@ -0,0 +1,76 @@
+<?php
+/*
+ * Copyright (c) 2017 The MITRE Corporation
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+
+class ApiCSWatch extends ApiCSBase {
+
+ /**
+ * @param ApiMain $main main module
+ * @param string $action name of this module
+ */
+ public function __construct( $main, $action ) {
+ parent::__construct( $main, $action, true );
+ }
+
+ /**
+ * the real body of the execute function
+ *
+ * @return result of API request
+ */
+ protected function executeBody() {
+ if ( $this->getUser()->isAnon() ) {
+ $this->dieCustomUsageMessage(
+ 'commentstreams-api-error-watch-notloggedin' );
+ }
+
+ if ( !is_null( $this->comment->getParentId() ) ) {
+ $this->dieCustomUsageMessage(
+ 'commentstreams-api-error-watch-nowatchonreply' );
+ }
+
+ $result = $this->comment->watch( $this->getUser() );
+ if ( !$result ) {
+ $this->dieCustomUsageMessage( 'commentstreams-api-error-watch' );
+ }
+
+ $this->getResult()->addValue( null, $this->getModuleName(), '' );
+ }
+
+ /**
+ * @return array examples of the use of this API module
+ */
+ public function getExamplesMessages() {
+ return [
+ 'action=' . $this->getModuleName() . '&pageid=3' =>
+ 'apihelp-' . $this->getModuleName() . '-pageid-example',
+ 'action=' . $this->getModuleName() . '&title=CommentStreams:3' =>
+ 'apihelp-' . $this->getModuleName() . '-title-example'
+ ];
+ }
+
+ /**
+ * @return string indicates that this API module requires a CSRF toekn
+ */
+ public function needsToken() {
+ return 'csrf';
+ }
+}