nextcloud / server

apps/updatenotification/lib/Notification/Notifier.php

Indentation +157 added lines, -157 removed lines

@@ -39,161 +39,161 @@
 
 class Notifier implements INotifier {
 
-	/** @var IURLGenerator */
-	protected $url;
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var IManager */
-	protected $notificationManager;
-
-	/** @var IFactory */
-	protected $l10NFactory;
-
-	/** @var IUserSession */
-	protected $userSession;
-
-	/** @var IGroupManager */
-	protected $groupManager;
-
-	/** @var string[] */
-	protected $appVersions;
-
-	/**
-	 * Notifier constructor.
-	 *
-	 * @param IURLGenerator $url
-	 * @param IConfig $config
-	 * @param IManager $notificationManager
-	 * @param IFactory $l10NFactory
-	 * @param IUserSession $userSession
-	 * @param IGroupManager $groupManager
-	 */
-	public function __construct(IURLGenerator $url, IConfig $config, IManager $notificationManager, IFactory $l10NFactory, IUserSession $userSession, IGroupManager $groupManager) {
-		$this->url = $url;
-		$this->notificationManager = $notificationManager;
-		$this->config = $config;
-		$this->l10NFactory = $l10NFactory;
-		$this->userSession = $userSession;
-		$this->groupManager = $groupManager;
-		$this->appVersions = $this->getAppVersions();
-	}
-
-	/**
-	 * Identifier of the notifier, only use [a-z0-9_]
-	 *
-	 * @return string
-	 * @since 17.0.0
-	 */
-	public function getID(): string {
-		return 'updatenotification';
-	}
-
-	/**
-	 * Human readable name describing the notifier
-	 *
-	 * @return string
-	 * @since 17.0.0
-	 */
-	public function getName(): string {
-		return $this->l10NFactory->get('updatenotification')->t('Update notifications');
-	}
-
-	/**
-	 * @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
-	 * @throws AlreadyProcessedException When the notification is not needed anymore and should be deleted
-	 * @since 9.0.0
-	 */
-	public function prepare(INotification $notification, string $languageCode): INotification {
-		if ($notification->getApp() !== 'updatenotification') {
-			throw new \InvalidArgumentException('Unknown app id');
-		}
-
-		$l = $this->l10NFactory->get('updatenotification', $languageCode);
-		if ($notification->getSubject() === 'connection_error') {
-			$errors = (int) $this->config->getAppValue('updatenotification', 'update_check_errors', 0);
-			if ($errors === 0) {
-				$this->notificationManager->markProcessed($notification);
-				throw new \InvalidArgumentException('Update checked worked again');
-			}
-
-			$notification->setParsedSubject($l->t('The update server could not be reached since %d days to check for new updates.', [$errors]))
-				->setParsedMessage($l->t('Please check the Nextcloud and server log files for errors.'));
-		} elseif ($notification->getObjectType() === 'core') {
-			$this->updateAlreadyInstalledCheck($notification, $this->getCoreVersions());
-
-			$parameters = $notification->getSubjectParameters();
-			$notification->setParsedSubject($l->t('Update to %1$s is available.', [$parameters['version']]));
-
-			if ($this->isAdmin()) {
-				$notification->setLink($this->url->linkToRouteAbsolute('settings.AdminSettings.index', ['section' => 'overview']) . '#version');
-			}
-		} else {
-			$appInfo = $this->getAppInfo($notification->getObjectType());
-			$appName = ($appInfo === null) ? $notification->getObjectType() : $appInfo['name'];
-
-			if (isset($this->appVersions[$notification->getObjectType()])) {
-				$this->updateAlreadyInstalledCheck($notification, $this->appVersions[$notification->getObjectType()]);
-			}
-
-			$notification->setParsedSubject($l->t('Update for %1$s to version %2$s is available.', [$appName, $notification->getObjectId()]))
-				->setRichSubject($l->t('Update for {app} to version %s is available.', [$notification->getObjectId()]), [
-					'app' => [
-						'type' => 'app',
-						'id' => $notification->getObjectType(),
-						'name' => $appName,
-					]
-				]);
-
-			if ($this->isAdmin()) {
-				$notification->setLink($this->url->linkToRouteAbsolute('settings.AppSettings.viewApps', ['category' => 'updates']) . '#app-' . $notification->getObjectType());
-			}
-		}
-
-		$notification->setIcon($this->url->getAbsoluteURL($this->url->imagePath('updatenotification', 'notification.svg')));
-
-		return $notification;
-	}
-
-	/**
-	 * Remove the notification and prevent rendering, when the update is installed
-	 *
-	 * @param INotification $notification
-	 * @param string $installedVersion
-	 * @throws AlreadyProcessedException When the update is already installed
-	 */
-	protected function updateAlreadyInstalledCheck(INotification $notification, $installedVersion) {
-		if (version_compare($notification->getObjectId(), $installedVersion, '<=')) {
-			throw new AlreadyProcessedException();
-		}
-	}
-
-	/**
-	 * @return bool
-	 */
-	protected function isAdmin(): bool {
-		$user = $this->userSession->getUser();
-
-		if ($user instanceof IUser) {
-			return $this->groupManager->isAdmin($user->getUID());
-		}
-
-		return false;
-	}
-
-	protected function getCoreVersions(): string {
-		return implode('.', Util::getVersion());
-	}
-
-	protected function getAppVersions(): array {
-		return \OC_App::getAppVersions();
-	}
-
-	protected function getAppInfo($appId) {
-		return \OC_App::getAppInfo($appId);
-	}
+    /** @var IURLGenerator */
+    protected $url;
+
+    /** @var IConfig */
+    protected $config;
+
+    /** @var IManager */
+    protected $notificationManager;
+
+    /** @var IFactory */
+    protected $l10NFactory;
+
+    /** @var IUserSession */
+    protected $userSession;
+
+    /** @var IGroupManager */
+    protected $groupManager;
+
+    /** @var string[] */
+    protected $appVersions;
+
+    /**
+     * Notifier constructor.
+     *
+     * @param IURLGenerator $url
+     * @param IConfig $config
+     * @param IManager $notificationManager
+     * @param IFactory $l10NFactory
+     * @param IUserSession $userSession
+     * @param IGroupManager $groupManager
+     */
+    public function __construct(IURLGenerator $url, IConfig $config, IManager $notificationManager, IFactory $l10NFactory, IUserSession $userSession, IGroupManager $groupManager) {
+        $this->url = $url;
+        $this->notificationManager = $notificationManager;
+        $this->config = $config;
+        $this->l10NFactory = $l10NFactory;
+        $this->userSession = $userSession;
+        $this->groupManager = $groupManager;
+        $this->appVersions = $this->getAppVersions();
+    }
+
+    /**
+     * Identifier of the notifier, only use [a-z0-9_]
+     *
+     * @return string
+     * @since 17.0.0
+     */
+    public function getID(): string {
+        return 'updatenotification';
+    }
+
+    /**
+     * Human readable name describing the notifier
+     *
+     * @return string
+     * @since 17.0.0
+     */
+    public function getName(): string {
+        return $this->l10NFactory->get('updatenotification')->t('Update notifications');
+    }
+
+    /**
+     * @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
+     * @throws AlreadyProcessedException When the notification is not needed anymore and should be deleted
+     * @since 9.0.0
+     */
+    public function prepare(INotification $notification, string $languageCode): INotification {
+        if ($notification->getApp() !== 'updatenotification') {
+            throw new \InvalidArgumentException('Unknown app id');
+        }
+
+        $l = $this->l10NFactory->get('updatenotification', $languageCode);
+        if ($notification->getSubject() === 'connection_error') {
+            $errors = (int) $this->config->getAppValue('updatenotification', 'update_check_errors', 0);
+            if ($errors === 0) {
+                $this->notificationManager->markProcessed($notification);
+                throw new \InvalidArgumentException('Update checked worked again');
+            }
+
+            $notification->setParsedSubject($l->t('The update server could not be reached since %d days to check for new updates.', [$errors]))
+                ->setParsedMessage($l->t('Please check the Nextcloud and server log files for errors.'));
+        } elseif ($notification->getObjectType() === 'core') {
+            $this->updateAlreadyInstalledCheck($notification, $this->getCoreVersions());
+
+            $parameters = $notification->getSubjectParameters();
+            $notification->setParsedSubject($l->t('Update to %1$s is available.', [$parameters['version']]));
+
+            if ($this->isAdmin()) {
+                $notification->setLink($this->url->linkToRouteAbsolute('settings.AdminSettings.index', ['section' => 'overview']) . '#version');
+            }
+        } else {
+            $appInfo = $this->getAppInfo($notification->getObjectType());
+            $appName = ($appInfo === null) ? $notification->getObjectType() : $appInfo['name'];
+
+            if (isset($this->appVersions[$notification->getObjectType()])) {
+                $this->updateAlreadyInstalledCheck($notification, $this->appVersions[$notification->getObjectType()]);
+            }
+
+            $notification->setParsedSubject($l->t('Update for %1$s to version %2$s is available.', [$appName, $notification->getObjectId()]))
+                ->setRichSubject($l->t('Update for {app} to version %s is available.', [$notification->getObjectId()]), [
+                    'app' => [
+                        'type' => 'app',
+                        'id' => $notification->getObjectType(),
+                        'name' => $appName,
+                    ]
+                ]);
+
+            if ($this->isAdmin()) {
+                $notification->setLink($this->url->linkToRouteAbsolute('settings.AppSettings.viewApps', ['category' => 'updates']) . '#app-' . $notification->getObjectType());
+            }
+        }
+
+        $notification->setIcon($this->url->getAbsoluteURL($this->url->imagePath('updatenotification', 'notification.svg')));
+
+        return $notification;
+    }
+
+    /**
+     * Remove the notification and prevent rendering, when the update is installed
+     *
+     * @param INotification $notification
+     * @param string $installedVersion
+     * @throws AlreadyProcessedException When the update is already installed
+     */
+    protected function updateAlreadyInstalledCheck(INotification $notification, $installedVersion) {
+        if (version_compare($notification->getObjectId(), $installedVersion, '<=')) {
+            throw new AlreadyProcessedException();
+        }
+    }
+
+    /**
+     * @return bool
+     */
+    protected function isAdmin(): bool {
+        $user = $this->userSession->getUser();
+
+        if ($user instanceof IUser) {
+            return $this->groupManager->isAdmin($user->getUID());
+        }
+
+        return false;
+    }
+
+    protected function getCoreVersions(): string {
+        return implode('.', Util::getVersion());
+    }
+
+    protected function getAppVersions(): array {
+        return \OC_App::getAppVersions();
+    }
+
+    protected function getAppInfo($appId) {
+        return \OC_App::getAppInfo($appId);
+    }
 }

lib/private/Authentication/Notifications/Notifier.php

Indentation +53 added lines, -53 removed lines

@@ -32,65 +32,65 @@
 
 class Notifier implements INotifier {
 
-	/** @var IL10nFactory */
-	private $factory;
+    /** @var IL10nFactory */
+    private $factory;
 
-	public function __construct(IL10nFactory $l10nFactory) {
-		$this->factory = $l10nFactory;
-	}
+    public function __construct(IL10nFactory $l10nFactory) {
+        $this->factory = $l10nFactory;
+    }
 
-	/**
-	 * @inheritDoc
-	 */
-	public function prepare(INotification $notification, string $languageCode): INotification {
-		if ($notification->getApp() !== 'auth') {
-			// Not my app => throw
-			throw new InvalidArgumentException();
-		}
+    /**
+     * @inheritDoc
+     */
+    public function prepare(INotification $notification, string $languageCode): INotification {
+        if ($notification->getApp() !== 'auth') {
+            // Not my app => throw
+            throw new InvalidArgumentException();
+        }
 
-		// Read the language from the notification
-		$l = $this->factory->get('lib', $languageCode);
+        // Read the language from the notification
+        $l = $this->factory->get('lib', $languageCode);
 
-		switch ($notification->getSubject()) {
-			case 'remote_wipe_start':
-				$notification->setParsedSubject(
-					$l->t('Remote wipe started')
-				)->setParsedMessage(
-					$l->t('A remote wipe was started on device %s', $notification->getSubjectParameters())
-				);
+        switch ($notification->getSubject()) {
+            case 'remote_wipe_start':
+                $notification->setParsedSubject(
+                    $l->t('Remote wipe started')
+                )->setParsedMessage(
+                    $l->t('A remote wipe was started on device %s', $notification->getSubjectParameters())
+                );
 
-				return $notification;
-			case 'remote_wipe_finish':
-				$notification->setParsedSubject(
-					$l->t('Remote wipe finished')
-				)->setParsedMessage(
-					$l->t('The remote wipe on %s has finished', $notification->getSubjectParameters())
-				);
+                return $notification;
+            case 'remote_wipe_finish':
+                $notification->setParsedSubject(
+                    $l->t('Remote wipe finished')
+                )->setParsedMessage(
+                    $l->t('The remote wipe on %s has finished', $notification->getSubjectParameters())
+                );
 
-				return $notification;
-			default:
-				// Unknown subject => Unknown notification => throw
-				throw new InvalidArgumentException();
-		}
-	}
+                return $notification;
+            default:
+                // Unknown subject => Unknown notification => throw
+                throw new InvalidArgumentException();
+        }
+    }
 
-	/**
-	 * Identifier of the notifier, only use [a-z0-9_]
-	 *
-	 * @return string
-	 * @since 17.0.0
-	 */
-	public function getID(): string {
-		return 'auth';
-	}
+    /**
+     * Identifier of the notifier, only use [a-z0-9_]
+     *
+     * @return string
+     * @since 17.0.0
+     */
+    public function getID(): string {
+        return 'auth';
+    }
 
-	/**
-	 * Human readable name describing the notifier
-	 *
-	 * @return string
-	 * @since 17.0.0
-	 */
-	public function getName(): string {
-		return $this->factory->get('lib')->t('Authentication');
-	}
+    /**
+     * Human readable name describing the notifier
+     *
+     * @return string
+     * @since 17.0.0
+     */
+    public function getName(): string {
+        return $this->factory->get('lib')->t('Authentication');
+    }
 }

lib/private/Notification/Notification.php

Indentation +543 added lines, -543 removed lines

@@ -33,547 +33,547 @@
 
 class Notification implements INotification {
 
-	/** @var IValidator */
-	protected $richValidator;
-
-	/** @var string */
-	protected $app;
-
-	/** @var string */
-	protected $user;
-
-	/** @var \DateTime */
-	protected $dateTime;
-
-	/** @var string */
-	protected $objectType;
-
-	/** @var string */
-	protected $objectId;
-
-	/** @var string */
-	protected $subject;
-
-	/** @var array */
-	protected $subjectParameters;
-
-	/** @var string */
-	protected $subjectParsed;
-
-	/** @var string */
-	protected $subjectRich;
-
-	/** @var array */
-	protected $subjectRichParameters;
-
-	/** @var string */
-	protected $message;
-
-	/** @var array */
-	protected $messageParameters;
-
-	/** @var string */
-	protected $messageParsed;
-
-	/** @var string */
-	protected $messageRich;
-
-	/** @var array */
-	protected $messageRichParameters;
-
-	/** @var string */
-	protected $link;
-
-	/** @var string */
-	protected $icon;
-
-	/** @var array */
-	protected $actions;
-
-	/** @var array */
-	protected $actionsParsed;
-
-	/** @var bool */
-	protected $hasPrimaryAction;
-
-	/** @var bool */
-	protected $hasPrimaryParsedAction;
-
-	public function __construct(IValidator $richValidator) {
-		$this->richValidator = $richValidator;
-		$this->app = '';
-		$this->user = '';
-		$this->dateTime = new \DateTime();
-		$this->dateTime->setTimestamp(0);
-		$this->objectType = '';
-		$this->objectId = '';
-		$this->subject = '';
-		$this->subjectParameters = [];
-		$this->subjectParsed = '';
-		$this->subjectRich = '';
-		$this->subjectRichParameters = [];
-		$this->message = '';
-		$this->messageParameters = [];
-		$this->messageParsed = '';
-		$this->messageRich = '';
-		$this->messageRichParameters = [];
-		$this->link = '';
-		$this->icon = '';
-		$this->actions = [];
-		$this->actionsParsed = [];
-	}
-
-	/**
-	 * @param string $app
-	 * @return $this
-	 * @throws \InvalidArgumentException if the app id is invalid
-	 * @since 8.2.0
-	 */
-	public function setApp(string $app): INotification {
-		if ($app === '' || isset($app[32])) {
-			throw new \InvalidArgumentException('The given app name is invalid');
-		}
-		$this->app = $app;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getApp(): string {
-		return $this->app;
-	}
-
-	/**
-	 * @param string $user
-	 * @return $this
-	 * @throws \InvalidArgumentException if the user id is invalid
-	 * @since 8.2.0
-	 */
-	public function setUser(string $user): INotification {
-		if ($user === '' || isset($user[64])) {
-			throw new \InvalidArgumentException('The given user id is invalid');
-		}
-		$this->user = $user;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getUser(): string {
-		return $this->user;
-	}
-
-	/**
-	 * @param \DateTime $dateTime
-	 * @return $this
-	 * @throws \InvalidArgumentException if the $dateTime is invalid
-	 * @since 9.0.0
-	 */
-	public function setDateTime(\DateTime $dateTime): INotification {
-		if ($dateTime->getTimestamp() === 0) {
-			throw new \InvalidArgumentException('The given date time is invalid');
-		}
-		$this->dateTime = $dateTime;
-		return $this;
-	}
-
-	/**
-	 * @return \DateTime
-	 * @since 9.0.0
-	 */
-	public function getDateTime(): \DateTime {
-		return $this->dateTime;
-	}
-
-	/**
-	 * @param string $type
-	 * @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
-	 */
-	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 ($id === '' || isset($id[64])) {
-			throw new \InvalidArgumentException('The given object id is invalid');
-		}
-		$this->objectId = (string) $id;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getObjectType(): string {
-		return $this->objectType;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0 - 9.0.0: Return type changed to string
-	 */
-	public function getObjectId(): string {
-		return $this->objectId;
-	}
-
-	/**
-	 * @param string $subject
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the subject or parameters are invalid
-	 * @since 8.2.0
-	 */
-	public function setSubject(string $subject, array $parameters = []): INotification {
-		if ($subject === '' || isset($subject[64])) {
-			throw new \InvalidArgumentException('The given subject is invalid');
-		}
-
-		$this->subject = $subject;
-		$this->subjectParameters = $parameters;
-
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getSubject(): string {
-		return $this->subject;
-	}
-
-	/**
-	 * @return array
-	 * @since 8.2.0
-	 */
-	public function getSubjectParameters(): array {
-		return $this->subjectParameters;
-	}
-
-	/**
-	 * @param string $subject
-	 * @return $this
-	 * @throws \InvalidArgumentException if the subject is invalid
-	 * @since 8.2.0
-	 */
-	public function setParsedSubject(string $subject): INotification {
-		if ($subject === '') {
-			throw new \InvalidArgumentException('The given parsed subject is invalid');
-		}
-		$this->subjectParsed = $subject;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getParsedSubject(): string {
-		return $this->subjectParsed;
-	}
-
-	/**
-	 * @param string $subject
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the subject or parameters are invalid
-	 * @since 11.0.0
-	 */
-	public function setRichSubject(string $subject, array $parameters = []): INotification {
-		if ($subject === '') {
-			throw new \InvalidArgumentException('The given parsed subject is invalid');
-		}
-
-		$this->subjectRich = $subject;
-		$this->subjectRichParameters = $parameters;
-
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getRichSubject(): string {
-		return $this->subjectRich;
-	}
-
-	/**
-	 * @return array[]
-	 * @since 11.0.0
-	 */
-	public function getRichSubjectParameters(): array {
-		return $this->subjectRichParameters;
-	}
-
-	/**
-	 * @param string $message
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the message or parameters are invalid
-	 * @since 8.2.0
-	 */
-	public function setMessage(string $message, array $parameters = []): INotification {
-		if ($message === '' || isset($message[64])) {
-			throw new \InvalidArgumentException('The given message is invalid');
-		}
-
-		$this->message = $message;
-		$this->messageParameters = $parameters;
-
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getMessage(): string {
-		return $this->message;
-	}
-
-	/**
-	 * @return array
-	 * @since 8.2.0
-	 */
-	public function getMessageParameters(): array {
-		return $this->messageParameters;
-	}
-
-	/**
-	 * @param string $message
-	 * @return $this
-	 * @throws \InvalidArgumentException if the message is invalid
-	 * @since 8.2.0
-	 */
-	public function setParsedMessage(string $message): INotification {
-		if ($message === '') {
-			throw new \InvalidArgumentException('The given parsed message is invalid');
-		}
-		$this->messageParsed = $message;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getParsedMessage(): string {
-		return $this->messageParsed;
-	}
-
-	/**
-	 * @param string $message
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the message or parameters are invalid
-	 * @since 11.0.0
-	 */
-	public function setRichMessage(string $message, array $parameters = []): INotification {
-		if ($message === '') {
-			throw new \InvalidArgumentException('The given parsed message is invalid');
-		}
-
-		$this->messageRich = $message;
-		$this->messageRichParameters = $parameters;
-
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getRichMessage(): string {
-		return $this->messageRich;
-	}
-
-	/**
-	 * @return array[]
-	 * @since 11.0.0
-	 */
-	public function getRichMessageParameters(): array {
-		return $this->messageRichParameters;
-	}
-
-	/**
-	 * @param string $link
-	 * @return $this
-	 * @throws \InvalidArgumentException if the link is invalid
-	 * @since 8.2.0
-	 */
-	public function setLink(string $link): INotification {
-		if ($link === '' || isset($link[4000])) {
-			throw new \InvalidArgumentException('The given link is invalid');
-		}
-		$this->link = $link;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getLink(): string {
-		return $this->link;
-	}
-
-	/**
-	 * @param string $icon
-	 * @return $this
-	 * @throws \InvalidArgumentException if the icon is invalid
-	 * @since 11.0.0
-	 */
-	public function setIcon(string $icon): INotification {
-		if ($icon === '' || isset($icon[4000])) {
-			throw new \InvalidArgumentException('The given icon is invalid');
-		}
-		$this->icon = $icon;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getIcon(): string {
-		return $this->icon;
-	}
-
-	/**
-	 * @return IAction
-	 * @since 8.2.0
-	 */
-	public function createAction(): IAction {
-		return new Action();
-	}
-
-	/**
-	 * @param IAction $action
-	 * @return $this
-	 * @throws \InvalidArgumentException if the action is invalid
-	 * @since 8.2.0
-	 */
-	public function addAction(IAction $action): INotification {
-		if (!$action->isValid()) {
-			throw new \InvalidArgumentException('The given action is invalid');
-		}
-
-		if ($action->isPrimary()) {
-			if ($this->hasPrimaryAction) {
-				throw new \InvalidArgumentException('The notification already has a primary action');
-			}
-
-			$this->hasPrimaryAction = true;
-		}
-
-		$this->actions[] = $action;
-		return $this;
-	}
-
-	/**
-	 * @return IAction[]
-	 * @since 8.2.0
-	 */
-	public function getActions(): array {
-		return $this->actions;
-	}
-
-	/**
-	 * @param IAction $action
-	 * @return $this
-	 * @throws \InvalidArgumentException if the action is invalid
-	 * @since 8.2.0
-	 */
-	public function addParsedAction(IAction $action): INotification {
-		if (!$action->isValidParsed()) {
-			throw new \InvalidArgumentException('The given parsed action is invalid');
-		}
-
-		if ($action->isPrimary()) {
-			if ($this->hasPrimaryParsedAction) {
-				throw new \InvalidArgumentException('The notification already has a primary action');
-			}
-
-			$this->hasPrimaryParsedAction = true;
-
-			// Make sure the primary action is always the first one
-			array_unshift($this->actionsParsed, $action);
-		} else {
-			$this->actionsParsed[] = $action;
-		}
-
-		return $this;
-	}
-
-	/**
-	 * @return IAction[]
-	 * @since 8.2.0
-	 */
-	public function getParsedActions(): array {
-		return $this->actionsParsed;
-	}
-
-	/**
-	 * @return bool
-	 * @since 8.2.0
-	 */
-	public function isValid(): bool {
-		return
-			$this->isValidCommon()
-			&&
-			$this->getSubject() !== ''
-		;
-	}
-
-	/**
-	 * @return bool
-	 * @since 8.2.0
-	 */
-	public function isValidParsed(): bool {
-		if ($this->getRichSubject() !== '' || !empty($this->getRichSubjectParameters())) {
-			try {
-				$this->richValidator->validate($this->getRichSubject(), $this->getRichSubjectParameters());
-			} catch (InvalidObjectExeption $e) {
-				return false;
-			}
-		}
-
-		if ($this->getRichMessage() !== '' || !empty($this->getRichMessageParameters())) {
-			try {
-				$this->richValidator->validate($this->getRichMessage(), $this->getRichMessageParameters());
-			} catch (InvalidObjectExeption $e) {
-				return false;
-			}
-		}
-
-		return
-			$this->isValidCommon()
-			&&
-			$this->getParsedSubject() !== ''
-		;
-	}
-
-	protected function isValidCommon(): bool {
-		return
-			$this->getApp() !== ''
-			&&
-			$this->getUser() !== ''
-			&&
-			$this->getDateTime()->getTimestamp() !== 0
-			&&
-			$this->getObjectType() !== ''
-			&&
-			$this->getObjectId() !== ''
-		;
-	}
+    /** @var IValidator */
+    protected $richValidator;
+
+    /** @var string */
+    protected $app;
+
+    /** @var string */
+    protected $user;
+
+    /** @var \DateTime */
+    protected $dateTime;
+
+    /** @var string */
+    protected $objectType;
+
+    /** @var string */
+    protected $objectId;
+
+    /** @var string */
+    protected $subject;
+
+    /** @var array */
+    protected $subjectParameters;
+
+    /** @var string */
+    protected $subjectParsed;
+
+    /** @var string */
+    protected $subjectRich;
+
+    /** @var array */
+    protected $subjectRichParameters;
+
+    /** @var string */
+    protected $message;
+
+    /** @var array */
+    protected $messageParameters;
+
+    /** @var string */
+    protected $messageParsed;
+
+    /** @var string */
+    protected $messageRich;
+
+    /** @var array */
+    protected $messageRichParameters;
+
+    /** @var string */
+    protected $link;
+
+    /** @var string */
+    protected $icon;
+
+    /** @var array */
+    protected $actions;
+
+    /** @var array */
+    protected $actionsParsed;
+
+    /** @var bool */
+    protected $hasPrimaryAction;
+
+    /** @var bool */
+    protected $hasPrimaryParsedAction;
+
+    public function __construct(IValidator $richValidator) {
+        $this->richValidator = $richValidator;
+        $this->app = '';
+        $this->user = '';
+        $this->dateTime = new \DateTime();
+        $this->dateTime->setTimestamp(0);
+        $this->objectType = '';
+        $this->objectId = '';
+        $this->subject = '';
+        $this->subjectParameters = [];
+        $this->subjectParsed = '';
+        $this->subjectRich = '';
+        $this->subjectRichParameters = [];
+        $this->message = '';
+        $this->messageParameters = [];
+        $this->messageParsed = '';
+        $this->messageRich = '';
+        $this->messageRichParameters = [];
+        $this->link = '';
+        $this->icon = '';
+        $this->actions = [];
+        $this->actionsParsed = [];
+    }
+
+    /**
+     * @param string $app
+     * @return $this
+     * @throws \InvalidArgumentException if the app id is invalid
+     * @since 8.2.0
+     */
+    public function setApp(string $app): INotification {
+        if ($app === '' || isset($app[32])) {
+            throw new \InvalidArgumentException('The given app name is invalid');
+        }
+        $this->app = $app;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getApp(): string {
+        return $this->app;
+    }
+
+    /**
+     * @param string $user
+     * @return $this
+     * @throws \InvalidArgumentException if the user id is invalid
+     * @since 8.2.0
+     */
+    public function setUser(string $user): INotification {
+        if ($user === '' || isset($user[64])) {
+            throw new \InvalidArgumentException('The given user id is invalid');
+        }
+        $this->user = $user;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getUser(): string {
+        return $this->user;
+    }
+
+    /**
+     * @param \DateTime $dateTime
+     * @return $this
+     * @throws \InvalidArgumentException if the $dateTime is invalid
+     * @since 9.0.0
+     */
+    public function setDateTime(\DateTime $dateTime): INotification {
+        if ($dateTime->getTimestamp() === 0) {
+            throw new \InvalidArgumentException('The given date time is invalid');
+        }
+        $this->dateTime = $dateTime;
+        return $this;
+    }
+
+    /**
+     * @return \DateTime
+     * @since 9.0.0
+     */
+    public function getDateTime(): \DateTime {
+        return $this->dateTime;
+    }
+
+    /**
+     * @param string $type
+     * @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
+     */
+    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 ($id === '' || isset($id[64])) {
+            throw new \InvalidArgumentException('The given object id is invalid');
+        }
+        $this->objectId = (string) $id;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getObjectType(): string {
+        return $this->objectType;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0 - 9.0.0: Return type changed to string
+     */
+    public function getObjectId(): string {
+        return $this->objectId;
+    }
+
+    /**
+     * @param string $subject
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the subject or parameters are invalid
+     * @since 8.2.0
+     */
+    public function setSubject(string $subject, array $parameters = []): INotification {
+        if ($subject === '' || isset($subject[64])) {
+            throw new \InvalidArgumentException('The given subject is invalid');
+        }
+
+        $this->subject = $subject;
+        $this->subjectParameters = $parameters;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getSubject(): string {
+        return $this->subject;
+    }
+
+    /**
+     * @return array
+     * @since 8.2.0
+     */
+    public function getSubjectParameters(): array {
+        return $this->subjectParameters;
+    }
+
+    /**
+     * @param string $subject
+     * @return $this
+     * @throws \InvalidArgumentException if the subject is invalid
+     * @since 8.2.0
+     */
+    public function setParsedSubject(string $subject): INotification {
+        if ($subject === '') {
+            throw new \InvalidArgumentException('The given parsed subject is invalid');
+        }
+        $this->subjectParsed = $subject;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getParsedSubject(): string {
+        return $this->subjectParsed;
+    }
+
+    /**
+     * @param string $subject
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the subject or parameters are invalid
+     * @since 11.0.0
+     */
+    public function setRichSubject(string $subject, array $parameters = []): INotification {
+        if ($subject === '') {
+            throw new \InvalidArgumentException('The given parsed subject is invalid');
+        }
+
+        $this->subjectRich = $subject;
+        $this->subjectRichParameters = $parameters;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getRichSubject(): string {
+        return $this->subjectRich;
+    }
+
+    /**
+     * @return array[]
+     * @since 11.0.0
+     */
+    public function getRichSubjectParameters(): array {
+        return $this->subjectRichParameters;
+    }
+
+    /**
+     * @param string $message
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the message or parameters are invalid
+     * @since 8.2.0
+     */
+    public function setMessage(string $message, array $parameters = []): INotification {
+        if ($message === '' || isset($message[64])) {
+            throw new \InvalidArgumentException('The given message is invalid');
+        }
+
+        $this->message = $message;
+        $this->messageParameters = $parameters;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getMessage(): string {
+        return $this->message;
+    }
+
+    /**
+     * @return array
+     * @since 8.2.0
+     */
+    public function getMessageParameters(): array {
+        return $this->messageParameters;
+    }
+
+    /**
+     * @param string $message
+     * @return $this
+     * @throws \InvalidArgumentException if the message is invalid
+     * @since 8.2.0
+     */
+    public function setParsedMessage(string $message): INotification {
+        if ($message === '') {
+            throw new \InvalidArgumentException('The given parsed message is invalid');
+        }
+        $this->messageParsed = $message;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getParsedMessage(): string {
+        return $this->messageParsed;
+    }
+
+    /**
+     * @param string $message
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the message or parameters are invalid
+     * @since 11.0.0
+     */
+    public function setRichMessage(string $message, array $parameters = []): INotification {
+        if ($message === '') {
+            throw new \InvalidArgumentException('The given parsed message is invalid');
+        }
+
+        $this->messageRich = $message;
+        $this->messageRichParameters = $parameters;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getRichMessage(): string {
+        return $this->messageRich;
+    }
+
+    /**
+     * @return array[]
+     * @since 11.0.0
+     */
+    public function getRichMessageParameters(): array {
+        return $this->messageRichParameters;
+    }
+
+    /**
+     * @param string $link
+     * @return $this
+     * @throws \InvalidArgumentException if the link is invalid
+     * @since 8.2.0
+     */
+    public function setLink(string $link): INotification {
+        if ($link === '' || isset($link[4000])) {
+            throw new \InvalidArgumentException('The given link is invalid');
+        }
+        $this->link = $link;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getLink(): string {
+        return $this->link;
+    }
+
+    /**
+     * @param string $icon
+     * @return $this
+     * @throws \InvalidArgumentException if the icon is invalid
+     * @since 11.0.0
+     */
+    public function setIcon(string $icon): INotification {
+        if ($icon === '' || isset($icon[4000])) {
+            throw new \InvalidArgumentException('The given icon is invalid');
+        }
+        $this->icon = $icon;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getIcon(): string {
+        return $this->icon;
+    }
+
+    /**
+     * @return IAction
+     * @since 8.2.0
+     */
+    public function createAction(): IAction {
+        return new Action();
+    }
+
+    /**
+     * @param IAction $action
+     * @return $this
+     * @throws \InvalidArgumentException if the action is invalid
+     * @since 8.2.0
+     */
+    public function addAction(IAction $action): INotification {
+        if (!$action->isValid()) {
+            throw new \InvalidArgumentException('The given action is invalid');
+        }
+
+        if ($action->isPrimary()) {
+            if ($this->hasPrimaryAction) {
+                throw new \InvalidArgumentException('The notification already has a primary action');
+            }
+
+            $this->hasPrimaryAction = true;
+        }
+
+        $this->actions[] = $action;
+        return $this;
+    }
+
+    /**
+     * @return IAction[]
+     * @since 8.2.0
+     */
+    public function getActions(): array {
+        return $this->actions;
+    }
+
+    /**
+     * @param IAction $action
+     * @return $this
+     * @throws \InvalidArgumentException if the action is invalid
+     * @since 8.2.0
+     */
+    public function addParsedAction(IAction $action): INotification {
+        if (!$action->isValidParsed()) {
+            throw new \InvalidArgumentException('The given parsed action is invalid');
+        }
+
+        if ($action->isPrimary()) {
+            if ($this->hasPrimaryParsedAction) {
+                throw new \InvalidArgumentException('The notification already has a primary action');
+            }
+
+            $this->hasPrimaryParsedAction = true;
+
+            // Make sure the primary action is always the first one
+            array_unshift($this->actionsParsed, $action);
+        } else {
+            $this->actionsParsed[] = $action;
+        }
+
+        return $this;
+    }
+
+    /**
+     * @return IAction[]
+     * @since 8.2.0
+     */
+    public function getParsedActions(): array {
+        return $this->actionsParsed;
+    }
+
+    /**
+     * @return bool
+     * @since 8.2.0
+     */
+    public function isValid(): bool {
+        return
+            $this->isValidCommon()
+            &&
+            $this->getSubject() !== ''
+        ;
+    }
+
+    /**
+     * @return bool
+     * @since 8.2.0
+     */
+    public function isValidParsed(): bool {
+        if ($this->getRichSubject() !== '' || !empty($this->getRichSubjectParameters())) {
+            try {
+                $this->richValidator->validate($this->getRichSubject(), $this->getRichSubjectParameters());
+            } catch (InvalidObjectExeption $e) {
+                return false;
+            }
+        }
+
+        if ($this->getRichMessage() !== '' || !empty($this->getRichMessageParameters())) {
+            try {
+                $this->richValidator->validate($this->getRichMessage(), $this->getRichMessageParameters());
+            } catch (InvalidObjectExeption $e) {
+                return false;
+            }
+        }
+
+        return
+            $this->isValidCommon()
+            &&
+            $this->getParsedSubject() !== ''
+        ;
+    }
+
+    protected function isValidCommon(): bool {
+        return
+            $this->getApp() !== ''
+            &&
+            $this->getUser() !== ''
+            &&
+            $this->getDateTime()->getTimestamp() !== 0
+            &&
+            $this->getObjectType() !== ''
+            &&
+            $this->getObjectId() !== ''
+        ;
+    }
 }

lib/private/Notification/Action.php

Indentation +142 added lines, -142 removed lines

@@ -28,146 +28,146 @@
 
 class Action implements IAction {
 
-	/** @var string */
-	protected $label;
-
-	/** @var string */
-	protected $labelParsed;
-
-	/** @var string */
-	protected $link;
-
-	/** @var string */
-	protected $requestType;
-
-	/** @var string */
-	protected $icon;
-
-	/** @var bool */
-	protected $primary;
-
-	public function __construct() {
-		$this->label = '';
-		$this->labelParsed = '';
-		$this->link = '';
-		$this->requestType = '';
-		$this->primary = false;
-	}
-
-	/**
-	 * @param string $label
-	 * @return $this
-	 * @throws \InvalidArgumentException if the label is invalid
-	 * @since 8.2.0
-	 */
-	public function setLabel(string $label): IAction {
-		if ($label === '' || isset($label[32])) {
-			throw new \InvalidArgumentException('The given label is invalid');
-		}
-		$this->label = $label;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getLabel(): string {
-		return $this->label;
-	}
-
-	/**
-	 * @param string $label
-	 * @return $this
-	 * @throws \InvalidArgumentException if the label is invalid
-	 * @since 8.2.0
-	 */
-	public function setParsedLabel(string $label): IAction {
-		if ($label === '') {
-			throw new \InvalidArgumentException('The given parsed label is invalid');
-		}
-		$this->labelParsed = $label;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getParsedLabel(): string {
-		return $this->labelParsed;
-	}
-
-	/**
-	 * @param $primary bool
-	 * @return $this
-	 * @since 9.0.0
-	 */
-	public function setPrimary(bool $primary): IAction {
-		$this->primary = $primary;
-		return $this;
-	}
-
-	/**
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function isPrimary(): bool {
-		return $this->primary;
-	}
-
-	/**
-	 * @param string $link
-	 * @param string $requestType
-	 * @return $this
-	 * @throws \InvalidArgumentException if the link is invalid
-	 * @since 8.2.0
-	 */
-	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, [
-			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;
-		$this->requestType = $requestType;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getLink(): string {
-		return $this->link;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getRequestType(): string {
-		return $this->requestType;
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function isValid(): bool {
-		return $this->label !== '' && $this->link !== '';
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function isValidParsed(): bool {
-		return $this->labelParsed !== '' && $this->link !== '';
-	}
+    /** @var string */
+    protected $label;
+
+    /** @var string */
+    protected $labelParsed;
+
+    /** @var string */
+    protected $link;
+
+    /** @var string */
+    protected $requestType;
+
+    /** @var string */
+    protected $icon;
+
+    /** @var bool */
+    protected $primary;
+
+    public function __construct() {
+        $this->label = '';
+        $this->labelParsed = '';
+        $this->link = '';
+        $this->requestType = '';
+        $this->primary = false;
+    }
+
+    /**
+     * @param string $label
+     * @return $this
+     * @throws \InvalidArgumentException if the label is invalid
+     * @since 8.2.0
+     */
+    public function setLabel(string $label): IAction {
+        if ($label === '' || isset($label[32])) {
+            throw new \InvalidArgumentException('The given label is invalid');
+        }
+        $this->label = $label;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getLabel(): string {
+        return $this->label;
+    }
+
+    /**
+     * @param string $label
+     * @return $this
+     * @throws \InvalidArgumentException if the label is invalid
+     * @since 8.2.0
+     */
+    public function setParsedLabel(string $label): IAction {
+        if ($label === '') {
+            throw new \InvalidArgumentException('The given parsed label is invalid');
+        }
+        $this->labelParsed = $label;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getParsedLabel(): string {
+        return $this->labelParsed;
+    }
+
+    /**
+     * @param $primary bool
+     * @return $this
+     * @since 9.0.0
+     */
+    public function setPrimary(bool $primary): IAction {
+        $this->primary = $primary;
+        return $this;
+    }
+
+    /**
+     * @return bool
+     * @since 9.0.0
+     */
+    public function isPrimary(): bool {
+        return $this->primary;
+    }
+
+    /**
+     * @param string $link
+     * @param string $requestType
+     * @return $this
+     * @throws \InvalidArgumentException if the link is invalid
+     * @since 8.2.0
+     */
+    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, [
+            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;
+        $this->requestType = $requestType;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getLink(): string {
+        return $this->link;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getRequestType(): string {
+        return $this->requestType;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isValid(): bool {
+        return $this->label !== '' && $this->link !== '';
+    }
+
+    /**
+     * @return bool
+     */
+    public function isValidParsed(): bool {
+        return $this->labelParsed !== '' && $this->link !== '';
+    }
 }

lib/public/Notification/IApp.php

Indentation +17 added lines, -17 removed lines

@@ -30,23 +30,23 @@
  * @since 9.0.0
  */
 interface IApp {
-	/**
-	 * @param INotification $notification
-	 * @throws \InvalidArgumentException When the notification is not valid
-	 * @since 9.0.0
-	 */
-	public function notify(INotification $notification): void;
+    /**
+     * @param INotification $notification
+     * @throws \InvalidArgumentException When the notification is not valid
+     * @since 9.0.0
+     */
+    public function notify(INotification $notification): void;
 
-	/**
-	 * @param INotification $notification
-	 * @since 9.0.0
-	 */
-	public function markProcessed(INotification $notification): void;
+    /**
+     * @param INotification $notification
+     * @since 9.0.0
+     */
+    public function markProcessed(INotification $notification): void;
 
-	/**
-	 * @param INotification $notification
-	 * @return int
-	 * @since 9.0.0
-	 */
-	public function getCount(INotification $notification): int;
+    /**
+     * @param INotification $notification
+     * @return int
+     * @since 9.0.0
+     */
+    public function getCount(INotification $notification): int;
 }

lib/public/Notification/AlreadyProcessedException.php

Indentation +6 added lines, -6 removed lines

@@ -28,11 +28,11 @@
  */
 class AlreadyProcessedException extends \RuntimeException {
 
-	/**
-	 * @since 17.0.0
-	 */
-	public function __construct() {
-		parent::__construct('Notification is processed already');
-	}
+    /**
+     * @since 17.0.0
+     */
+    public function __construct() {
+        parent::__construct('Notification is processed already');
+    }
 
 }

lib/public/Notification/INotifier.php

Indentation +23 added lines, -23 removed lines

@@ -31,29 +31,29 @@
  */
 interface INotifier {
 
-	/**
-	 * Identifier of the notifier, only use [a-z0-9_]
-	 *
-	 * @return string
-	 * @since 17.0.0
-	 */
-	public function getID(): string;
+    /**
+     * Identifier of the notifier, only use [a-z0-9_]
+     *
+     * @return string
+     * @since 17.0.0
+     */
+    public function getID(): string;
 
-	/**
-	 * Human readable name describing the notifier
-	 *
-	 * @return string
-	 * @since 17.0.0
-	 */
-	public function getName(): string;
+    /**
+     * Human readable name describing the notifier
+     *
+     * @return string
+     * @since 17.0.0
+     */
+    public function getName(): string;
 
-	/**
-	 * @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
-	 * @throws AlreadyProcessedException When the notification is not needed anymore and should be deleted
-	 * @since 9.0.0
-	 */
-	public function prepare(INotification $notification, string $languageCode): INotification;
+    /**
+     * @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
+     * @throws AlreadyProcessedException When the notification is not needed anymore and should be deleted
+     * @since 9.0.0
+     */
+    public function prepare(INotification $notification, string $languageCode): INotification;
 }

lib/public/Notification/INotification.php

Indentation +290 added lines, -290 removed lines

@@ -31,294 +31,294 @@
  * @since 9.0.0
  */
 interface INotification {
-	/**
-	 * @param string $app
-	 * @return $this
-	 * @throws \InvalidArgumentException if the app id is invalid
-	 * @since 9.0.0
-	 */
-	public function setApp(string $app): INotification;
-
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getApp(): string;
-
-	/**
-	 * @param string $user
-	 * @return $this
-	 * @throws \InvalidArgumentException if the user id is invalid
-	 * @since 9.0.0
-	 */
-	public function setUser(string $user): INotification;
-
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getUser(): string;
-
-	/**
-	 * @param \DateTime $dateTime
-	 * @return $this
-	 * @throws \InvalidArgumentException if the $dateTime is invalid
-	 * @since 9.0.0
-	 */
-	public function setDateTime(\DateTime $dateTime): INotification;
-
-	/**
-	 * @return \DateTime
-	 * @since 9.0.0
-	 */
-	public function getDateTime(): \DateTime;
-
-	/**
-	 * @param string $type
-	 * @param string $id
-	 * @return $this
-	 * @throws \InvalidArgumentException if the object type or id is invalid
-	 * @since 9.0.0
-	 */
-	public function setObject(string $type, string $id): INotification;
-
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getObjectType(): string;
-
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getObjectId(): string;
-
-	/**
-	 * @param string $subject
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the subject or parameters are invalid
-	 * @since 9.0.0
-	 */
-	public function setSubject(string $subject, array $parameters = []): INotification;
-
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getSubject(): string;
-
-	/**
-	 * @return array
-	 * @since 9.0.0
-	 */
-	public function getSubjectParameters(): array;
-
-	/**
-	 * Set a parsed subject
-	 *
-	 * HTML is not allowed in the parsed subject and will be escaped
-	 * automatically by the clients. You can use the RichObjectString system
-	 * provided by the Nextcloud server to highlight important parameters via
-	 * the setRichSubject method, but make sure, that a plain text message is
-	 * always set via setParsedSubject, to support clients which can not handle
-	 * rich strings.
-	 *
-	 * See https://github.com/nextcloud/server/issues/1706 for more information.
-	 *
-	 * @param string $subject
-	 * @return $this
-	 * @throws \InvalidArgumentException if the subject is invalid
-	 * @since 9.0.0
-	 */
-	public function setParsedSubject(string $subject): INotification;
-
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getParsedSubject(): string;
-
-	/**
-	 * Set a RichObjectString subject
-	 *
-	 * HTML is not allowed in the rich subject and will be escaped automatically
-	 * by the clients, but you can use the RichObjectString system provided by
-	 * the Nextcloud server to highlight important parameters.
-	 * Also make sure, that a plain text subject is always set via
-	 * setParsedSubject, to support clients which can not handle rich strings.
-	 *
-	 * See https://github.com/nextcloud/server/issues/1706 for more information.
-	 *
-	 * @param string $subject
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the subject or parameters are invalid
-	 * @since 11.0.0
-	 */
-	public function setRichSubject(string $subject, array $parameters = []): INotification;
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getRichSubject(): string;
-
-	/**
-	 * @return array[]
-	 * @since 11.0.0
-	 */
-	public function getRichSubjectParameters(): array;
-
-	/**
-	 * @param string $message
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the message or parameters are invalid
-	 * @since 9.0.0
-	 */
-	public function setMessage(string $message, array $parameters = []): INotification;
-
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getMessage(): string;
-
-	/**
-	 * @return array
-	 * @since 9.0.0
-	 */
-	public function getMessageParameters(): array;
-
-	/**
-	 * Set a parsed message
-	 *
-	 * HTML is not allowed in the parsed message and will be escaped
-	 * automatically by the clients. You can use the RichObjectString system
-	 * provided by the Nextcloud server to highlight important parameters via
-	 * the setRichMessage method, but make sure, that a plain text message is
-	 * always set via setParsedMessage, to support clients which can not handle
-	 * rich strings.
-	 *
-	 * See https://github.com/nextcloud/server/issues/1706 for more information.
-	 *
-	 * @param string $message
-	 * @return $this
-	 * @throws \InvalidArgumentException if the message is invalid
-	 * @since 9.0.0
-	 */
-	public function setParsedMessage(string $message): INotification;
-
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getParsedMessage(): string;
-
-	/**
-	 * Set a RichObjectString message
-	 *
-	 * HTML is not allowed in the rich message and will be escaped automatically
-	 * by the clients, but you can use the RichObjectString system provided by
-	 * the Nextcloud server to highlight important parameters.
-	 * Also make sure, that a plain text message is always set via
-	 * setParsedMessage, to support clients which can not handle rich strings.
-	 *
-	 * See https://github.com/nextcloud/server/issues/1706 for more information.
-	 *
-	 * @param string $message
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the message or parameters are invalid
-	 * @since 11.0.0
-	 */
-	public function setRichMessage(string $message, array $parameters = []): INotification;
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getRichMessage(): string;
-
-	/**
-	 * @return array[]
-	 * @since 11.0.0
-	 */
-	public function getRichMessageParameters(): array;
-
-	/**
-	 * @param string $link
-	 * @return $this
-	 * @throws \InvalidArgumentException if the link is invalid
-	 * @since 9.0.0
-	 */
-	public function setLink(string $link): INotification;
-
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getLink(): string;
-
-	/**
-	 * @param string $icon
-	 * @return $this
-	 * @throws \InvalidArgumentException if the icon is invalid
-	 * @since 11.0.0
-	 */
-	public function setIcon(string $icon): INotification;
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getIcon(): string;
-
-	/**
-	 * @return IAction
-	 * @since 9.0.0
-	 */
-	public function createAction(): IAction;
-
-	/**
-	 * @param IAction $action
-	 * @return $this
-	 * @throws \InvalidArgumentException if the action is invalid
-	 * @since 9.0.0
-	 */
-	public function addAction(IAction $action): INotification;
-
-	/**
-	 * @return IAction[]
-	 * @since 9.0.0
-	 */
-	public function getActions(): array;
-
-	/**
-	 * @param IAction $action
-	 * @return $this
-	 * @throws \InvalidArgumentException if the action is invalid
-	 * @since 9.0.0
-	 */
-	public function addParsedAction(IAction $action): INotification;
-
-	/**
-	 * @return IAction[]
-	 * @since 9.0.0
-	 */
-	public function getParsedActions(): array;
-
-	/**
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function isValid(): bool;
-
-	/**
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function isValidParsed(): bool;
+    /**
+     * @param string $app
+     * @return $this
+     * @throws \InvalidArgumentException if the app id is invalid
+     * @since 9.0.0
+     */
+    public function setApp(string $app): INotification;
+
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getApp(): string;
+
+    /**
+     * @param string $user
+     * @return $this
+     * @throws \InvalidArgumentException if the user id is invalid
+     * @since 9.0.0
+     */
+    public function setUser(string $user): INotification;
+
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getUser(): string;
+
+    /**
+     * @param \DateTime $dateTime
+     * @return $this
+     * @throws \InvalidArgumentException if the $dateTime is invalid
+     * @since 9.0.0
+     */
+    public function setDateTime(\DateTime $dateTime): INotification;
+
+    /**
+     * @return \DateTime
+     * @since 9.0.0
+     */
+    public function getDateTime(): \DateTime;
+
+    /**
+     * @param string $type
+     * @param string $id
+     * @return $this
+     * @throws \InvalidArgumentException if the object type or id is invalid
+     * @since 9.0.0
+     */
+    public function setObject(string $type, string $id): INotification;
+
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getObjectType(): string;
+
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getObjectId(): string;
+
+    /**
+     * @param string $subject
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the subject or parameters are invalid
+     * @since 9.0.0
+     */
+    public function setSubject(string $subject, array $parameters = []): INotification;
+
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getSubject(): string;
+
+    /**
+     * @return array
+     * @since 9.0.0
+     */
+    public function getSubjectParameters(): array;
+
+    /**
+     * Set a parsed subject
+     *
+     * HTML is not allowed in the parsed subject and will be escaped
+     * automatically by the clients. You can use the RichObjectString system
+     * provided by the Nextcloud server to highlight important parameters via
+     * the setRichSubject method, but make sure, that a plain text message is
+     * always set via setParsedSubject, to support clients which can not handle
+     * rich strings.
+     *
+     * See https://github.com/nextcloud/server/issues/1706 for more information.
+     *
+     * @param string $subject
+     * @return $this
+     * @throws \InvalidArgumentException if the subject is invalid
+     * @since 9.0.0
+     */
+    public function setParsedSubject(string $subject): INotification;
+
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getParsedSubject(): string;
+
+    /**
+     * Set a RichObjectString subject
+     *
+     * HTML is not allowed in the rich subject and will be escaped automatically
+     * by the clients, but you can use the RichObjectString system provided by
+     * the Nextcloud server to highlight important parameters.
+     * Also make sure, that a plain text subject is always set via
+     * setParsedSubject, to support clients which can not handle rich strings.
+     *
+     * See https://github.com/nextcloud/server/issues/1706 for more information.
+     *
+     * @param string $subject
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the subject or parameters are invalid
+     * @since 11.0.0
+     */
+    public function setRichSubject(string $subject, array $parameters = []): INotification;
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getRichSubject(): string;
+
+    /**
+     * @return array[]
+     * @since 11.0.0
+     */
+    public function getRichSubjectParameters(): array;
+
+    /**
+     * @param string $message
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the message or parameters are invalid
+     * @since 9.0.0
+     */
+    public function setMessage(string $message, array $parameters = []): INotification;
+
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getMessage(): string;
+
+    /**
+     * @return array
+     * @since 9.0.0
+     */
+    public function getMessageParameters(): array;
+
+    /**
+     * Set a parsed message
+     *
+     * HTML is not allowed in the parsed message and will be escaped
+     * automatically by the clients. You can use the RichObjectString system
+     * provided by the Nextcloud server to highlight important parameters via
+     * the setRichMessage method, but make sure, that a plain text message is
+     * always set via setParsedMessage, to support clients which can not handle
+     * rich strings.
+     *
+     * See https://github.com/nextcloud/server/issues/1706 for more information.
+     *
+     * @param string $message
+     * @return $this
+     * @throws \InvalidArgumentException if the message is invalid
+     * @since 9.0.0
+     */
+    public function setParsedMessage(string $message): INotification;
+
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getParsedMessage(): string;
+
+    /**
+     * Set a RichObjectString message
+     *
+     * HTML is not allowed in the rich message and will be escaped automatically
+     * by the clients, but you can use the RichObjectString system provided by
+     * the Nextcloud server to highlight important parameters.
+     * Also make sure, that a plain text message is always set via
+     * setParsedMessage, to support clients which can not handle rich strings.
+     *
+     * See https://github.com/nextcloud/server/issues/1706 for more information.
+     *
+     * @param string $message
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the message or parameters are invalid
+     * @since 11.0.0
+     */
+    public function setRichMessage(string $message, array $parameters = []): INotification;
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getRichMessage(): string;
+
+    /**
+     * @return array[]
+     * @since 11.0.0
+     */
+    public function getRichMessageParameters(): array;
+
+    /**
+     * @param string $link
+     * @return $this
+     * @throws \InvalidArgumentException if the link is invalid
+     * @since 9.0.0
+     */
+    public function setLink(string $link): INotification;
+
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getLink(): string;
+
+    /**
+     * @param string $icon
+     * @return $this
+     * @throws \InvalidArgumentException if the icon is invalid
+     * @since 11.0.0
+     */
+    public function setIcon(string $icon): INotification;
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getIcon(): string;
+
+    /**
+     * @return IAction
+     * @since 9.0.0
+     */
+    public function createAction(): IAction;
+
+    /**
+     * @param IAction $action
+     * @return $this
+     * @throws \InvalidArgumentException if the action is invalid
+     * @since 9.0.0
+     */
+    public function addAction(IAction $action): INotification;
+
+    /**
+     * @return IAction[]
+     * @since 9.0.0
+     */
+    public function getActions(): array;
+
+    /**
+     * @param IAction $action
+     * @return $this
+     * @throws \InvalidArgumentException if the action is invalid
+     * @since 9.0.0
+     */
+    public function addParsedAction(IAction $action): INotification;
+
+    /**
+     * @return IAction[]
+     * @since 9.0.0
+     */
+    public function getParsedActions(): array;
+
+    /**
+     * @return bool
+     * @since 9.0.0
+     */
+    public function isValid(): bool;
+
+    /**
+     * @return bool
+     * @since 9.0.0
+     */
+    public function isValidParsed(): bool;
 }

apps/lookup_server_connector/lib/UpdateLookupServer.php

Indentation +42 added lines, -42 removed lines

@@ -34,51 +34,51 @@
  * @package OCA\LookupServerConnector
  */
 class UpdateLookupServer {
-	/** @var IConfig */
-	private $config;
-	/** @var IJobList */
-	private $jobList;
+    /** @var IConfig */
+    private $config;
+    /** @var IJobList */
+    private $jobList;
 
-	/**
-	 * @param IJobList $jobList
-	 * @param IConfig $config
-	 */
-	public function __construct(IJobList $jobList,
-								IConfig $config) {
-		$this->config = $config;
-		$this->jobList = $jobList;
-	}
+    /**
+     * @param IJobList $jobList
+     * @param IConfig $config
+     */
+    public function __construct(IJobList $jobList,
+                                IConfig $config) {
+        $this->config = $config;
+        $this->jobList = $jobList;
+    }
 
-	/**
-	 * @param IUser $user
-	 */
-	public function userUpdated(IUser $user): void {
-		if (!$this->shouldUpdateLookupServer()) {
-			return;
-		}
+    /**
+     * @param IUser $user
+     */
+    public function userUpdated(IUser $user): void {
+        if (!$this->shouldUpdateLookupServer()) {
+            return;
+        }
 
-		// Reset retry counter
-		$this->config->deleteUserValue(
-			$user->getUID(),
-			'lookup_server_connector',
-			'update_retries'
-		);
-		$this->jobList->add(RetryJob::class, ['userId' => $user->getUID()]);
-	}
+        // Reset retry counter
+        $this->config->deleteUserValue(
+            $user->getUID(),
+            'lookup_server_connector',
+            'update_retries'
+        );
+        $this->jobList->add(RetryJob::class, ['userId' => $user->getUID()]);
+    }
 
-	/**
-	 * check if we should update the lookup server, we only do it if
-	 *
-	 * + we have an internet connection
-	 * + the lookup server update was not disabled by the admin
-	 * + we have a valid lookup server URL
-	 *
-	 * @return bool
-	 */
-	private function shouldUpdateLookupServer(): bool {
-		return $this->config->getSystemValueBool('has_internet_connection', true) === true &&
-			$this->config->getAppValue('files_sharing', 'lookupServerUploadEnabled', 'yes') === 'yes' &&
-			$this->config->getSystemValueString('lookup_server', 'https://lookup.nextcloud.com') !== '';
-	}
+    /**
+     * check if we should update the lookup server, we only do it if
+     *
+     * + we have an internet connection
+     * + the lookup server update was not disabled by the admin
+     * + we have a valid lookup server URL
+     *
+     * @return bool
+     */
+    private function shouldUpdateLookupServer(): bool {
+        return $this->config->getSystemValueBool('has_internet_connection', true) === true &&
+            $this->config->getAppValue('files_sharing', 'lookupServerUploadEnabled', 'yes') === 'yes' &&
+            $this->config->getSystemValueString('lookup_server', 'https://lookup.nextcloud.com') !== '';
+    }
 
 }