Dispatch events when adding, updating and deleting comments

2 files changed, 71 insertions, 1 deletions

diff --git a/lib/public/comments/commentsevent.php b/lib/public/comments/commentsevent.php
new file mode 100644
index 00000000000..13110154479
--- /dev/null
+++ b/lib/public/comments/commentsevent.php
@@ -0,0 +1,70 @@
+<?php
+/**
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCP\Comments;
+
+use Symfony\Component\EventDispatcher\Event;
+
+/**
+ * Class CommentsEvent
+ *
+ * @package OCP\Comments
+ * @since 9.0.0
+ */
+class CommentsEvent extends Event {
+
+	const EVENT_ADD = 'OCP\Comments\ICommentsManager::addComment';
+	const EVENT_UPDATE = 'OCP\Comments\ICommentsManager::updateComment';
+	const EVENT_DELETE = 'OCP\Comments\ICommentsManager::deleteComment';
+
+	/** @var string */
+	protected $event;
+	/** @var IComment */
+	protected $comment;
+
+	/**
+	 * DispatcherEvent constructor.
+	 *
+	 * @param string $event
+	 * @param IComment $comment
+	 * @since 9.0.IComment
+	 */
+	public function __construct($event, IComment $comment) {
+		$this->event = $event;
+		$this->comment = $comment;
+	}
+
+	/**
+	 * @return string
+	 * @since 9.0.0
+	 */
+	public function getEvent() {
+		return $this->event;
+	}
+
+	/**
+	 * @return IComment
+	 * @since 9.0.0
+	 */
+	public function getComment() {
+		return $this->comment;
+	}
+}
diff --git a/lib/public/comments/icommentsmanager.php b/lib/public/comments/icommentsmanager.php
index 46608ca8165..0b37fde24d8 100644
--- a/lib/public/comments/icommentsmanager.php
+++ b/lib/public/comments/icommentsmanager.php
@@ -149,7 +149,7 @@ interface ICommentsManager {
 	public function delete($id);
 
 	/**
-	 * saves the comment permanently and returns it
+	 * saves the comment permanently
 	 *
 	 * if the supplied comment has an empty ID, a new entry comment will be
 	 * saved and the instance updated with the new ID.