mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Adjust the since on the interface

This commit is contained in:
Joas Schilling 2016-01-22 10:51:36 +01:00
parent ee02165005
commit 9ea7ae6f87
5 changed files with 48 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
lib/public/notification/iaction.php
View File

@ -25,20 +25,20 @@ namespace OCP\Notification;
* Interface IAction * Interface IAction
* *
* @package OCP\Notification * @package OCP\Notification
* @since 8.2.0 * @since 9.0.0
*/ */
interface IAction { interface IAction {
/** /**
* @param string $label * @param string $label
* @return $this * @return $this
* @throws \InvalidArgumentException if the label is invalid * @throws \InvalidArgumentException if the label is invalid
* @since 8.2.0 * @since 9.0.0
*/ */
public function setLabel($label); public function setLabel($label);
/** /**
* @return string * @return string
* @since 8.2.0 * @since 9.0.0
*/ */
public function getLabel(); public function getLabel();
@ -46,13 +46,13 @@ interface IAction {
* @param string $label * @param string $label
* @return $this * @return $this
* @throws \InvalidArgumentException if the label is invalid * @throws \InvalidArgumentException if the label is invalid
* @since 8.2.0 * @since 9.0.0
*/ */
public function setParsedLabel($label); public function setParsedLabel($label);
/** /**
* @return string * @return string
* @since 8.2.0 * @since 9.0.0
*/ */
public function getParsedLabel(); public function getParsedLabel();
@ -75,31 +75,31 @@ interface IAction {
* @param string $requestType * @param string $requestType
* @return $this * @return $this
* @throws \InvalidArgumentException if the link is invalid * @throws \InvalidArgumentException if the link is invalid
* @since 8.2.0 * @since 9.0.0
*/ */
public function setLink($link, $requestType); public function setLink($link, $requestType);
/** /**
* @return string * @return string
* @since 8.2.0 * @since 9.0.0
*/ */
public function getLink(); public function getLink();
/** /**
* @return string * @return string
* @since 8.2.0 * @since 9.0.0
*/ */
public function getRequestType(); public function getRequestType();
/** /**
* @return bool * @return bool
* @since 8.2.0 * @since 9.0.0
*/ */
public function isValid(); public function isValid();
/** /**
* @return bool * @return bool
* @since 8.2.0 * @since 9.0.0
*/ */
public function isValidParsed(); public function isValidParsed();
} }

8
lib/public/notification/iapp.php
View File

@ -25,28 +25,28 @@ namespace OCP\Notification;
* Interface IApp * Interface IApp
* *
* @package OCP\Notification * @package OCP\Notification
* @since 8.2.0 * @since 9.0.0
*/ */
interface IApp { interface IApp {
/** /**
* @param INotification $notification * @param INotification $notification
* @return null * @return null
* @throws \InvalidArgumentException When the notification is not valid * @throws \InvalidArgumentException When the notification is not valid
* @since 8.2.0 * @since 9.0.0
*/ */
public function notify(INotification $notification); public function notify(INotification $notification);
/** /**
* @param INotification $notification * @param INotification $notification
* @return null * @return null
* @since 8.2.0 * @since 9.0.0
*/ */
public function markProcessed(INotification $notification); public function markProcessed(INotification $notification);
/** /**
* @param INotification $notification * @param INotification $notification
* @return int * @return int
* @since 8.2.0 * @since 9.0.0
*/ */
public function getCount(INotification $notification); public function getCount(INotification $notification);
} }

10
lib/public/notification/imanager.php
View File

@ -25,14 +25,14 @@ namespace OCP\Notification;
* Interface IManager * Interface IManager
* *
* @package OCP\Notification * @package OCP\Notification
* @since 8.2.0 * @since 9.0.0
*/ */
interface IManager extends IApp, INotifier { interface IManager extends IApp, INotifier {
/** /**
* @param \Closure $service The service must implement IApp, otherwise a * @param \Closure $service The service must implement IApp, otherwise a
* \InvalidArgumentException is thrown later * \InvalidArgumentException is thrown later
* @return null * @return null
* @since 8.2.0 * @since 9.0.0
*/ */
public function registerApp(\Closure $service); public function registerApp(\Closure $service);
@ -42,7 +42,7 @@ interface IManager extends IApp, INotifier {
* @param \Closure $info An array with the keys 'id' and 'name' containing * @param \Closure $info An array with the keys 'id' and 'name' containing
* the app id and the app name * the app id and the app name
* @return null * @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); public function registerNotifier(\Closure $service, \Closure $info);
@ -54,13 +54,13 @@ interface IManager extends IApp, INotifier {
/** /**
* @return INotification * @return INotification
* @since 8.2.0 * @since 9.0.0
*/ */
public function createNotification(); public function createNotification();
/** /**
* @return bool * @return bool
* @since 8.2.0 * @since 9.0.0
*/ */
public function hasNotifiers(); public function hasNotifiers();
} }

54
lib/public/notification/inotification.php
View File

@ -25,20 +25,20 @@ namespace OCP\Notification;
* Interface INotification * Interface INotification
* *
* @package OCP\Notification * @package OCP\Notification
* @since 8.2.0 * @since 9.0.0
*/ */
interface INotification { interface INotification {
/** /**
* @param string $app * @param string $app
* @return $this * @return $this
* @throws \InvalidArgumentException if the app id are invalid * @throws \InvalidArgumentException if the app id are invalid
* @since 8.2.0 * @since 9.0.0
*/ */
public function setApp($app); public function setApp($app);
/** /**
* @return string * @return string
* @since 8.2.0 * @since 9.0.0
*/ */
public function getApp(); public function getApp();
@ -46,13 +46,13 @@ interface INotification {
* @param string $user * @param string $user
* @return $this * @return $this
* @throws \InvalidArgumentException if the user id are invalid * @throws \InvalidArgumentException if the user id are invalid
* @since 8.2.0 * @since 9.0.0
*/ */
public function setUser($user); public function setUser($user);
/** /**
* @return string * @return string
* @since 8.2.0 * @since 9.0.0
*/ */
public function getUser(); public function getUser();
@ -75,19 +75,19 @@ interface INotification {
* @param string $id * @param string $id
* @return $this * @return $this
* @throws \InvalidArgumentException if the object type or id is invalid * @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); public function setObject($type, $id);
/** /**
* @return string * @return string
* @since 8.2.0 * @since 9.0.0
*/ */
public function getObjectType(); public function getObjectType();
/** /**
* @return string * @return string
* @since 8.2.0 - 9.0.0: Return type changed to string * @since 9.0.0
*/ */
public function getObjectId(); public function getObjectId();
@ -96,19 +96,19 @@ interface INotification {
* @param array $parameters * @param array $parameters
* @return $this * @return $this
* @throws \InvalidArgumentException if the subject or parameters are invalid * @throws \InvalidArgumentException if the subject or parameters are invalid
* @since 8.2.0 * @since 9.0.0
*/ */
public function setSubject($subject, array $parameters = []); public function setSubject($subject, array $parameters = []);
/** /**
* @return string * @return string
* @since 8.2.0 * @since 9.0.0
*/ */
public function getSubject(); public function getSubject();
/** /**
* @return string[] * @return string[]
* @since 8.2.0 * @since 9.0.0
*/ */
public function getSubjectParameters(); public function getSubjectParameters();
@ -116,13 +116,13 @@ interface INotification {
* @param string $subject * @param string $subject
* @return $this * @return $this
* @throws \InvalidArgumentException if the subject are invalid * @throws \InvalidArgumentException if the subject are invalid
* @since 8.2.0 * @since 9.0.0
*/ */
public function setParsedSubject($subject); public function setParsedSubject($subject);
/** /**
* @return string * @return string
* @since 8.2.0 * @since 9.0.0
*/ */
public function getParsedSubject(); public function getParsedSubject();
@ -131,19 +131,19 @@ interface INotification {
* @param array $parameters * @param array $parameters
* @return $this * @return $this
* @throws \InvalidArgumentException if the message or parameters are invalid * @throws \InvalidArgumentException if the message or parameters are invalid
* @since 8.2.0 * @since 9.0.0
*/ */
public function setMessage($message, array $parameters = []); public function setMessage($message, array $parameters = []);
/** /**
* @return string * @return string
* @since 8.2.0 * @since 9.0.0
*/ */
public function getMessage(); public function getMessage();
/** /**
* @return string[] * @return string[]
* @since 8.2.0 * @since 9.0.0
*/ */
public function getMessageParameters(); public function getMessageParameters();
@ -151,13 +151,13 @@ interface INotification {
* @param string $message * @param string $message
* @return $this * @return $this
* @throws \InvalidArgumentException if the message are invalid * @throws \InvalidArgumentException if the message are invalid
* @since 8.2.0 * @since 9.0.0
*/ */
public function setParsedMessage($message); public function setParsedMessage($message);
/** /**
* @return string * @return string
* @since 8.2.0 * @since 9.0.0
*/ */
public function getParsedMessage(); public function getParsedMessage();
@ -165,19 +165,19 @@ interface INotification {
* @param string $link * @param string $link
* @return $this * @return $this
* @throws \InvalidArgumentException if the link are invalid * @throws \InvalidArgumentException if the link are invalid
* @since 8.2.0 * @since 9.0.0
*/ */
public function setLink($link); public function setLink($link);
/** /**
* @return string * @return string
* @since 8.2.0 * @since 9.0.0
*/ */
public function getLink(); public function getLink();
/** /**
* @return IAction * @return IAction
* @since 8.2.0 * @since 9.0.0
*/ */
public function createAction(); public function createAction();
@ -185,13 +185,13 @@ interface INotification {
* @param IAction $action * @param IAction $action
* @return $this * @return $this
* @throws \InvalidArgumentException if the action are invalid * @throws \InvalidArgumentException if the action are invalid
* @since 8.2.0 * @since 9.0.0
*/ */
public function addAction(IAction $action); public function addAction(IAction $action);
/** /**
* @return IAction[] * @return IAction[]
* @since 8.2.0 * @since 9.0.0
*/ */
public function getActions(); public function getActions();
@ -199,25 +199,25 @@ interface INotification {
* @param IAction $action * @param IAction $action
* @return $this * @return $this
* @throws \InvalidArgumentException if the action are invalid * @throws \InvalidArgumentException if the action are invalid
* @since 8.2.0 * @since 9.0.0
*/ */
public function addParsedAction(IAction $action); public function addParsedAction(IAction $action);
/** /**
* @return IAction[] * @return IAction[]
* @since 8.2.0 * @since 9.0.0
*/ */
public function getParsedActions(); public function getParsedActions();
/** /**
* @return bool * @return bool
* @since 8.2.0 * @since 9.0.0
*/ */
public function isValid(); public function isValid();
/** /**
* @return bool * @return bool
* @since 8.2.0 * @since 9.0.0
*/ */
public function isValidParsed(); public function isValidParsed();
} }

4
lib/public/notification/inotifier.php
View File

@ -25,7 +25,7 @@ namespace OCP\Notification;
* Interface INotifier * Interface INotifier
* *
* @package OCP\Notification * @package OCP\Notification
* @since 8.2.0 * @since 9.0.0
*/ */
interface INotifier { interface INotifier {
/** /**
@ -33,7 +33,7 @@ interface INotifier {
* @param string $languageCode The code of the language that should be used to prepare the notification * @param string $languageCode The code of the language that should be used to prepare the notification
* @return INotification * @return INotification
* @throws \InvalidArgumentException When the notification was not prepared by a notifier * @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); public function prepare(INotification $notification, $languageCode);
} }