diff options
author | Joas Schilling <nickvergessen@owncloud.com> | 2015-09-08 08:57:29 +0200 |
---|---|---|
committer | Joas Schilling <nickvergessen@owncloud.com> | 2015-09-08 09:01:02 +0200 |
commit | 38001d824b142ca9c47f2afafce91ab8b76f1a9a (patch) | |
tree | f1abdf50c42874a1ef847ead0fe9d89c2446451f /lib/public | |
parent | 59f37a8dfbc27242bb0ad50731f8ae20b1ad938c (diff) | |
download | nextcloud-server-38001d824b142ca9c47f2afafce91ab8b76f1a9a.tar.gz nextcloud-server-38001d824b142ca9c47f2afafce91ab8b76f1a9a.zip |
Move interfaces to private until they are no longer experimental
Diffstat (limited to 'lib/public')
-rw-r--r-- | lib/public/iservercontainer.php | 2 | ||||
-rw-r--r-- | lib/public/notification/iaction.php | 109 | ||||
-rw-r--r-- | lib/public/notification/iapp.php | 56 | ||||
-rw-r--r-- | lib/public/notification/imanager.php | 56 | ||||
-rw-r--r-- | lib/public/notification/inotification.php | 241 | ||||
-rw-r--r-- | lib/public/notification/inotifier.php | 43 |
6 files changed, 1 insertions, 506 deletions
diff --git a/lib/public/iservercontainer.php b/lib/public/iservercontainer.php index ea08b5a78ca..8be23dff214 100644 --- a/lib/public/iservercontainer.php +++ b/lib/public/iservercontainer.php @@ -459,7 +459,7 @@ interface IServerContainer { /** * Get the Notification Manager * - * @return \OCP\Notification\IManager + * @return \OC\Notification\IManager * @since 8.2.0 */ public function getNotificationManager(); diff --git a/lib/public/notification/iaction.php b/lib/public/notification/iaction.php deleted file mode 100644 index 8db1eaa6543..00000000000 --- a/lib/public/notification/iaction.php +++ /dev/null @@ -1,109 +0,0 @@ -<?php -/** - * @author Joas Schilling <nickvergessen@owncloud.com> - * - * @copyright Copyright (c) 2015, 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\Notification; - -/** - * Interface IAction - * - * @package OCP\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. - */ -interface IAction { - /** - * @param string $label - * @return $this - * @throws \InvalidArgumentException if the label is invalid - * @since 8.2.0 - */ - public function setLabel($label); - - /** - * @return string - * @since 8.2.0 - */ - public function getLabel(); - - /** - * @param string $label - * @return $this - * @throws \InvalidArgumentException if the label is invalid - * @since 8.2.0 - */ - public function setParsedLabel($label); - - /** - * @return string - * @since 8.2.0 - */ - public function getParsedLabel(); - - /** - * @param string $link - * @param string $requestType - * @return $this - * @throws \InvalidArgumentException if the link is invalid - * @since 8.2.0 - */ - public function setLink($link, $requestType); - - /** - * @return string - * @since 8.2.0 - */ - public function getLink(); - - /** - * @return string - * @since 8.2.0 - */ - public function getRequestType(); - - /** - * @param string $icon - * @return $this - * @throws \InvalidArgumentException if the icon is invalid - * @since 8.2.0 - */ - public function setIcon($icon); - - /** - * @return string - * @since 8.2.0 - */ - public function getIcon(); - - /** - * @return bool - * @since 8.2.0 - */ - public function isValid(); - - /** - * @return bool - * @since 8.2.0 - */ - public function isValidParsed(); -} diff --git a/lib/public/notification/iapp.php b/lib/public/notification/iapp.php deleted file mode 100644 index a4718a21b60..00000000000 --- a/lib/public/notification/iapp.php +++ /dev/null @@ -1,56 +0,0 @@ -<?php -/** - * @author Joas Schilling <nickvergessen@owncloud.com> - * - * @copyright Copyright (c) 2015, 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\Notification; - -/** - * Interface IApp - * - * @package OCP\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. - */ -interface IApp { - /** - * @param INotification $notification - * @return null - * @throws \InvalidArgumentException When the notification is not valid - * @since 8.2.0 - */ - public function notify(INotification $notification); - - /** - * @param INotification $notification - * @return null - * @since 8.2.0 - */ - public function markProcessed(INotification $notification); - - /** - * @param INotification $notification - * @return int - * @since 8.2.0 - */ - public function getCount(INotification $notification); -} diff --git a/lib/public/notification/imanager.php b/lib/public/notification/imanager.php deleted file mode 100644 index ca1cc968b12..00000000000 --- a/lib/public/notification/imanager.php +++ /dev/null @@ -1,56 +0,0 @@ -<?php -/** - * @author Joas Schilling <nickvergessen@owncloud.com> - * - * @copyright Copyright (c) 2015, 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\Notification; - -/** - * Interface IManager - * - * @package OCP\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. - */ -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 - */ - public function registerApp(\Closure $service); - - /** - * @param \Closure $service The service must implement INotifier, otherwise a - * \InvalidArgumentException is thrown later - * @return null - * @since 8.2.0 - */ - public function registerNotifier(\Closure $service); - - /** - * @return INotification - * @since 8.2.0 - */ - public function createNotification(); -} diff --git a/lib/public/notification/inotification.php b/lib/public/notification/inotification.php deleted file mode 100644 index 51d4a804647..00000000000 --- a/lib/public/notification/inotification.php +++ /dev/null @@ -1,241 +0,0 @@ -<?php -/** - * @author Joas Schilling <nickvergessen@owncloud.com> - * - * @copyright Copyright (c) 2015, 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\Notification; - -/** - * Interface INotification - * - * @package OCP\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. - */ -interface INotification { - /** - * @param string $app - * @return $this - * @throws \InvalidArgumentException if the app id are invalid - * @since 8.2.0 - */ - public function setApp($app); - - /** - * @return string - * @since 8.2.0 - */ - public function getApp(); - - /** - * @param string $user - * @return $this - * @throws \InvalidArgumentException if the user id are invalid - * @since 8.2.0 - */ - public function setUser($user); - - /** - * @return string - * @since 8.2.0 - */ - public function getUser(); - - /** - * @param int $timestamp - * @return $this - * @throws \InvalidArgumentException if the timestamp are invalid - * @since 8.2.0 - */ - public function setTimestamp($timestamp); - - /** - * @return int - * @since 8.2.0 - */ - public function getTimestamp(); - - /** - * @param string $type - * @param int $id - * @return $this - * @throws \InvalidArgumentException if the object type or id are invalid - * @since 8.2.0 - */ - public function setObject($type, $id); - - /** - * @return string - * @since 8.2.0 - */ - public function getObjectType(); - - /** - * @return int - * @since 8.2.0 - */ - public function getObjectId(); - - /** - * @param string $subject - * @param array $parameters - * @return $this - * @throws \InvalidArgumentException if the subject or parameters are invalid - * @since 8.2.0 - */ - public function setSubject($subject, array $parameters = []); - - /** - * @return string - * @since 8.2.0 - */ - public function getSubject(); - - /** - * @return string[] - * @since 8.2.0 - */ - public function getSubjectParameters(); - - /** - * @param string $subject - * @return $this - * @throws \InvalidArgumentException if the subject are invalid - * @since 8.2.0 - */ - public function setParsedSubject($subject); - - /** - * @return string - * @since 8.2.0 - */ - public function getParsedSubject(); - - /** - * @param string $message - * @param array $parameters - * @return $this - * @throws \InvalidArgumentException if the message or parameters are invalid - * @since 8.2.0 - */ - public function setMessage($message, array $parameters = []); - - /** - * @return string - * @since 8.2.0 - */ - public function getMessage(); - - /** - * @return string[] - * @since 8.2.0 - */ - public function getMessageParameters(); - - /** - * @param string $message - * @return $this - * @throws \InvalidArgumentException if the message are invalid - * @since 8.2.0 - */ - public function setParsedMessage($message); - - /** - * @return string - * @since 8.2.0 - */ - public function getParsedMessage(); - - /** - * @param string $link - * @return $this - * @throws \InvalidArgumentException if the link are invalid - * @since 8.2.0 - */ - public function setLink($link); - - /** - * @return string - * @since 8.2.0 - */ - public function getLink(); - - /** - * @param string $icon - * @return $this - * @throws \InvalidArgumentException if the icon are invalid - * @since 8.2.0 - */ - public function setIcon($icon); - - /** - * @return string - * @since 8.2.0 - */ - public function getIcon(); - - /** - * @return IAction - * @since 8.2.0 - */ - public function createAction(); - - /** - * @param IAction $action - * @return $this - * @throws \InvalidArgumentException if the action are invalid - * @since 8.2.0 - */ - public function addAction(IAction $action); - - /** - * @return IAction[] - * @since 8.2.0 - */ - public function getActions(); - - /** - * @param IAction $action - * @return $this - * @throws \InvalidArgumentException if the action are invalid - * @since 8.2.0 - */ - public function addParsedAction(IAction $action); - - /** - * @return IAction[] - * @since 8.2.0 - */ - public function getParsedActions(); - - /** - * @return bool - * @since 8.2.0 - */ - public function isValid(); - - /** - * @return bool - * @since 8.2.0 - */ - public function isValidParsed(); -} diff --git a/lib/public/notification/inotifier.php b/lib/public/notification/inotifier.php deleted file mode 100644 index 9eefcddae18..00000000000 --- a/lib/public/notification/inotifier.php +++ /dev/null @@ -1,43 +0,0 @@ -<?php -/** - * @author Joas Schilling <nickvergessen@owncloud.com> - * - * @copyright Copyright (c) 2015, 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\Notification; - -/** - * Interface INotifier - * - * @package OCP\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. - */ -interface INotifier { - /** - * @param INotification $notification - * @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 - */ - public function prepare(INotification $notification, $languageCode); -} |