nextcloud / server

apps/comments/lib/Activity/Provider.php

Indentation +240 added lines, -240 removed lines

@@ -36,244 +36,244 @@
 
 class Provider implements IProvider {
 
-	/** @var IFactory */
-	protected $languageFactory;
-
-	/** @var IL10N */
-	protected $l;
-
-	/** @var IURLGenerator */
-	protected $url;
-
-	/** @var ICommentsManager */
-	protected $commentsManager;
-
-	/** @var IUserManager */
-	protected $userManager;
-
-	/** @var IManager */
-	protected $activityManager;
-
-	/** @var string[] */
-	protected $displayNames = [];
-
-	/**
-	 * @param IFactory $languageFactory
-	 * @param IURLGenerator $url
-	 * @param ICommentsManager $commentsManager
-	 * @param IUserManager $userManager
-	 * @param IManager $activityManager
-	 */
-	public function __construct(IFactory $languageFactory, IURLGenerator $url, ICommentsManager $commentsManager, IUserManager $userManager, IManager $activityManager) {
-		$this->languageFactory = $languageFactory;
-		$this->url = $url;
-		$this->commentsManager = $commentsManager;
-		$this->userManager = $userManager;
-		$this->activityManager = $activityManager;
-	}
-
-	/**
-	 * @param string $language
-	 * @param IEvent $event
-	 * @param IEvent|null $previousEvent
-	 * @return IEvent
-	 * @throws \InvalidArgumentException
-	 * @since 11.0.0
-	 */
-	public function parse($language, IEvent $event, IEvent $previousEvent = null) {
-		if ($event->getApp() !== 'comments') {
-			throw new \InvalidArgumentException();
-		}
-
-		$this->l = $this->languageFactory->get('comments', $language);
-
-		if ($event->getSubject() === 'add_comment_subject') {
-			$this->parseMessage($event);
-			if ($this->activityManager->getRequirePNG()) {
-				$event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.png')));
-			} else {
-				$event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.svg')));
-			}
-
-			if ($this->activityManager->isFormattingFilteredObject()) {
-				try {
-					return $this->parseShortVersion($event);
-				} catch (\InvalidArgumentException $e) {
-					// Ignore and simply use the long version...
-				}
-			}
-
-			return $this->parseLongVersion($event);
-		} else {
-			throw new \InvalidArgumentException();
-		}
-	}
-
-	/**
-	 * @param IEvent $event
-	 * @return IEvent
-	 * @throws \InvalidArgumentException
-	 */
-	protected function parseShortVersion(IEvent $event) {
-		$subjectParameters = $this->getSubjectParameters($event);
-
-		if ($event->getSubject() === 'add_comment_subject') {
-			if ($subjectParameters['actor'] === $this->activityManager->getCurrentUserId()) {
-				$event->setParsedSubject($this->l->t('You commented'))
-					->setRichSubject($this->l->t('You commented'), []);
-			} else {
-				$author = $this->generateUserParameter($subjectParameters['actor']);
-				$event->setParsedSubject($this->l->t('%1$s commented', [$author['name']]))
-					->setRichSubject($this->l->t('{author} commented'), [
-						'author' => $author,
-					]);
-			}
-		} else {
-			throw new \InvalidArgumentException();
-		}
-
-		return $event;
-	}
-
-	/**
-	 * @param IEvent $event
-	 * @return IEvent
-	 * @throws \InvalidArgumentException
-	 */
-	protected function parseLongVersion(IEvent $event) {
-		$subjectParameters = $this->getSubjectParameters($event);
-
-		if ($event->getSubject() === 'add_comment_subject') {
-			if ($subjectParameters['actor'] === $this->activityManager->getCurrentUserId()) {
-				$event->setParsedSubject($this->l->t('You commented on %1$s', [
-						$subjectParameters['filePath'],
-					]))
-					->setRichSubject($this->l->t('You commented on {file}'), [
-						'file' => $this->generateFileParameter($subjectParameters['fileId'], $subjectParameters['filePath']),
-					]);
-			} else {
-				$author = $this->generateUserParameter($subjectParameters['actor']);
-				$event->setParsedSubject($this->l->t('%1$s commented on %2$s', [
-						$author['name'],
-						$subjectParameters['filePath'],
-					]))
-					->setRichSubject($this->l->t('{author} commented on {file}'), [
-						'author' => $author,
-						'file' => $this->generateFileParameter($subjectParameters['fileId'], $subjectParameters['filePath']),
-					]);
-			}
-		} else {
-			throw new \InvalidArgumentException();
-		}
-
-		return $event;
-	}
-
-	protected function getSubjectParameters(IEvent $event) {
-		$subjectParameters = $event->getSubjectParameters();
-		if (isset($subjectParameters['fileId'])) {
-			return $subjectParameters;
-		}
-
-		// Fix subjects from 12.0.3 and older
-		//
-		// Do NOT Remove unless necessary
-		// Removing this will break parsing of activities that were created on
-		// Nextcloud 12, so we should keep this as long as it's acceptable.
-		// Otherwise if people upgrade over multiple releases in a short period,
-		// they will get the dead entries in their stream.
-		return [
-			'actor' => $subjectParameters[0],
-			'fileId' => (int) $event->getObjectId(),
-			'filePath' => trim($subjectParameters[1], '/'),
-		];
-	}
-
-	/**
-	 * @param IEvent $event
-	 */
-	protected function parseMessage(IEvent $event) {
-		$messageParameters = $event->getMessageParameters();
-		if (empty($messageParameters)) {
-			// Email
-			return;
-		}
-
-		$commentId = isset($messageParameters['commentId']) ? $messageParameters['commentId'] : $messageParameters[0];
-
-		try {
-			$comment = $this->commentsManager->get((string) $commentId);
-			$message = $comment->getMessage();
-
-			$mentionCount = 1;
-			$mentions = [];
-			foreach ($comment->getMentions() as $mention) {
-				if ($mention['type'] !== 'user') {
-					continue;
-				}
-
-				$pattern = '/(^|\s)(' . '@' . $mention['id'] . ')(\b)/';
-				if (strpos($mention['id'], ' ') !== false) {
-					$pattern = '/(^|\s)(' . '@"' . $mention['id'] . '"' . ')(\b)?/';
-				}
-
-				$message = preg_replace(
-					$pattern,
-					//'${1}' . $this->regexSafeUser($mention['id'], $displayName) . '${3}',
-					'${1}' . '{mention' . $mentionCount . '}' . '${3}',
-					$message
-				);
-				$mentions['mention' . $mentionCount] = $this->generateUserParameter($mention['id']);
-				$mentionCount++;
-			}
-
-			$event->setParsedMessage($comment->getMessage())
-				->setRichMessage($message, $mentions);
-		} catch (NotFoundException $e) {
-		}
-	}
-
-	/**
-	 * @param int $id
-	 * @param string $path
-	 * @return array
-	 */
-	protected function generateFileParameter($id, $path) {
-		return [
-			'type' => 'file',
-			'id' => $id,
-			'name' => basename($path),
-			'path' => $path,
-			'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $id]),
-		];
-	}
-
-	/**
-	 * @param string $uid
-	 * @return array
-	 */
-	protected function generateUserParameter($uid) {
-		if (!isset($this->displayNames[$uid])) {
-			$this->displayNames[$uid] = $this->getDisplayName($uid);
-		}
-
-		return [
-			'type' => 'user',
-			'id' => $uid,
-			'name' => $this->displayNames[$uid],
-		];
-	}
-
-	/**
-	 * @param string $uid
-	 * @return string
-	 */
-	protected function getDisplayName($uid) {
-		$user = $this->userManager->get($uid);
-		if ($user instanceof IUser) {
-			return $user->getDisplayName();
-		} else {
-			return $uid;
-		}
-	}
+    /** @var IFactory */
+    protected $languageFactory;
+
+    /** @var IL10N */
+    protected $l;
+
+    /** @var IURLGenerator */
+    protected $url;
+
+    /** @var ICommentsManager */
+    protected $commentsManager;
+
+    /** @var IUserManager */
+    protected $userManager;
+
+    /** @var IManager */
+    protected $activityManager;
+
+    /** @var string[] */
+    protected $displayNames = [];
+
+    /**
+     * @param IFactory $languageFactory
+     * @param IURLGenerator $url
+     * @param ICommentsManager $commentsManager
+     * @param IUserManager $userManager
+     * @param IManager $activityManager
+     */
+    public function __construct(IFactory $languageFactory, IURLGenerator $url, ICommentsManager $commentsManager, IUserManager $userManager, IManager $activityManager) {
+        $this->languageFactory = $languageFactory;
+        $this->url = $url;
+        $this->commentsManager = $commentsManager;
+        $this->userManager = $userManager;
+        $this->activityManager = $activityManager;
+    }
+
+    /**
+     * @param string $language
+     * @param IEvent $event
+     * @param IEvent|null $previousEvent
+     * @return IEvent
+     * @throws \InvalidArgumentException
+     * @since 11.0.0
+     */
+    public function parse($language, IEvent $event, IEvent $previousEvent = null) {
+        if ($event->getApp() !== 'comments') {
+            throw new \InvalidArgumentException();
+        }
+
+        $this->l = $this->languageFactory->get('comments', $language);
+
+        if ($event->getSubject() === 'add_comment_subject') {
+            $this->parseMessage($event);
+            if ($this->activityManager->getRequirePNG()) {
+                $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.png')));
+            } else {
+                $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.svg')));
+            }
+
+            if ($this->activityManager->isFormattingFilteredObject()) {
+                try {
+                    return $this->parseShortVersion($event);
+                } catch (\InvalidArgumentException $e) {
+                    // Ignore and simply use the long version...
+                }
+            }
+
+            return $this->parseLongVersion($event);
+        } else {
+            throw new \InvalidArgumentException();
+        }
+    }
+
+    /**
+     * @param IEvent $event
+     * @return IEvent
+     * @throws \InvalidArgumentException
+     */
+    protected function parseShortVersion(IEvent $event) {
+        $subjectParameters = $this->getSubjectParameters($event);
+
+        if ($event->getSubject() === 'add_comment_subject') {
+            if ($subjectParameters['actor'] === $this->activityManager->getCurrentUserId()) {
+                $event->setParsedSubject($this->l->t('You commented'))
+                    ->setRichSubject($this->l->t('You commented'), []);
+            } else {
+                $author = $this->generateUserParameter($subjectParameters['actor']);
+                $event->setParsedSubject($this->l->t('%1$s commented', [$author['name']]))
+                    ->setRichSubject($this->l->t('{author} commented'), [
+                        'author' => $author,
+                    ]);
+            }
+        } else {
+            throw new \InvalidArgumentException();
+        }
+
+        return $event;
+    }
+
+    /**
+     * @param IEvent $event
+     * @return IEvent
+     * @throws \InvalidArgumentException
+     */
+    protected function parseLongVersion(IEvent $event) {
+        $subjectParameters = $this->getSubjectParameters($event);
+
+        if ($event->getSubject() === 'add_comment_subject') {
+            if ($subjectParameters['actor'] === $this->activityManager->getCurrentUserId()) {
+                $event->setParsedSubject($this->l->t('You commented on %1$s', [
+                        $subjectParameters['filePath'],
+                    ]))
+                    ->setRichSubject($this->l->t('You commented on {file}'), [
+                        'file' => $this->generateFileParameter($subjectParameters['fileId'], $subjectParameters['filePath']),
+                    ]);
+            } else {
+                $author = $this->generateUserParameter($subjectParameters['actor']);
+                $event->setParsedSubject($this->l->t('%1$s commented on %2$s', [
+                        $author['name'],
+                        $subjectParameters['filePath'],
+                    ]))
+                    ->setRichSubject($this->l->t('{author} commented on {file}'), [
+                        'author' => $author,
+                        'file' => $this->generateFileParameter($subjectParameters['fileId'], $subjectParameters['filePath']),
+                    ]);
+            }
+        } else {
+            throw new \InvalidArgumentException();
+        }
+
+        return $event;
+    }
+
+    protected function getSubjectParameters(IEvent $event) {
+        $subjectParameters = $event->getSubjectParameters();
+        if (isset($subjectParameters['fileId'])) {
+            return $subjectParameters;
+        }
+
+        // Fix subjects from 12.0.3 and older
+        //
+        // Do NOT Remove unless necessary
+        // Removing this will break parsing of activities that were created on
+        // Nextcloud 12, so we should keep this as long as it's acceptable.
+        // Otherwise if people upgrade over multiple releases in a short period,
+        // they will get the dead entries in their stream.
+        return [
+            'actor' => $subjectParameters[0],
+            'fileId' => (int) $event->getObjectId(),
+            'filePath' => trim($subjectParameters[1], '/'),
+        ];
+    }
+
+    /**
+     * @param IEvent $event
+     */
+    protected function parseMessage(IEvent $event) {
+        $messageParameters = $event->getMessageParameters();
+        if (empty($messageParameters)) {
+            // Email
+            return;
+        }
+
+        $commentId = isset($messageParameters['commentId']) ? $messageParameters['commentId'] : $messageParameters[0];
+
+        try {
+            $comment = $this->commentsManager->get((string) $commentId);
+            $message = $comment->getMessage();
+
+            $mentionCount = 1;
+            $mentions = [];
+            foreach ($comment->getMentions() as $mention) {
+                if ($mention['type'] !== 'user') {
+                    continue;
+                }
+
+                $pattern = '/(^|\s)(' . '@' . $mention['id'] . ')(\b)/';
+                if (strpos($mention['id'], ' ') !== false) {
+                    $pattern = '/(^|\s)(' . '@"' . $mention['id'] . '"' . ')(\b)?/';
+                }
+
+                $message = preg_replace(
+                    $pattern,
+                    //'${1}' . $this->regexSafeUser($mention['id'], $displayName) . '${3}',
+                    '${1}' . '{mention' . $mentionCount . '}' . '${3}',
+                    $message
+                );
+                $mentions['mention' . $mentionCount] = $this->generateUserParameter($mention['id']);
+                $mentionCount++;
+            }
+
+            $event->setParsedMessage($comment->getMessage())
+                ->setRichMessage($message, $mentions);
+        } catch (NotFoundException $e) {
+        }
+    }
+
+    /**
+     * @param int $id
+     * @param string $path
+     * @return array
+     */
+    protected function generateFileParameter($id, $path) {
+        return [
+            'type' => 'file',
+            'id' => $id,
+            'name' => basename($path),
+            'path' => $path,
+            'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $id]),
+        ];
+    }
+
+    /**
+     * @param string $uid
+     * @return array
+     */
+    protected function generateUserParameter($uid) {
+        if (!isset($this->displayNames[$uid])) {
+            $this->displayNames[$uid] = $this->getDisplayName($uid);
+        }
+
+        return [
+            'type' => 'user',
+            'id' => $uid,
+            'name' => $this->displayNames[$uid],
+        ];
+    }
+
+    /**
+     * @param string $uid
+     * @return string
+     */
+    protected function getDisplayName($uid) {
+        $user = $this->userManager->get($uid);
+        if ($user instanceof IUser) {
+            return $user->getDisplayName();
+        } else {
+            return $uid;
+        }
+    }
 }

lib/public/Activity/IEvent.php

Indentation +322 added lines, -322 removed lines

@@ -38,326 +38,326 @@
  * @since 8.2.0
  */
 interface IEvent {
-	/**
-	 * Set the app of the activity
-	 *
-	 * @param string $app
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the app id is invalid
-	 * @since 8.2.0
-	 */
-	public function setApp(string $app): self;
-
-	/**
-	 * Set the type of the activity
-	 *
-	 * @param string $type
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the type is invalid
-	 * @since 8.2.0
-	 */
-	public function setType(string $type): self;
-
-	/**
-	 * Set the affected user of the activity
-	 *
-	 * @param string $user
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the affected user is invalid
-	 * @since 8.2.0
-	 */
-	public function setAffectedUser(string $user): self;
-
-	/**
-	 * Set the author of the activity
-	 *
-	 * @param string $author
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the author is invalid
-	 * @since 8.2.0
-	 */
-	public function setAuthor(string $author): self;
-
-	/**
-	 * Set the author of the activity
-	 *
-	 * @param int $timestamp
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the timestamp is invalid
-	 * @since 8.2.0
-	 */
-	public function setTimestamp(int $timestamp): self;
-
-	/**
-	 * Set the subject of the activity
-	 *
-	 * @param string $subject
-	 * @param array $parameters
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the subject or parameters are invalid
-	 * @since 8.2.0
-	 */
-	public function setSubject(string $subject, array $parameters = []): self;
-
-	/**
-	 * 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 11.0.0
-	 */
-	public function setParsedSubject(string $subject): self;
-
-	/**
-	 * @return string
-	 * @since 11.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 = []): self;
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getRichSubject(): string;
-
-	/**
-	 * @return array[]
-	 * @since 11.0.0
-	 */
-	public function getRichSubjectParameters(): array;
-
-	/**
-	 * Set the message of the activity
-	 *
-	 * @param string $message
-	 * @param array $parameters
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the message or parameters are invalid
-	 * @since 8.2.0
-	 */
-	public function setMessage(string $message, array $parameters = []): self;
-
-	/**
-	 * 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 11.0.0
-	 */
-	public function setParsedMessage(string $message): self;
-
-	/**
-	 * @return string
-	 * @since 11.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 = []): self;
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getRichMessage(): string;
-
-	/**
-	 * @return array[]
-	 * @since 11.0.0
-	 */
-	public function getRichMessageParameters(): array;
-
-	/**
-	 * Set the object of the activity
-	 *
-	 * @param string $objectType
-	 * @param int $objectId
-	 * @param string $objectName
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the object is invalid
-	 * @since 8.2.0
-	 */
-	public function setObject(string $objectType, int $objectId, string $objectName = ''): self;
-
-	/**
-	 * Set the link of the activity
-	 *
-	 * @param string $link
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the link is invalid
-	 * @since 8.2.0
-	 */
-	public function setLink(string $link): self;
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getApp(): string;
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getType(): string;
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getAffectedUser(): string;
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getAuthor(): string;
-
-	/**
-	 * @return int
-	 * @since 8.2.0
-	 */
-	public function getTimestamp(): int;
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getSubject(): string;
-
-	/**
-	 * @return array
-	 * @since 8.2.0
-	 */
-	public function getSubjectParameters(): array;
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getMessage(): string;
-
-	/**
-	 * @return array
-	 * @since 8.2.0
-	 */
-	public function getMessageParameters(): array;
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getObjectType(): string;
-
-	/**
-	 * @return int
-	 * @since 8.2.0
-	 */
-	public function getObjectId(): int;
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getObjectName(): string;
-
-	/**
-	 * @return string
-	 * @since 8.2.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): self;
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getIcon(): string;
-
-	/**
-	 * @param IEvent $child
-	 * @return $this
-	 * @since 11.0.0 - Since 15.0.0 returns $this
-	 */
-	public function setChildEvent(IEvent $child): self;
-
-	/**
-	 * @return IEvent|null
-	 * @since 11.0.0
-	 */
-	public function getChildEvent();
-
-	/**
-	 * @return bool
-	 * @since 11.0.0
-	 */
-	public function isValid(): bool;
-
-	/**
-	 * @return bool
-	 * @since 11.0.0
-	 */
-	public function isValidParsed(): bool;
+    /**
+     * Set the app of the activity
+     *
+     * @param string $app
+     * @return IEvent
+     * @throws \InvalidArgumentException if the app id is invalid
+     * @since 8.2.0
+     */
+    public function setApp(string $app): self;
+
+    /**
+     * Set the type of the activity
+     *
+     * @param string $type
+     * @return IEvent
+     * @throws \InvalidArgumentException if the type is invalid
+     * @since 8.2.0
+     */
+    public function setType(string $type): self;
+
+    /**
+     * Set the affected user of the activity
+     *
+     * @param string $user
+     * @return IEvent
+     * @throws \InvalidArgumentException if the affected user is invalid
+     * @since 8.2.0
+     */
+    public function setAffectedUser(string $user): self;
+
+    /**
+     * Set the author of the activity
+     *
+     * @param string $author
+     * @return IEvent
+     * @throws \InvalidArgumentException if the author is invalid
+     * @since 8.2.0
+     */
+    public function setAuthor(string $author): self;
+
+    /**
+     * Set the author of the activity
+     *
+     * @param int $timestamp
+     * @return IEvent
+     * @throws \InvalidArgumentException if the timestamp is invalid
+     * @since 8.2.0
+     */
+    public function setTimestamp(int $timestamp): self;
+
+    /**
+     * Set the subject of the activity
+     *
+     * @param string $subject
+     * @param array $parameters
+     * @return IEvent
+     * @throws \InvalidArgumentException if the subject or parameters are invalid
+     * @since 8.2.0
+     */
+    public function setSubject(string $subject, array $parameters = []): self;
+
+    /**
+     * 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 11.0.0
+     */
+    public function setParsedSubject(string $subject): self;
+
+    /**
+     * @return string
+     * @since 11.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 = []): self;
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getRichSubject(): string;
+
+    /**
+     * @return array[]
+     * @since 11.0.0
+     */
+    public function getRichSubjectParameters(): array;
+
+    /**
+     * Set the message of the activity
+     *
+     * @param string $message
+     * @param array $parameters
+     * @return IEvent
+     * @throws \InvalidArgumentException if the message or parameters are invalid
+     * @since 8.2.0
+     */
+    public function setMessage(string $message, array $parameters = []): self;
+
+    /**
+     * 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 11.0.0
+     */
+    public function setParsedMessage(string $message): self;
+
+    /**
+     * @return string
+     * @since 11.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 = []): self;
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getRichMessage(): string;
+
+    /**
+     * @return array[]
+     * @since 11.0.0
+     */
+    public function getRichMessageParameters(): array;
+
+    /**
+     * Set the object of the activity
+     *
+     * @param string $objectType
+     * @param int $objectId
+     * @param string $objectName
+     * @return IEvent
+     * @throws \InvalidArgumentException if the object is invalid
+     * @since 8.2.0
+     */
+    public function setObject(string $objectType, int $objectId, string $objectName = ''): self;
+
+    /**
+     * Set the link of the activity
+     *
+     * @param string $link
+     * @return IEvent
+     * @throws \InvalidArgumentException if the link is invalid
+     * @since 8.2.0
+     */
+    public function setLink(string $link): self;
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getApp(): string;
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getType(): string;
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getAffectedUser(): string;
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getAuthor(): string;
+
+    /**
+     * @return int
+     * @since 8.2.0
+     */
+    public function getTimestamp(): int;
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getSubject(): string;
+
+    /**
+     * @return array
+     * @since 8.2.0
+     */
+    public function getSubjectParameters(): array;
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getMessage(): string;
+
+    /**
+     * @return array
+     * @since 8.2.0
+     */
+    public function getMessageParameters(): array;
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getObjectType(): string;
+
+    /**
+     * @return int
+     * @since 8.2.0
+     */
+    public function getObjectId(): int;
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getObjectName(): string;
+
+    /**
+     * @return string
+     * @since 8.2.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): self;
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getIcon(): string;
+
+    /**
+     * @param IEvent $child
+     * @return $this
+     * @since 11.0.0 - Since 15.0.0 returns $this
+     */
+    public function setChildEvent(IEvent $child): self;
+
+    /**
+     * @return IEvent|null
+     * @since 11.0.0
+     */
+    public function getChildEvent();
+
+    /**
+     * @return bool
+     * @since 11.0.0
+     */
+    public function isValid(): bool;
+
+    /**
+     * @return bool
+     * @since 11.0.0
+     */
+    public function isValidParsed(): bool;
 }

lib/public/Notification/INotification.php

Indentation +290 added lines, -290 removed lines

@@ -30,294 +30,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($app);
-
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getApp();
-
-	/**
-	 * @param string $user
-	 * @return $this
-	 * @throws \InvalidArgumentException if the user id is invalid
-	 * @since 9.0.0
-	 */
-	public function setUser($user);
-
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getUser();
-
-	/**
-	 * @param \DateTime $dateTime
-	 * @return $this
-	 * @throws \InvalidArgumentException if the $dateTime is invalid
-	 * @since 9.0.0
-	 */
-	public function setDateTime(\DateTime $dateTime);
-
-	/**
-	 * @return \DateTime
-	 * @since 9.0.0
-	 */
-	public function getDateTime();
-
-	/**
-	 * @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($type, $id);
-
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getObjectType();
-
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getObjectId();
-
-	/**
-	 * @param string $subject
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the subject or parameters are invalid
-	 * @since 9.0.0
-	 */
-	public function setSubject($subject, array $parameters = []);
-
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getSubject();
-
-	/**
-	 * @return string[]
-	 * @since 9.0.0
-	 */
-	public function getSubjectParameters();
-
-	/**
-	 * 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($subject);
-
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getParsedSubject();
-
-	/**
-	 * 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($subject, array $parameters = []);
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getRichSubject();
-
-	/**
-	 * @return array[]
-	 * @since 11.0.0
-	 */
-	public function getRichSubjectParameters();
-
-	/**
-	 * @param string $message
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the message or parameters are invalid
-	 * @since 9.0.0
-	 */
-	public function setMessage($message, array $parameters = []);
-
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getMessage();
-
-	/**
-	 * @return string[]
-	 * @since 9.0.0
-	 */
-	public function getMessageParameters();
-
-	/**
-	 * 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($message);
-
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getParsedMessage();
-
-	/**
-	 * 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($message, array $parameters = []);
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getRichMessage();
-
-	/**
-	 * @return array[]
-	 * @since 11.0.0
-	 */
-	public function getRichMessageParameters();
-
-	/**
-	 * @param string $link
-	 * @return $this
-	 * @throws \InvalidArgumentException if the link is invalid
-	 * @since 9.0.0
-	 */
-	public function setLink($link);
-
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getLink();
-
-	/**
-	 * @param string $icon
-	 * @return $this
-	 * @throws \InvalidArgumentException if the icon is invalid
-	 * @since 11.0.0
-	 */
-	public function setIcon($icon);
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getIcon();
-
-	/**
-	 * @return IAction
-	 * @since 9.0.0
-	 */
-	public function createAction();
-
-	/**
-	 * @param IAction $action
-	 * @return $this
-	 * @throws \InvalidArgumentException if the action is invalid
-	 * @since 9.0.0
-	 */
-	public function addAction(IAction $action);
-
-	/**
-	 * @return IAction[]
-	 * @since 9.0.0
-	 */
-	public function getActions();
-
-	/**
-	 * @param IAction $action
-	 * @return $this
-	 * @throws \InvalidArgumentException if the action is invalid
-	 * @since 9.0.0
-	 */
-	public function addParsedAction(IAction $action);
-
-	/**
-	 * @return IAction[]
-	 * @since 9.0.0
-	 */
-	public function getParsedActions();
-
-	/**
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function isValid();
-
-	/**
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function isValidParsed();
+    /**
+     * @param string $app
+     * @return $this
+     * @throws \InvalidArgumentException if the app id is invalid
+     * @since 9.0.0
+     */
+    public function setApp($app);
+
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getApp();
+
+    /**
+     * @param string $user
+     * @return $this
+     * @throws \InvalidArgumentException if the user id is invalid
+     * @since 9.0.0
+     */
+    public function setUser($user);
+
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getUser();
+
+    /**
+     * @param \DateTime $dateTime
+     * @return $this
+     * @throws \InvalidArgumentException if the $dateTime is invalid
+     * @since 9.0.0
+     */
+    public function setDateTime(\DateTime $dateTime);
+
+    /**
+     * @return \DateTime
+     * @since 9.0.0
+     */
+    public function getDateTime();
+
+    /**
+     * @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($type, $id);
+
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getObjectType();
+
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getObjectId();
+
+    /**
+     * @param string $subject
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the subject or parameters are invalid
+     * @since 9.0.0
+     */
+    public function setSubject($subject, array $parameters = []);
+
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getSubject();
+
+    /**
+     * @return string[]
+     * @since 9.0.0
+     */
+    public function getSubjectParameters();
+
+    /**
+     * 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($subject);
+
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getParsedSubject();
+
+    /**
+     * 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($subject, array $parameters = []);
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getRichSubject();
+
+    /**
+     * @return array[]
+     * @since 11.0.0
+     */
+    public function getRichSubjectParameters();
+
+    /**
+     * @param string $message
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the message or parameters are invalid
+     * @since 9.0.0
+     */
+    public function setMessage($message, array $parameters = []);
+
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getMessage();
+
+    /**
+     * @return string[]
+     * @since 9.0.0
+     */
+    public function getMessageParameters();
+
+    /**
+     * 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($message);
+
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getParsedMessage();
+
+    /**
+     * 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($message, array $parameters = []);
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getRichMessage();
+
+    /**
+     * @return array[]
+     * @since 11.0.0
+     */
+    public function getRichMessageParameters();
+
+    /**
+     * @param string $link
+     * @return $this
+     * @throws \InvalidArgumentException if the link is invalid
+     * @since 9.0.0
+     */
+    public function setLink($link);
+
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getLink();
+
+    /**
+     * @param string $icon
+     * @return $this
+     * @throws \InvalidArgumentException if the icon is invalid
+     * @since 11.0.0
+     */
+    public function setIcon($icon);
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getIcon();
+
+    /**
+     * @return IAction
+     * @since 9.0.0
+     */
+    public function createAction();
+
+    /**
+     * @param IAction $action
+     * @return $this
+     * @throws \InvalidArgumentException if the action is invalid
+     * @since 9.0.0
+     */
+    public function addAction(IAction $action);
+
+    /**
+     * @return IAction[]
+     * @since 9.0.0
+     */
+    public function getActions();
+
+    /**
+     * @param IAction $action
+     * @return $this
+     * @throws \InvalidArgumentException if the action is invalid
+     * @since 9.0.0
+     */
+    public function addParsedAction(IAction $action);
+
+    /**
+     * @return IAction[]
+     * @since 9.0.0
+     */
+    public function getParsedActions();
+
+    /**
+     * @return bool
+     * @since 9.0.0
+     */
+    public function isValid();
+
+    /**
+     * @return bool
+     * @since 9.0.0
+     */
+    public function isValidParsed();
 }