Merge pull request #21719 from owncloud/move-notification-api-to-ocp

Move the notification API to public namespace

11 files changed, 75 insertions, 81 deletions

diff --git a/lib/private/appframework/dependencyinjection/dicontainer.php b/lib/private/appframework/dependencyinjection/dicontainer.php
index a9614262603..175d6c747e4 100644
--- a/lib/private/appframework/dependencyinjection/dicontainer.php
+++ b/lib/private/appframework/dependencyinjection/dicontainer.php
@@ -174,6 +174,10 @@ class DIContainer extends SimpleContainer implements IAppContainer {
 			return $this->getServer()->getNavigationManager();
 		});
 
+		$this->registerService('OCP\\Notification\IManager', function($c) {
+			return $this->getServer()->getNotificationManager();
+		});
+
 		$this->registerService('OCP\\IPreview', function($c) {
 			return $this->getServer()->getPreviewManager();
 		});
diff --git a/lib/private/notification/action.php b/lib/private/notification/action.php
index 1730756c1de..deac6807653 100644
--- a/lib/private/notification/action.php
+++ b/lib/private/notification/action.php
@@ -22,6 +22,8 @@
 namespace OC\Notification;
 
 
+use OCP\Notification\IAction;
+
 class Action implements IAction {
 
 	/** @var string */
diff --git a/lib/private/notification/manager.php b/lib/private/notification/manager.php
index 239b5bfe5c7..a14a1deec0c 100644
--- a/lib/private/notification/manager.php
+++ b/lib/private/notification/manager.php
@@ -22,6 +22,11 @@
 namespace OC\Notification;
 
 
+use OCP\Notification\IApp;
+use OCP\Notification\IManager;
+use OCP\Notification\INotification;
+use OCP\Notification\INotifier;
+
 class Manager implements IManager {
 	/** @var IApp */
 	protected $apps;
diff --git a/lib/private/notification/notification.php b/lib/private/notification/notification.php
index 677658eb3e8..6568f53f255 100644
--- a/lib/private/notification/notification.php
+++ b/lib/private/notification/notification.php
@@ -22,6 +22,9 @@
 namespace OC\Notification;
 
 
+use OCP\Notification\IAction;
+use OCP\Notification\INotification;
+
 class Notification implements INotification {
 	/** @var string */
 	protected $app;
diff --git a/lib/private/server.php b/lib/private/server.php
index 2497c056600..6e9c5ca0c68 100644
--- a/lib/private/server.php
+++ b/lib/private/server.php
@@ -1176,7 +1176,7 @@ class Server extends ServerContainer implements IServerContainer {
 	/**
 	 * Get the Notification Manager
 	 *
-	 * @return \OC\Notification\IManager
+	 * @return \OCP\Notification\IManager
 	 * @since 8.2.0
 	 */
 	public function getNotificationManager() {
diff --git a/lib/public/iservercontainer.php b/lib/public/iservercontainer.php
index 82084f021e8..e21c9fb8e4b 100644
--- a/lib/public/iservercontainer.php
+++ b/lib/public/iservercontainer.php
@@ -476,8 +476,8 @@ interface IServerContainer {
 	/**
 	 * Get the Notification Manager
 	 *
-	 * @return \OC\Notification\IManager
-	 * @since 8.2.0
+	 * @return \OCP\Notification\IManager
+	 * @since 9.0.0
 	 */
 	public function getNotificationManager();
 
diff --git a/lib/private/notification/iaction.php b/lib/public/notification/iaction.php
index 79e28ecef89..1f4d1d5b7fe 100644
--- a/lib/private/notification/iaction.php
+++ b/lib/public/notification/iaction.php
@@ -19,30 +19,26 @@
  *
  */
 
-namespace OC\Notification;
+namespace OCP\Notification;
 
 /**
  * Interface IAction
  *
- * @package OC\Notification
- * @since 8.2.0
- *
- * DEVELOPER NOTE:
- * The notification api is experimental only in 8.2.0! Do not start using it,
- * if you can not prepare an update for the next version afterwards.
+ * @package OCP\Notification
+ * @since 9.0.0
  */
 interface IAction {
 	/**
 	 * @param string $label
 	 * @return $this
 	 * @throws \InvalidArgumentException if the label is invalid
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function setLabel($label);
 
 	/**
 	 * @return string
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function getLabel();
 
@@ -50,13 +46,13 @@ interface IAction {
 	 * @param string $label
 	 * @return $this
 	 * @throws \InvalidArgumentException if the label is invalid
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function setParsedLabel($label);
 
 	/**
 	 * @return string
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function getParsedLabel();
 
@@ -79,31 +75,31 @@ interface IAction {
 	 * @param string $requestType
 	 * @return $this
 	 * @throws \InvalidArgumentException if the link is invalid
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function setLink($link, $requestType);
 
 	/**
 	 * @return string
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function getLink();
 
 	/**
 	 * @return string
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function getRequestType();
 
 	/**
 	 * @return bool
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function isValid();
 
 	/**
 	 * @return bool
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function isValidParsed();
 }
diff --git a/lib/private/notification/iapp.php b/lib/public/notification/iapp.php
index 8ae4f6a5437..98da265559b 100644
--- a/lib/private/notification/iapp.php
+++ b/lib/public/notification/iapp.php
@@ -19,38 +19,34 @@
  *
  */
 
-namespace OC\Notification;
+namespace OCP\Notification;
 
 /**
  * Interface IApp
  *
- * @package OC\Notification
- * @since 8.2.0
- *
- * DEVELOPER NOTE:
- * The notification api is experimental only in 8.2.0! Do not start using it,
- * if you can not prepare an update for the next version afterwards.
+ * @package OCP\Notification
+ * @since 9.0.0
  */
 interface IApp {
 	/**
 	 * @param INotification $notification
 	 * @return null
 	 * @throws \InvalidArgumentException When the notification is not valid
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function notify(INotification $notification);
 
 	/**
 	 * @param INotification $notification
 	 * @return null
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function markProcessed(INotification $notification);
 
 	/**
 	 * @param INotification $notification
 	 * @return int
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function getCount(INotification $notification);
 }
diff --git a/lib/private/notification/imanager.php b/lib/public/notification/imanager.php
index 2f8e3ba39fc..a18af747b10 100644
--- a/lib/private/notification/imanager.php
+++ b/lib/public/notification/imanager.php
@@ -19,24 +19,20 @@
  *
  */
 
-namespace OC\Notification;
+namespace OCP\Notification;
 
 /**
  * Interface IManager
  *
- * @package OC\Notification
- * @since 8.2.0
- *
- * DEVELOPER NOTE:
- * The notification api is experimental only in 8.2.0! Do not start using it,
- * if you can not prepare an update for the next version afterwards.
+ * @package OCP\Notification
+ * @since 9.0.0
  */
 interface IManager extends IApp, INotifier {
 	/**
 	 * @param \Closure $service The service must implement IApp, otherwise a
 	 *                          \InvalidArgumentException is thrown later
 	 * @return null
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function registerApp(\Closure $service);
 
@@ -46,7 +42,7 @@ interface IManager extends IApp, INotifier {
 	 * @param \Closure $info    An array with the keys 'id' and 'name' containing
 	 *                          the app id and the app name
 	 * @return null
-	 * @since 8.2.0 - Parameter $info was added in 9.0.0
+	 * @since 9.0.0
 	 */
 	public function registerNotifier(\Closure $service, \Closure $info);
 
@@ -58,13 +54,13 @@ interface IManager extends IApp, INotifier {
 
 	/**
 	 * @return INotification
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function createNotification();
 
 	/**
 	 * @return bool
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function hasNotifiers();
 }
diff --git a/lib/private/notification/inotification.php b/lib/public/notification/inotification.php
index 921f0779b92..2d8557ec64d 100644
--- a/lib/private/notification/inotification.php
+++ b/lib/public/notification/inotification.php
@@ -19,30 +19,26 @@
  *
  */
 
-namespace OC\Notification;
+namespace OCP\Notification;
 
 /**
  * Interface INotification
  *
- * @package OC\Notification
- * @since 8.2.0
- *
- * DEVELOPER NOTE:
- * The notification api is experimental only in 8.2.0! Do not start using it,
- * if you can not prepare an update for the next version afterwards.
+ * @package OCP\Notification
+ * @since 9.0.0
  */
 interface INotification {
 	/**
 	 * @param string $app
 	 * @return $this
 	 * @throws \InvalidArgumentException if the app id are invalid
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function setApp($app);
 
 	/**
 	 * @return string
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function getApp();
 
@@ -50,13 +46,13 @@ interface INotification {
 	 * @param string $user
 	 * @return $this
 	 * @throws \InvalidArgumentException if the user id are invalid
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function setUser($user);
 
 	/**
 	 * @return string
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function getUser();
 
@@ -79,19 +75,19 @@ interface INotification {
 	 * @param string $id
 	 * @return $this
 	 * @throws \InvalidArgumentException if the object type or id is invalid
-	 * @since 8.2.0 - 9.0.0: Type of $id changed to string
+	 * @since 9.0.0
 	 */
 	public function setObject($type, $id);
 
 	/**
 	 * @return string
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function getObjectType();
 
 	/**
 	 * @return string
-	 * @since 8.2.0 - 9.0.0: Return type changed to string
+	 * @since 9.0.0
 	 */
 	public function getObjectId();
 
@@ -100,19 +96,19 @@ interface INotification {
 	 * @param array $parameters
 	 * @return $this
 	 * @throws \InvalidArgumentException if the subject or parameters are invalid
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function setSubject($subject, array $parameters = []);
 
 	/**
 	 * @return string
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function getSubject();
 
 	/**
 	 * @return string[]
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function getSubjectParameters();
 
@@ -120,13 +116,13 @@ interface INotification {
 	 * @param string $subject
 	 * @return $this
 	 * @throws \InvalidArgumentException if the subject are invalid
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function setParsedSubject($subject);
 
 	/**
 	 * @return string
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function getParsedSubject();
 
@@ -135,19 +131,19 @@ interface INotification {
 	 * @param array $parameters
 	 * @return $this
 	 * @throws \InvalidArgumentException if the message or parameters are invalid
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function setMessage($message, array $parameters = []);
 
 	/**
 	 * @return string
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function getMessage();
 
 	/**
 	 * @return string[]
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function getMessageParameters();
 
@@ -155,13 +151,13 @@ interface INotification {
 	 * @param string $message
 	 * @return $this
 	 * @throws \InvalidArgumentException if the message are invalid
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function setParsedMessage($message);
 
 	/**
 	 * @return string
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function getParsedMessage();
 
@@ -169,19 +165,19 @@ interface INotification {
 	 * @param string $link
 	 * @return $this
 	 * @throws \InvalidArgumentException if the link are invalid
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function setLink($link);
 
 	/**
 	 * @return string
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function getLink();
 
 	/**
 	 * @return IAction
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function createAction();
 
@@ -189,13 +185,13 @@ interface INotification {
 	 * @param IAction $action
 	 * @return $this
 	 * @throws \InvalidArgumentException if the action are invalid
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function addAction(IAction $action);
 
 	/**
 	 * @return IAction[]
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function getActions();
 
@@ -203,25 +199,25 @@ interface INotification {
 	 * @param IAction $action
 	 * @return $this
 	 * @throws \InvalidArgumentException if the action are invalid
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function addParsedAction(IAction $action);
 
 	/**
 	 * @return IAction[]
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function getParsedActions();
 
 	/**
 	 * @return bool
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function isValid();
 
 	/**
 	 * @return bool
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function isValidParsed();
 }
diff --git a/lib/private/notification/inotifier.php b/lib/public/notification/inotifier.php
index c4312308fc0..0d9cecc88b8 100644
--- a/lib/private/notification/inotifier.php
+++ b/lib/public/notification/inotifier.php
@@ -19,17 +19,13 @@
  *
  */
 
-namespace OC\Notification;
+namespace OCP\Notification;
 
 /**
  * Interface INotifier
  *
- * @package OC\Notification
- * @since 8.2.0
- *
- * DEVELOPER NOTE:
- * The notification api is experimental only in 8.2.0! Do not start using it,
- * if you can not prepare an update for the next version afterwards.
+ * @package OCP\Notification
+ * @since 9.0.0
  */
 interface INotifier {
 	/**
@@ -37,7 +33,7 @@ interface INotifier {
 	 * @param string $languageCode The code of the language that should be used to prepare the notification
 	 * @return INotification
 	 * @throws \InvalidArgumentException When the notification was not prepared by a notifier
-	 * @since 8.2.0
+	 * @since 9.0.0
 	 */
 	public function prepare(INotification $notification, $languageCode);
 }