nextcloud / server

lib/private/Authentication/Token/IWipeableToken.php

Indentation +4 added lines, -4 removed lines

@@ -26,9 +26,9 @@
 
 interface IWipeableToken extends IToken {
 
-	/**
-	 * Mark the token for remote wipe
-	 */
-	public function wipe(): void;
+    /**
+     * Mark the token for remote wipe
+     */
+    public function wipe(): void;
 
 }

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/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/IAction.php

Indentation +84 added lines, -84 removed lines

@@ -31,99 +31,99 @@
  */
 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';
+    /**
+     * @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(string $label): IAction;
+    /**
+     * @param string $label
+     * @return $this
+     * @throws \InvalidArgumentException if the label is invalid
+     * @since 9.0.0
+     */
+    public function setLabel(string $label): IAction;
 
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getLabel(): string;
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getLabel(): string;
 
-	/**
-	 * @param string $label
-	 * @return $this
-	 * @throws \InvalidArgumentException if the label is invalid
-	 * @since 9.0.0
-	 */
-	public function setParsedLabel(string $label): IAction;
+    /**
+     * @param string $label
+     * @return $this
+     * @throws \InvalidArgumentException if the label is invalid
+     * @since 9.0.0
+     */
+    public function setParsedLabel(string $label): IAction;
 
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getParsedLabel(): string;
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getParsedLabel(): string;
 
-	/**
-	 * @param bool $primary
-	 * @return $this
-	 * @throws \InvalidArgumentException if $primary is invalid
-	 * @since 9.0.0
-	 */
-	public function setPrimary(bool $primary): IAction;
+    /**
+     * @param bool $primary
+     * @return $this
+     * @throws \InvalidArgumentException if $primary is invalid
+     * @since 9.0.0
+     */
+    public function setPrimary(bool $primary): IAction;
 
-	/**
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function isPrimary(): bool;
+    /**
+     * @return bool
+     * @since 9.0.0
+     */
+    public function isPrimary(): bool;
 
-	/**
-	 * @param string $link
-	 * @param string $requestType
-	 * @return $this
-	 * @throws \InvalidArgumentException if the link is invalid
-	 * @since 9.0.0
-	 */
-	public function setLink(string $link, string $requestType): IAction;
+    /**
+     * @param string $link
+     * @param string $requestType
+     * @return $this
+     * @throws \InvalidArgumentException if the link is invalid
+     * @since 9.0.0
+     */
+    public function setLink(string $link, string $requestType): IAction;
 
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getLink(): string;
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getLink(): string;
 
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getRequestType(): string;
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getRequestType(): string;
 
-	/**
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function isValid(): bool;
+    /**
+     * @return bool
+     * @since 9.0.0
+     */
+    public function isValid(): bool;
 
-	/**
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function isValidParsed(): bool;
+    /**
+     * @return bool
+     * @since 9.0.0
+     */
+    public function isValidParsed(): bool;
 }

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') !== '';
+    }
 
 }