]> source.dussan.org Git - nextcloud-server.git/commitdiff
Make all interfaces strict
authorJoas Schilling <coding@schilljs.com>
Wed, 10 Apr 2019 12:12:10 +0000 (14:12 +0200)
committerJoas Schilling <coding@schilljs.com>
Mon, 15 Jul 2019 13:12:40 +0000 (15:12 +0200)
Signed-off-by: Joas Schilling <coding@schilljs.com>
lib/private/Notification/Action.php
lib/private/Notification/Manager.php
lib/private/Notification/Notification.php
lib/public/Notification/IAction.php
lib/public/Notification/IApp.php
lib/public/Notification/IManager.php
lib/public/Notification/INotification.php
lib/public/Notification/INotifier.php

index 8dfeecb98cb5e9a0c616f8427998b5dbd469b555..f6d6a333583adb727a5bcba5fac66d5506fcc281 100644 (file)
@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 /**
  * @copyright Copyright (c) 2016, ownCloud, Inc.
  *
@@ -45,9 +46,6 @@ class Action implements IAction {
        /** @var bool */
        protected $primary;
 
-       /**
-        * Constructor
-        */
        public function __construct() {
                $this->label = '';
                $this->labelParsed = '';
@@ -62,8 +60,8 @@ class Action implements IAction {
         * @throws \InvalidArgumentException if the label is invalid
         * @since 8.2.0
         */
-       public function setLabel($label) {
-               if (!is_string($label) || $label === '' || isset($label[32])) {
+       public function setLabel(string $label): IAction {
+               if ($label === '' || isset($label[32])) {
                        throw new \InvalidArgumentException('The given label is invalid');
                }
                $this->label = $label;
@@ -74,7 +72,7 @@ class Action implements IAction {
         * @return string
         * @since 8.2.0
         */
-       public function getLabel() {
+       public function getLabel(): string {
                return $this->label;
        }
 
@@ -84,8 +82,8 @@ class Action implements IAction {
         * @throws \InvalidArgumentException if the label is invalid
         * @since 8.2.0
         */
-       public function setParsedLabel($label) {
-               if (!is_string($label) || $label === '') {
+       public function setParsedLabel(string $label): IAction {
+               if ($label === '') {
                        throw new \InvalidArgumentException('The given parsed label is invalid');
                }
                $this->labelParsed = $label;
@@ -96,21 +94,16 @@ class Action implements IAction {
         * @return string
         * @since 8.2.0
         */
-       public function getParsedLabel() {
+       public function getParsedLabel(): string {
                return $this->labelParsed;
        }
 
        /**
         * @param $primary bool
         * @return $this
-        * @throws \InvalidArgumentException if $primary is invalid
         * @since 9.0.0
         */
-       public function setPrimary($primary) {
-               if (!is_bool($primary)) {
-                       throw new \InvalidArgumentException('The given primary option is invalid');
-               }
-
+       public function setPrimary(bool $primary): IAction {
                $this->primary = $primary;
                return $this;
        }
@@ -119,7 +112,7 @@ class Action implements IAction {
         * @return bool
         * @since 9.0.0
         */
-       public function isPrimary() {
+       public function isPrimary(): bool {
                return $this->primary;
        }
 
@@ -130,11 +123,17 @@ class Action implements IAction {
         * @throws \InvalidArgumentException if the link is invalid
         * @since 8.2.0
         */
-       public function setLink($link, $requestType) {
-               if (!is_string($link) || $link === '' || isset($link[256])) {
+       public function setLink(string $link, string $requestType): IAction {
+               if ($link === '' || isset($link[256])) {
                        throw new \InvalidArgumentException('The given link is invalid');
                }
-               if (!in_array($requestType, ['GET', 'POST', 'PUT', 'DELETE'], true)) {
+               if (!in_array($requestType, [
+                       self::TYPE_GET,
+                       self::TYPE_POST,
+                       self::TYPE_PUT,
+                       self::TYPE_DELETE,
+                       self::TYPE_WEB,
+               ], true)) {
                        throw new \InvalidArgumentException('The given request type is invalid');
                }
                $this->link = $link;
@@ -146,7 +145,7 @@ class Action implements IAction {
         * @return string
         * @since 8.2.0
         */
-       public function getLink() {
+       public function getLink(): string {
                return $this->link;
        }
 
@@ -154,21 +153,21 @@ class Action implements IAction {
         * @return string
         * @since 8.2.0
         */
-       public function getRequestType() {
+       public function getRequestType(): string {
                return $this->requestType;
        }
 
        /**
         * @return bool
         */
-       public function isValid() {
+       public function isValid(): bool {
                return $this->label !== '' && $this->link !== '';
        }
 
        /**
         * @return bool
         */
-       public function isValidParsed() {
+       public function isValidParsed(): bool {
                return $this->labelParsed !== '' && $this->link !== '';
        }
 }
index 4c3f7a2453c6c9fc60ce85c0427a53a35501b87c..876a191fb9e0918b8a48f5b2f928b9e661281a84 100644 (file)
@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 /**
  * @copyright Copyright (c) 2016, ownCloud, Inc.
  *
@@ -56,11 +57,6 @@ class Manager implements IManager {
        /** @var bool */
        protected $preparingPushNotification;
 
-       /**
-        * Manager constructor.
-        *
-        * @param IValidator $validator
-        */
        public function __construct(IValidator $validator) {
                $this->validator = $validator;
                $this->apps = [];
@@ -179,7 +175,7 @@ class Manager implements IManager {
         * @param bool $preparingPushNotification
         * @since 14.0.0
         */
-       public function setPreparingPushNotification($preparingPushNotification) {
+       public function setPreparingPushNotification(bool $preparingPushNotification): void {
                $this->preparingPushNotification = $preparingPushNotification;
        }
 
@@ -196,7 +192,7 @@ class Manager implements IManager {
         * @throws \InvalidArgumentException When the notification is not valid
         * @since 8.2.0
         */
-       public function notify(INotification $notification) {
+       public function notify(INotification $notification): void {
                if (!$notification->isValid()) {
                        throw new \InvalidArgumentException('The given notification is invalid');
                }
@@ -218,7 +214,7 @@ class Manager implements IManager {
         * @throws \InvalidArgumentException When the notification was not prepared by a notifier
         * @since 8.2.0
         */
-       public function prepare(INotification $notification, $languageCode): INotification {
+       public function prepare(INotification $notification, string $languageCode): INotification {
                $notifiers = $this->getNotifiers();
 
                foreach ($notifiers as $notifier) {
@@ -243,7 +239,7 @@ class Manager implements IManager {
        /**
         * @param INotification $notification
         */
-       public function markProcessed(INotification $notification) {
+       public function markProcessed(INotification $notification): void {
                $apps = $this->getApps();
 
                foreach ($apps as $app) {
index 47f415d15d3032c065b65bd29d3e4bb665fd82dd..e64c059db2a7b5b292d374523412fd53dc2120e5 100644 (file)
@@ -1,5 +1,5 @@
 <?php
-declare (strict_types = 1);
+declare(strict_types=1);
 /**
  * @copyright Copyright (c) 2016, ownCloud, Inc.
  *
@@ -99,11 +99,6 @@ class Notification implements INotification {
        /** @var bool */
        protected $hasPrimaryParsedAction;
 
-       /**
-        * Constructor
-        *
-        * @param IValidator $richValidator
-        */
        public function __construct(IValidator $richValidator) {
                $this->richValidator = $richValidator;
                $this->app = '';
@@ -134,8 +129,8 @@ class Notification implements INotification {
         * @throws \InvalidArgumentException if the app id is invalid
         * @since 8.2.0
         */
-       public function setApp(string $app) {
-               if (trim($app) === '' || isset($app[32])) {
+       public function setApp(string $app): INotification {
+               if ($app === '' || isset($app[32])) {
                        throw new \InvalidArgumentException('The given app name is invalid');
                }
                $this->app = $app;
@@ -146,7 +141,7 @@ class Notification implements INotification {
         * @return string
         * @since 8.2.0
         */
-       public function getApp() {
+       public function getApp(): string {
                return $this->app;
        }
 
@@ -156,8 +151,8 @@ class Notification implements INotification {
         * @throws \InvalidArgumentException if the user id is invalid
         * @since 8.2.0
         */
-       public function setUser(string $user) {
-               if (trim($user) === '' || isset($user[64])) {
+       public function setUser(string $user): INotification {
+               if ($user === '' || isset($user[64])) {
                        throw new \InvalidArgumentException('The given user id is invalid');
                }
                $this->user = $user;
@@ -168,7 +163,7 @@ class Notification implements INotification {
         * @return string
         * @since 8.2.0
         */
-       public function getUser() {
+       public function getUser(): string {
                return $this->user;
        }
 
@@ -178,7 +173,7 @@ class Notification implements INotification {
         * @throws \InvalidArgumentException if the $dateTime is invalid
         * @since 9.0.0
         */
-       public function setDateTime(\DateTime $dateTime) {
+       public function setDateTime(\DateTime $dateTime): INotification {
                if ($dateTime->getTimestamp() === 0) {
                        throw new \InvalidArgumentException('The given date time is invalid');
                }
@@ -190,7 +185,7 @@ class Notification implements INotification {
         * @return \DateTime
         * @since 9.0.0
         */
-       public function getDateTime() {
+       public function getDateTime(): \DateTime {
                return $this->dateTime;
        }
 
@@ -201,13 +196,13 @@ class Notification implements INotification {
         * @throws \InvalidArgumentException if the object type or id is invalid
         * @since 8.2.0 - 9.0.0: Type of $id changed to string
         */
-       public function setObject(string $type, $id) {
-               if (trim($type) === '' || isset($type[64])) {
+       public function setObject(string $type, string $id): INotification {
+               if ($type === '' || isset($type[64])) {
                        throw new \InvalidArgumentException('The given object type is invalid');
                }
                $this->objectType = $type;
 
-               if (!is_int($id) && (!is_string($id) || $id === '' || isset($id[64]))) {
+               if ($id === '' || isset($id[64])) {
                        throw new \InvalidArgumentException('The given object id is invalid');
                }
                $this->objectId = (string) $id;
@@ -218,7 +213,7 @@ class Notification implements INotification {
         * @return string
         * @since 8.2.0
         */
-       public function getObjectType() {
+       public function getObjectType(): string {
                return $this->objectType;
        }
 
@@ -226,7 +221,7 @@ class Notification implements INotification {
         * @return string
         * @since 8.2.0 - 9.0.0: Return type changed to string
         */
-       public function getObjectId() {
+       public function getObjectId(): string {
                return $this->objectId;
        }
 
@@ -237,8 +232,8 @@ class Notification implements INotification {
         * @throws \InvalidArgumentException if the subject or parameters are invalid
         * @since 8.2.0
         */
-       public function setSubject(string $subject, array $parameters = []) {
-               if (trim($subject) === '' || isset($subject[64])) {
+       public function setSubject(string $subject, array $parameters = []): INotification {
+               if ($subject === '' || isset($subject[64])) {
                        throw new \InvalidArgumentException('The given subject is invalid');
                }
 
@@ -252,15 +247,15 @@ class Notification implements INotification {
         * @return string
         * @since 8.2.0
         */
-       public function getSubject() {
+       public function getSubject(): string {
                return $this->subject;
        }
 
        /**
-        * @return string[]
+        * @return array
         * @since 8.2.0
         */
-       public function getSubjectParameters() {
+       public function getSubjectParameters(): array {
                return $this->subjectParameters;
        }
 
@@ -270,8 +265,8 @@ class Notification implements INotification {
         * @throws \InvalidArgumentException if the subject is invalid
         * @since 8.2.0
         */
-       public function setParsedSubject(string $subject) {
-               if (trim($subject) === '') {
+       public function setParsedSubject(string $subject): INotification {
+               if ($subject === '') {
                        throw new \InvalidArgumentException('The given parsed subject is invalid');
                }
                $this->subjectParsed = $subject;
@@ -282,7 +277,7 @@ class Notification implements INotification {
         * @return string
         * @since 8.2.0
         */
-       public function getParsedSubject() {
+       public function getParsedSubject(): string {
                return $this->subjectParsed;
        }
 
@@ -293,8 +288,8 @@ class Notification implements INotification {
         * @throws \InvalidArgumentException if the subject or parameters are invalid
         * @since 11.0.0
         */
-       public function setRichSubject(string $subject, array $parameters = []) {
-               if (trim($subject) === '') {
+       public function setRichSubject(string $subject, array $parameters = []): INotification {
+               if ($subject === '') {
                        throw new \InvalidArgumentException('The given parsed subject is invalid');
                }
 
@@ -308,7 +303,7 @@ class Notification implements INotification {
         * @return string
         * @since 11.0.0
         */
-       public function getRichSubject() {
+       public function getRichSubject(): string {
                return $this->subjectRich;
        }
 
@@ -316,7 +311,7 @@ class Notification implements INotification {
         * @return array[]
         * @since 11.0.0
         */
-       public function getRichSubjectParameters() {
+       public function getRichSubjectParameters(): array {
                return $this->subjectRichParameters;
        }
 
@@ -327,8 +322,8 @@ class Notification implements INotification {
         * @throws \InvalidArgumentException if the message or parameters are invalid
         * @since 8.2.0
         */
-       public function setMessage(string $message, array $parameters = []) {
-               if (trim($message) === '' || isset($message[64])) {
+       public function setMessage(string $message, array $parameters = []): INotification {
+               if ($message === '' || isset($message[64])) {
                        throw new \InvalidArgumentException('The given message is invalid');
                }
 
@@ -342,15 +337,15 @@ class Notification implements INotification {
         * @return string
         * @since 8.2.0
         */
-       public function getMessage() {
+       public function getMessage(): string {
                return $this->message;
        }
 
        /**
-        * @return string[]
+        * @return array
         * @since 8.2.0
         */
-       public function getMessageParameters() {
+       public function getMessageParameters(): array {
                return $this->messageParameters;
        }
 
@@ -360,8 +355,8 @@ class Notification implements INotification {
         * @throws \InvalidArgumentException if the message is invalid
         * @since 8.2.0
         */
-       public function setParsedMessage(string $message) {
-               if (trim($message) === '') {
+       public function setParsedMessage(string $message): INotification {
+               if ($message === '') {
                        throw new \InvalidArgumentException('The given parsed message is invalid');
                }
                $this->messageParsed = $message;
@@ -372,7 +367,7 @@ class Notification implements INotification {
         * @return string
         * @since 8.2.0
         */
-       public function getParsedMessage() {
+       public function getParsedMessage(): string {
                return $this->messageParsed;
        }
 
@@ -383,8 +378,8 @@ class Notification implements INotification {
         * @throws \InvalidArgumentException if the message or parameters are invalid
         * @since 11.0.0
         */
-       public function setRichMessage(string $message, array $parameters = []) {
-               if (trim($message) === '') {
+       public function setRichMessage(string $message, array $parameters = []): INotification {
+               if ($message === '') {
                        throw new \InvalidArgumentException('The given parsed message is invalid');
                }
 
@@ -398,7 +393,7 @@ class Notification implements INotification {
         * @return string
         * @since 11.0.0
         */
-       public function getRichMessage() {
+       public function getRichMessage(): string {
                return $this->messageRich;
        }
 
@@ -406,7 +401,7 @@ class Notification implements INotification {
         * @return array[]
         * @since 11.0.0
         */
-       public function getRichMessageParameters() {
+       public function getRichMessageParameters(): array {
                return $this->messageRichParameters;
        }
 
@@ -416,8 +411,8 @@ class Notification implements INotification {
         * @throws \InvalidArgumentException if the link is invalid
         * @since 8.2.0
         */
-       public function setLink(string $link) {
-               if (trim($link) === '' || isset($link[4000])) {
+       public function setLink(string $link): INotification {
+               if ($link === '' || isset($link[4000])) {
                        throw new \InvalidArgumentException('The given link is invalid');
                }
                $this->link = $link;
@@ -428,7 +423,7 @@ class Notification implements INotification {
         * @return string
         * @since 8.2.0
         */
-       public function getLink() {
+       public function getLink(): string {
                return $this->link;
        }
 
@@ -438,8 +433,8 @@ class Notification implements INotification {
         * @throws \InvalidArgumentException if the icon is invalid
         * @since 11.0.0
         */
-       public function setIcon(string $icon) {
-               if (trim($icon) === '' || isset($icon[4000])) {
+       public function setIcon(string $icon): INotification {
+               if ($icon === '' || isset($icon[4000])) {
                        throw new \InvalidArgumentException('The given icon is invalid');
                }
                $this->icon = $icon;
@@ -450,7 +445,7 @@ class Notification implements INotification {
         * @return string
         * @since 11.0.0
         */
-       public function getIcon() {
+       public function getIcon(): string {
                return $this->icon;
        }
 
@@ -458,7 +453,7 @@ class Notification implements INotification {
         * @return IAction
         * @since 8.2.0
         */
-       public function createAction() {
+       public function createAction(): IAction {
                return new Action();
        }
 
@@ -468,7 +463,7 @@ class Notification implements INotification {
         * @throws \InvalidArgumentException if the action is invalid
         * @since 8.2.0
         */
-       public function addAction(IAction $action) {
+       public function addAction(IAction $action): INotification {
                if (!$action->isValid()) {
                        throw new \InvalidArgumentException('The given action is invalid');
                }
@@ -489,7 +484,7 @@ class Notification implements INotification {
         * @return IAction[]
         * @since 8.2.0
         */
-       public function getActions() {
+       public function getActions(): array {
                return $this->actions;
        }
 
@@ -499,7 +494,7 @@ class Notification implements INotification {
         * @throws \InvalidArgumentException if the action is invalid
         * @since 8.2.0
         */
-       public function addParsedAction(IAction $action) {
+       public function addParsedAction(IAction $action): INotification {
                if (!$action->isValidParsed()) {
                        throw new \InvalidArgumentException('The given parsed action is invalid');
                }
@@ -524,7 +519,7 @@ class Notification implements INotification {
         * @return IAction[]
         * @since 8.2.0
         */
-       public function getParsedActions() {
+       public function getParsedActions(): array {
                return $this->actionsParsed;
        }
 
@@ -532,7 +527,7 @@ class Notification implements INotification {
         * @return bool
         * @since 8.2.0
         */
-       public function isValid() {
+       public function isValid(): bool {
                return
                        $this->isValidCommon()
                        &&
@@ -544,7 +539,7 @@ class Notification implements INotification {
         * @return bool
         * @since 8.2.0
         */
-       public function isValidParsed() {
+       public function isValidParsed(): bool {
                if ($this->getRichSubject() !== '' || !empty($this->getRichSubjectParameters())) {
                        try {
                                $this->richValidator->validate($this->getRichSubject(), $this->getRichSubjectParameters());
@@ -568,10 +563,7 @@ class Notification implements INotification {
                ;
        }
 
-       /**
-        * @return bool
-        */
-       protected function isValidCommon() {
+       protected function isValidCommon(): bool {
                return
                        $this->getApp() !== ''
                        &&
index 6f2b78e3a8d74ae30f77af287762602f2897a672..718a61b2f39313f3d8ebadc745a62b2a40c2ca8e 100644 (file)
@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 /**
  * @copyright Copyright (c) 2016, ownCloud, Inc.
  *
@@ -29,19 +30,41 @@ namespace OCP\Notification;
  * @since 9.0.0
  */
 interface IAction {
+
+       /**
+        * @since 17.0.0
+        */
+       public const TYPE_GET = 'GET';
+       /**
+        * @since 17.0.0
+        */
+       public const TYPE_POST = 'POST';
+       /**
+        * @since 17.0.0
+        */
+       public const TYPE_PUT = 'PUT';
+       /**
+        * @since 17.0.0
+        */
+       public const TYPE_DELETE = 'DELETE';
+       /**
+        * @since 17.0.0
+        */
+       public const TYPE_WEB = 'WEB';
+
        /**
         * @param string $label
         * @return $this
         * @throws \InvalidArgumentException if the label is invalid
         * @since 9.0.0
         */
-       public function setLabel($label);
+       public function setLabel(string $label): IAction;
 
        /**
         * @return string
         * @since 9.0.0
         */
-       public function getLabel();
+       public function getLabel(): string;
 
        /**
         * @param string $label
@@ -49,27 +72,27 @@ interface IAction {
         * @throws \InvalidArgumentException if the label is invalid
         * @since 9.0.0
         */
-       public function setParsedLabel($label);
+       public function setParsedLabel(string $label): IAction;
 
        /**
         * @return string
         * @since 9.0.0
         */
-       public function getParsedLabel();
+       public function getParsedLabel(): string;
 
        /**
-        * @param $primary bool
+        * @param bool $primary
         * @return $this
         * @throws \InvalidArgumentException if $primary is invalid
         * @since 9.0.0
         */
-       public function setPrimary($primary);
+       public function setPrimary(bool $primary): IAction;
 
        /**
         * @return bool
         * @since 9.0.0
         */
-       public function isPrimary();
+       public function isPrimary(): bool;
 
        /**
         * @param string $link
@@ -78,29 +101,29 @@ interface IAction {
         * @throws \InvalidArgumentException if the link is invalid
         * @since 9.0.0
         */
-       public function setLink($link, $requestType);
+       public function setLink(string $link, string $requestType): IAction;
 
        /**
         * @return string
         * @since 9.0.0
         */
-       public function getLink();
+       public function getLink(): string;
 
        /**
         * @return string
         * @since 9.0.0
         */
-       public function getRequestType();
+       public function getRequestType(): string;
 
        /**
         * @return bool
         * @since 9.0.0
         */
-       public function isValid();
+       public function isValid(): bool;
 
        /**
         * @return bool
         * @since 9.0.0
         */
-       public function isValidParsed();
+       public function isValidParsed(): bool;
 }
index 8f7b9b3d01356b1fb8a39900a692c73c779d5032..58d2a1fa5b88b94508c99a188b9183a75502cce5 100644 (file)
@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 /**
  * @copyright Copyright (c) 2016, ownCloud, Inc.
  *
@@ -34,18 +35,18 @@ interface IApp {
         * @throws \InvalidArgumentException When the notification is not valid
         * @since 9.0.0
         */
-       public function notify(INotification $notification);
+       public function notify(INotification $notification): void;
 
        /**
         * @param INotification $notification
         * @since 9.0.0
         */
-       public function markProcessed(INotification $notification);
+       public function markProcessed(INotification $notification): void;
 
        /**
         * @param INotification $notification
         * @return int
         * @since 9.0.0
         */
-       public function getCount(INotification $notification);
+       public function getCount(INotification $notification): int;
 }
index 003e5f1bad1fb8b8c17145a9f8e43d580dd98e63..7feac76a5dce0b846a5cb812e3c913bc8c59e731 100644 (file)
@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 /**
  * @copyright Copyright (c) 2016, ownCloud, Inc.
  *
@@ -49,29 +50,29 @@ interface IManager extends IApp, INotifier {
         * @return array App ID => App Name
         * @since 9.0.0
         */
-       public function listNotifiers();
+       public function listNotifiers(): array;
 
        /**
         * @return INotification
         * @since 9.0.0
         */
-       public function createNotification();
+       public function createNotification(): INotification;
 
        /**
         * @return bool
         * @since 9.0.0
         */
-       public function hasNotifiers();
+       public function hasNotifiers(): bool;
 
        /**
         * @param bool $preparingPushNotification
         * @since 14.0.0
         */
-       public function setPreparingPushNotification($preparingPushNotification);
+       public function setPreparingPushNotification(bool $preparingPushNotification): void;
 
        /**
         * @return bool
         * @since 14.0.0
         */
-       public function isPreparingPushNotification();
+       public function isPreparingPushNotification(): bool;
 }
index f7400e4778b1772327d3265dd62cc29eea431037..7261409e35550c3656260d2bdab1c9b25e979954 100644 (file)
@@ -1,5 +1,5 @@
 <?php
-declare (strict_types = 1);
+declare(strict_types=1);
 /**
  * @copyright Copyright (c) 2016, ownCloud, Inc.
  *
@@ -37,13 +37,13 @@ interface INotification {
         * @throws \InvalidArgumentException if the app id is invalid
         * @since 9.0.0
         */
-       public function setApp(string $app);
+       public function setApp(string $app): INotification;
 
        /**
         * @return string
         * @since 9.0.0
         */
-       public function getApp();
+       public function getApp(): string;
 
        /**
         * @param string $user
@@ -51,13 +51,13 @@ interface INotification {
         * @throws \InvalidArgumentException if the user id is invalid
         * @since 9.0.0
         */
-       public function setUser(string $user);
+       public function setUser(string $user): INotification;
 
        /**
         * @return string
         * @since 9.0.0
         */
-       public function getUser();
+       public function getUser(): string;
 
        /**
         * @param \DateTime $dateTime
@@ -65,13 +65,13 @@ interface INotification {
         * @throws \InvalidArgumentException if the $dateTime is invalid
         * @since 9.0.0
         */
-       public function setDateTime(\DateTime $dateTime);
+       public function setDateTime(\DateTime $dateTime): INotification;
 
        /**
         * @return \DateTime
         * @since 9.0.0
         */
-       public function getDateTime();
+       public function getDateTime(): \DateTime;
 
        /**
         * @param string $type
@@ -80,19 +80,19 @@ interface INotification {
         * @throws \InvalidArgumentException if the object type or id is invalid
         * @since 9.0.0
         */
-       public function setObject(string $type, $id);
+       public function setObject(string $type, string $id): INotification;
 
        /**
         * @return string
         * @since 9.0.0
         */
-       public function getObjectType();
+       public function getObjectType(): string;
 
        /**
         * @return string
         * @since 9.0.0
         */
-       public function getObjectId();
+       public function getObjectId(): string;
 
        /**
         * @param string $subject
@@ -101,19 +101,19 @@ interface INotification {
         * @throws \InvalidArgumentException if the subject or parameters are invalid
         * @since 9.0.0
         */
-       public function setSubject(string $subject, array $parameters = []);
+       public function setSubject(string $subject, array $parameters = []): INotification;
 
        /**
         * @return string
         * @since 9.0.0
         */
-       public function getSubject();
+       public function getSubject(): string;
 
        /**
-        * @return string[]
+        * @return array
         * @since 9.0.0
         */
-       public function getSubjectParameters();
+       public function getSubjectParameters(): array;
 
        /**
         * Set a parsed subject
@@ -132,13 +132,13 @@ interface INotification {
         * @throws \InvalidArgumentException if the subject is invalid
         * @since 9.0.0
         */
-       public function setParsedSubject(string $subject);
+       public function setParsedSubject(string $subject): INotification;
 
        /**
         * @return string
         * @since 9.0.0
         */
-       public function getParsedSubject();
+       public function getParsedSubject(): string;
 
        /**
         * Set a RichObjectString subject
@@ -157,19 +157,19 @@ interface INotification {
         * @throws \InvalidArgumentException if the subject or parameters are invalid
         * @since 11.0.0
         */
-       public function setRichSubject(string $subject, array $parameters = []);
+       public function setRichSubject(string $subject, array $parameters = []): INotification;
 
        /**
         * @return string
         * @since 11.0.0
         */
-       public function getRichSubject();
+       public function getRichSubject(): string;
 
        /**
         * @return array[]
         * @since 11.0.0
         */
-       public function getRichSubjectParameters();
+       public function getRichSubjectParameters(): array;
 
        /**
         * @param string $message
@@ -178,19 +178,19 @@ interface INotification {
         * @throws \InvalidArgumentException if the message or parameters are invalid
         * @since 9.0.0
         */
-       public function setMessage(string $message, array $parameters = []);
+       public function setMessage(string $message, array $parameters = []): INotification;
 
        /**
         * @return string
         * @since 9.0.0
         */
-       public function getMessage();
+       public function getMessage(): string;
 
        /**
-        * @return string[]
+        * @return array
         * @since 9.0.0
         */
-       public function getMessageParameters();
+       public function getMessageParameters(): array;
 
        /**
         * Set a parsed message
@@ -209,13 +209,13 @@ interface INotification {
         * @throws \InvalidArgumentException if the message is invalid
         * @since 9.0.0
         */
-       public function setParsedMessage(string $message);
+       public function setParsedMessage(string $message): INotification;
 
        /**
         * @return string
         * @since 9.0.0
         */
-       public function getParsedMessage();
+       public function getParsedMessage(): string;
 
        /**
         * Set a RichObjectString message
@@ -234,19 +234,19 @@ interface INotification {
         * @throws \InvalidArgumentException if the message or parameters are invalid
         * @since 11.0.0
         */
-       public function setRichMessage(string $message, array $parameters = []);
+       public function setRichMessage(string $message, array $parameters = []): INotification;
 
        /**
         * @return string
         * @since 11.0.0
         */
-       public function getRichMessage();
+       public function getRichMessage(): string;
 
        /**
         * @return array[]
         * @since 11.0.0
         */
-       public function getRichMessageParameters();
+       public function getRichMessageParameters(): array;
 
        /**
         * @param string $link
@@ -254,13 +254,13 @@ interface INotification {
         * @throws \InvalidArgumentException if the link is invalid
         * @since 9.0.0
         */
-       public function setLink(string $link);
+       public function setLink(string $link): INotification;
 
        /**
         * @return string
         * @since 9.0.0
         */
-       public function getLink();
+       public function getLink(): string;
 
        /**
         * @param string $icon
@@ -268,19 +268,19 @@ interface INotification {
         * @throws \InvalidArgumentException if the icon is invalid
         * @since 11.0.0
         */
-       public function setIcon(string $icon);
+       public function setIcon(string $icon): INotification;
 
        /**
         * @return string
         * @since 11.0.0
         */
-       public function getIcon();
+       public function getIcon(): string;
 
        /**
         * @return IAction
         * @since 9.0.0
         */
-       public function createAction();
+       public function createAction(): IAction;
 
        /**
         * @param IAction $action
@@ -288,13 +288,13 @@ interface INotification {
         * @throws \InvalidArgumentException if the action is invalid
         * @since 9.0.0
         */
-       public function addAction(IAction $action);
+       public function addAction(IAction $action): INotification;
 
        /**
         * @return IAction[]
         * @since 9.0.0
         */
-       public function getActions();
+       public function getActions(): array;
 
        /**
         * @param IAction $action
@@ -302,23 +302,23 @@ interface INotification {
         * @throws \InvalidArgumentException if the action is invalid
         * @since 9.0.0
         */
-       public function addParsedAction(IAction $action);
+       public function addParsedAction(IAction $action): INotification;
 
        /**
         * @return IAction[]
         * @since 9.0.0
         */
-       public function getParsedActions();
+       public function getParsedActions(): array;
 
        /**
         * @return bool
         * @since 9.0.0
         */
-       public function isValid();
+       public function isValid(): bool;
 
        /**
         * @return bool
         * @since 9.0.0
         */
-       public function isValidParsed();
+       public function isValidParsed(): bool;
 }
index 5e2a47266ad24fc3c450065f73f006da1b04970d..44066c035b9d3b523445c68bb3e81ebc7935936e 100644 (file)
@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 /**
  * @copyright Copyright (c) 2016, ownCloud, Inc.
  *
@@ -36,5 +37,5 @@ interface INotifier {
         * @throws \InvalidArgumentException When the notification was not prepared by a notifier
         * @since 9.0.0
         */
-       public function prepare(INotification $notification, $languageCode);
+       public function prepare(INotification $notification, string $languageCode): INotification;
 }