fix(activity): Improved activity exceptionspull/44915/head
@@ -14,6 +14,11 @@ return array( | |||
'OCP\\Accounts\\PropertyDoesNotExistException' => $baseDir . '/lib/public/Accounts/PropertyDoesNotExistException.php', | |||
'OCP\\Accounts\\UserUpdatedEvent' => $baseDir . '/lib/public/Accounts/UserUpdatedEvent.php', | |||
'OCP\\Activity\\ActivitySettings' => $baseDir . '/lib/public/Activity/ActivitySettings.php', | |||
'OCP\\Activity\\Exceptions\\FilterNotFoundException' => $baseDir . '/lib/public/Activity/Exceptions/FilterNotFoundException.php', | |||
'OCP\\Activity\\Exceptions\\IncompleteActivityException' => $baseDir . '/lib/public/Activity/Exceptions/IncompleteActivityException.php', | |||
'OCP\\Activity\\Exceptions\\InvalidValueException' => $baseDir . '/lib/public/Activity/Exceptions/InvalidValueException.php', | |||
'OCP\\Activity\\Exceptions\\SettingNotFoundException' => $baseDir . '/lib/public/Activity/Exceptions/SettingNotFoundException.php', | |||
'OCP\\Activity\\Exceptions\\UnknownActivityException' => $baseDir . '/lib/public/Activity/Exceptions/UnknownActivityException.php', | |||
'OCP\\Activity\\IConsumer' => $baseDir . '/lib/public/Activity/IConsumer.php', | |||
'OCP\\Activity\\IEvent' => $baseDir . '/lib/public/Activity/IEvent.php', | |||
'OCP\\Activity\\IEventMerger' => $baseDir . '/lib/public/Activity/IEventMerger.php', |
@@ -47,6 +47,11 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2 | |||
'OCP\\Accounts\\PropertyDoesNotExistException' => __DIR__ . '/../../..' . '/lib/public/Accounts/PropertyDoesNotExistException.php', | |||
'OCP\\Accounts\\UserUpdatedEvent' => __DIR__ . '/../../..' . '/lib/public/Accounts/UserUpdatedEvent.php', | |||
'OCP\\Activity\\ActivitySettings' => __DIR__ . '/../../..' . '/lib/public/Activity/ActivitySettings.php', | |||
'OCP\\Activity\\Exceptions\\FilterNotFoundException' => __DIR__ . '/../../..' . '/lib/public/Activity/Exceptions/FilterNotFoundException.php', | |||
'OCP\\Activity\\Exceptions\\IncompleteActivityException' => __DIR__ . '/../../..' . '/lib/public/Activity/Exceptions/IncompleteActivityException.php', | |||
'OCP\\Activity\\Exceptions\\InvalidValueException' => __DIR__ . '/../../..' . '/lib/public/Activity/Exceptions/InvalidValueException.php', | |||
'OCP\\Activity\\Exceptions\\SettingNotFoundException' => __DIR__ . '/../../..' . '/lib/public/Activity/Exceptions/SettingNotFoundException.php', | |||
'OCP\\Activity\\Exceptions\\UnknownActivityException' => __DIR__ . '/../../..' . '/lib/public/Activity/Exceptions/UnknownActivityException.php', | |||
'OCP\\Activity\\IConsumer' => __DIR__ . '/../../..' . '/lib/public/Activity/IConsumer.php', | |||
'OCP\\Activity\\IEvent' => __DIR__ . '/../../..' . '/lib/public/Activity/IEvent.php', | |||
'OCP\\Activity\\IEventMerger' => __DIR__ . '/../../..' . '/lib/public/Activity/IEventMerger.php', | |||
@@ -1171,6 +1176,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2 | |||
'OC\\Core\\Command\\User\\AuthTokens\\Add' => __DIR__ . '/../../..' . '/core/Command/User/AuthTokens/Add.php', | |||
'OC\\Core\\Command\\User\\AuthTokens\\Delete' => __DIR__ . '/../../..' . '/core/Command/User/AuthTokens/Delete.php', | |||
'OC\\Core\\Command\\User\\AuthTokens\\ListCommand' => __DIR__ . '/../../..' . '/core/Command/User/AuthTokens/ListCommand.php', | |||
'OC\\Core\\Command\\User\\ClearGeneratedAvatarCacheCommand' => __DIR__ . '/../../..' . '/core/Command/User/ClearGeneratedAvatarCacheCommand.php', | |||
'OC\\Core\\Command\\User\\Delete' => __DIR__ . '/../../..' . '/core/Command/User/Delete.php', | |||
'OC\\Core\\Command\\User\\Disable' => __DIR__ . '/../../..' . '/core/Command/User/Disable.php', | |||
'OC\\Core\\Command\\User\\Enable' => __DIR__ . '/../../..' . '/core/Command/User/Enable.php', |
@@ -28,6 +28,7 @@ declare(strict_types=1); | |||
*/ | |||
namespace OC\Activity; | |||
use OCP\Activity\Exceptions\InvalidValueException; | |||
use OCP\Activity\IEvent; | |||
use OCP\RichObjectStrings\InvalidObjectExeption; | |||
use OCP\RichObjectStrings\IValidator; | |||
@@ -89,16 +90,11 @@ class Event implements IEvent { | |||
} | |||
/** | |||
* Set the app of the activity | |||
* | |||
* @param string $app | |||
* @return IEvent | |||
* @throws \InvalidArgumentException if the app id is invalid | |||
* @since 8.2.0 | |||
* {@inheritDoc} | |||
*/ | |||
public function setApp(string $app): IEvent { | |||
if ($app === '' || isset($app[32])) { | |||
throw new \InvalidArgumentException('The given app is invalid'); | |||
throw new InvalidValueException('app'); | |||
} | |||
$this->app = $app; | |||
return $this; | |||
@@ -112,16 +108,11 @@ class Event implements IEvent { | |||
} | |||
/** | |||
* Set the type of the activity | |||
* | |||
* @param string $type | |||
* @return IEvent | |||
* @throws \InvalidArgumentException if the type is invalid | |||
* @since 8.2.0 | |||
* {@inheritDoc} | |||
*/ | |||
public function setType(string $type): IEvent { | |||
if ($type === '' || isset($type[255])) { | |||
throw new \InvalidArgumentException('The given type is invalid'); | |||
throw new InvalidValueException('type'); | |||
} | |||
$this->type = $type; | |||
return $this; | |||
@@ -135,16 +126,11 @@ class Event implements IEvent { | |||
} | |||
/** | |||
* Set the affected user of the activity | |||
* | |||
* @param string $affectedUser | |||
* @return IEvent | |||
* @throws \InvalidArgumentException if the affected user is invalid | |||
* @since 8.2.0 | |||
* {@inheritDoc} | |||
*/ | |||
public function setAffectedUser(string $affectedUser): IEvent { | |||
if ($affectedUser === '' || isset($affectedUser[64])) { | |||
throw new \InvalidArgumentException('The given affected user is invalid'); | |||
throw new InvalidValueException('affectedUser'); | |||
} | |||
$this->affectedUser = $affectedUser; | |||
return $this; | |||
@@ -158,16 +144,11 @@ class Event implements IEvent { | |||
} | |||
/** | |||
* Set the author of the activity | |||
* | |||
* @param string $author | |||
* @return IEvent | |||
* @throws \InvalidArgumentException if the author is invalid | |||
* @since 8.2.0 | |||
* {@inheritDoc} | |||
*/ | |||
public function setAuthor(string $author): IEvent { | |||
if (isset($author[64])) { | |||
throw new \InvalidArgumentException('The given author user is invalid'); | |||
throw new InvalidValueException('author'); | |||
} | |||
$this->author = $author; | |||
return $this; | |||
@@ -181,14 +162,12 @@ class Event implements IEvent { | |||
} | |||
/** | |||
* Set the timestamp of the activity | |||
* | |||
* @param int $timestamp | |||
* @return IEvent | |||
* @throws \InvalidArgumentException if the timestamp is invalid | |||
* @since 8.2.0 | |||
* {@inheritDoc} | |||
*/ | |||
public function setTimestamp(int $timestamp): IEvent { | |||
if ($timestamp < 0) { | |||
throw new InvalidValueException('timestamp'); | |||
} | |||
$this->timestamp = $timestamp; | |||
return $this; | |||
} | |||
@@ -201,17 +180,11 @@ class Event implements IEvent { | |||
} | |||
/** | |||
* 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 | |||
* {@inheritDoc} | |||
*/ | |||
public function setSubject(string $subject, array $parameters = []): IEvent { | |||
if (isset($subject[255])) { | |||
throw new \InvalidArgumentException('The given subject is invalid'); | |||
throw new InvalidValueException('subject'); | |||
} | |||
$this->subject = $subject; | |||
$this->subjectParameters = $parameters; | |||
@@ -233,14 +206,11 @@ class Event implements IEvent { | |||
} | |||
/** | |||
* @param string $subject | |||
* @return $this | |||
* @throws \InvalidArgumentException if the subject is invalid | |||
* @since 11.0.0 | |||
* {@inheritDoc} | |||
*/ | |||
public function setParsedSubject(string $subject): IEvent { | |||
if ($subject === '') { | |||
throw new \InvalidArgumentException('The given parsed subject is invalid'); | |||
throw new InvalidValueException('parsedSubject'); | |||
} | |||
$this->subjectParsed = $subject; | |||
return $this; | |||
@@ -255,21 +225,21 @@ class Event implements IEvent { | |||
} | |||
/** | |||
* @param string $subject | |||
* @param array $parameters | |||
* @return $this | |||
* @throws \InvalidArgumentException if the subject or parameters are invalid | |||
* @since 11.0.0 | |||
* {@inheritDoc} | |||
*/ | |||
public function setRichSubject(string $subject, array $parameters = []): IEvent { | |||
if ($subject === '') { | |||
throw new \InvalidArgumentException('The given parsed subject is invalid'); | |||
throw new InvalidValueException('richSubject'); | |||
} | |||
$this->subjectRich = $subject; | |||
$this->subjectRichParameters = $parameters; | |||
if ($this->subjectParsed === '') { | |||
$this->subjectParsed = $this->richToParsed($subject, $parameters); | |||
try { | |||
$this->subjectParsed = $this->richToParsed($subject, $parameters); | |||
} catch (\InvalidArgumentException $e) { | |||
throw new InvalidValueException('richSubjectParameters', $e); | |||
} | |||
} | |||
return $this; | |||
@@ -316,17 +286,11 @@ class Event implements IEvent { | |||
} | |||
/** | |||
* 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 | |||
* {@inheritDoc} | |||
*/ | |||
public function setMessage(string $message, array $parameters = []): IEvent { | |||
if (isset($message[255])) { | |||
throw new \InvalidArgumentException('The given message is invalid'); | |||
throw new InvalidValueException('message'); | |||
} | |||
$this->message = $message; | |||
$this->messageParameters = $parameters; | |||
@@ -348,10 +312,7 @@ class Event implements IEvent { | |||
} | |||
/** | |||
* @param string $message | |||
* @return $this | |||
* @throws \InvalidArgumentException if the message is invalid | |||
* @since 11.0.0 | |||
* {@inheritDoc} | |||
*/ | |||
public function setParsedMessage(string $message): IEvent { | |||
$this->messageParsed = $message; | |||
@@ -367,18 +328,18 @@ class Event implements IEvent { | |||
} | |||
/** | |||
* @param string $message | |||
* @param array $parameters | |||
* @return $this | |||
* @throws \InvalidArgumentException if the subject or parameters are invalid | |||
* @since 11.0.0 | |||
* {@inheritDoc} | |||
*/ | |||
public function setRichMessage(string $message, array $parameters = []): IEvent { | |||
$this->messageRich = $message; | |||
$this->messageRichParameters = $parameters; | |||
if ($this->messageParsed === '') { | |||
$this->messageParsed = $this->richToParsed($message, $parameters); | |||
try { | |||
$this->messageParsed = $this->richToParsed($message, $parameters); | |||
} catch (\InvalidArgumentException $e) { | |||
throw new InvalidValueException('richMessageParameters', $e); | |||
} | |||
} | |||
return $this; | |||
@@ -401,21 +362,14 @@ class Event implements IEvent { | |||
} | |||
/** | |||
* 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 | |||
* {@inheritDoc} | |||
*/ | |||
public function setObject(string $objectType, int $objectId, string $objectName = ''): IEvent { | |||
if (isset($objectType[255])) { | |||
throw new \InvalidArgumentException('The given object type is invalid'); | |||
throw new InvalidValueException('objectType'); | |||
} | |||
if (isset($objectName[4000])) { | |||
throw new \InvalidArgumentException('The given object name is invalid'); | |||
throw new InvalidValueException('objectName'); | |||
} | |||
$this->objectType = $objectType; | |||
$this->objectId = $objectId; | |||
@@ -445,16 +399,11 @@ class Event implements IEvent { | |||
} | |||
/** | |||
* Set the link of the activity | |||
* | |||
* @param string $link | |||
* @return IEvent | |||
* @throws \InvalidArgumentException if the link is invalid | |||
* @since 8.2.0 | |||
* {@inheritDoc} | |||
*/ | |||
public function setLink(string $link): IEvent { | |||
if (isset($link[4000])) { | |||
throw new \InvalidArgumentException('The given link is invalid'); | |||
throw new InvalidValueException('link'); | |||
} | |||
$this->link = $link; | |||
return $this; | |||
@@ -468,14 +417,11 @@ class Event implements IEvent { | |||
} | |||
/** | |||
* @param string $icon | |||
* @return $this | |||
* @throws \InvalidArgumentException if the icon is invalid | |||
* @since 11.0.0 | |||
* {@inheritDoc} | |||
*/ | |||
public function setIcon(string $icon): IEvent { | |||
if (isset($icon[4000])) { | |||
throw new \InvalidArgumentException('The given icon is invalid'); | |||
throw new InvalidValueException('icon'); | |||
} | |||
$this->icon = $icon; | |||
return $this; |
@@ -29,6 +29,9 @@ | |||
namespace OC\Activity; | |||
use OCP\Activity\ActivitySettings; | |||
use OCP\Activity\Exceptions\FilterNotFoundException; | |||
use OCP\Activity\Exceptions\IncompleteActivityException; | |||
use OCP\Activity\Exceptions\SettingNotFoundException; | |||
use OCP\Activity\IConsumer; | |||
use OCP\Activity\IEvent; | |||
use OCP\Activity\IFilter; | |||
@@ -127,16 +130,7 @@ class Manager implements IManager { | |||
} | |||
/** | |||
* Publish an event to the activity consumers | |||
* | |||
* Make sure to call at least the following methods before sending an Event: | |||
* - setApp() | |||
* - setType() | |||
* - setAffectedUser() | |||
* - setSubject() | |||
* | |||
* @param IEvent $event | |||
* @throws \BadMethodCallException if required values have not been set | |||
* {@inheritDoc} | |||
*/ | |||
public function publish(IEvent $event): void { | |||
if ($event->getAuthor() === '') { | |||
@@ -150,7 +144,7 @@ class Manager implements IManager { | |||
} | |||
if (!$event->isValid()) { | |||
throw new \BadMethodCallException('The given event is invalid'); | |||
throw new IncompleteActivityException('The given event is invalid'); | |||
} | |||
foreach ($this->getConsumers() as $c) { | |||
@@ -206,10 +200,7 @@ class Manager implements IManager { | |||
} | |||
/** | |||
* @param string $id | |||
* @return IFilter | |||
* @throws \InvalidArgumentException when the filter was not found | |||
* @since 11.0.0 | |||
* {@inheritDoc} | |||
*/ | |||
public function getFilterById(string $id): IFilter { | |||
$filters = $this->getFilters(); | |||
@@ -218,7 +209,7 @@ class Manager implements IManager { | |||
return $filters[$id]; | |||
} | |||
throw new \InvalidArgumentException('Requested filter does not exist'); | |||
throw new FilterNotFoundException($id); | |||
} | |||
/** @var string[] */ | |||
@@ -294,10 +285,7 @@ class Manager implements IManager { | |||
} | |||
/** | |||
* @param string $id | |||
* @return ActivitySettings | |||
* @throws \InvalidArgumentException when the setting was not found | |||
* @since 11.0.0 | |||
* {@inheritDoc} | |||
*/ | |||
public function getSettingById(string $id): ActivitySettings { | |||
$settings = $this->getSettings(); | |||
@@ -306,7 +294,7 @@ class Manager implements IManager { | |||
return $settings[$id]; | |||
} | |||
throw new \InvalidArgumentException('Requested setting does not exist'); | |||
throw new SettingNotFoundException($id); | |||
} | |||
@@ -346,12 +334,8 @@ class Manager implements IManager { | |||
* Set the user we need to use | |||
* | |||
* @param string|null $currentUserId | |||
* @throws \UnexpectedValueException If the user is invalid | |||
*/ | |||
public function setCurrentUserId(?string $currentUserId = null): void { | |||
if (!is_string($currentUserId) && $currentUserId !== null) { | |||
throw new \UnexpectedValueException('The given current user is invalid'); | |||
} | |||
$this->currentUserId = $currentUserId; | |||
} | |||
@@ -0,0 +1,48 @@ | |||
<?php | |||
declare(strict_types=1); | |||
/** | |||
* @copyright Copyright (c) 2024 Joas Schilling <coding@schilljs.com> | |||
* | |||
* @author Joas Schilling <coding@schilljs.com> | |||
* | |||
* @license GNU AGPL version 3 or any later version | |||
* | |||
* This program is free software: you can redistribute it and/or modify | |||
* it under the terms of the GNU Affero General Public License as | |||
* published by the Free Software Foundation, either version 3 of the | |||
* License, or (at your option) any later version. | |||
* | |||
* This program is distributed in the hope that it will be useful, | |||
* but WITHOUT ANY WARRANTY; without even the implied warranty of | |||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||
* GNU Affero General Public License for more details. | |||
* | |||
* You should have received a copy of the GNU Affero General Public License | |||
* along with this program. If not, see <http://www.gnu.org/licenses/>. | |||
* | |||
*/ | |||
namespace OCP\Activity\Exceptions; | |||
/** | |||
* @since 30.0.0 | |||
*/ | |||
class FilterNotFoundException extends \InvalidArgumentException { | |||
/** | |||
* @since 30.0.0 | |||
*/ | |||
public function __construct( | |||
protected string $filter, | |||
) { | |||
parent::__construct('Filter ' . $filter . ' not found'); | |||
} | |||
/** | |||
* @since 30.0.0 | |||
*/ | |||
public function getFilterId(): string { | |||
return $this->filter; | |||
} | |||
} |
@@ -0,0 +1,43 @@ | |||
<?php | |||
declare(strict_types=1); | |||
/** | |||
* @copyright Copyright (c) 2024 Joas Schilling <coding@schilljs.com> | |||
* | |||
* @author Joas Schilling <coding@schilljs.com> | |||
* | |||
* @license GNU AGPL version 3 or any later version | |||
* | |||
* This program is free software: you can redistribute it and/or modify | |||
* it under the terms of the GNU Affero General Public License as | |||
* published by the Free Software Foundation, either version 3 of the | |||
* License, or (at your option) any later version. | |||
* | |||
* This program is distributed in the hope that it will be useful, | |||
* but WITHOUT ANY WARRANTY; without even the implied warranty of | |||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||
* GNU Affero General Public License for more details. | |||
* | |||
* You should have received a copy of the GNU Affero General Public License | |||
* along with this program. If not, see <http://www.gnu.org/licenses/>. | |||
* | |||
*/ | |||
namespace OCP\Activity\Exceptions; | |||
/** | |||
* Thrown when {@see \OCP\Notification\IManager::notify()} is called with a notification | |||
* that does not have all required fields set: | |||
* | |||
* - app | |||
* - type | |||
* - affectedUser | |||
* - subject | |||
* - objectType | |||
* - objectId | |||
* | |||
* @since 30.0.0 | |||
*/ | |||
class IncompleteActivityException extends \BadMethodCallException { | |||
} |
@@ -0,0 +1,49 @@ | |||
<?php | |||
declare(strict_types=1); | |||
/** | |||
* @copyright Copyright (c) 2024 Joas Schilling <coding@schilljs.com> | |||
* | |||
* @author Joas Schilling <coding@schilljs.com> | |||
* | |||
* @license GNU AGPL version 3 or any later version | |||
* | |||
* This program is free software: you can redistribute it and/or modify | |||
* it under the terms of the GNU Affero General Public License as | |||
* published by the Free Software Foundation, either version 3 of the | |||
* License, or (at your option) any later version. | |||
* | |||
* This program is distributed in the hope that it will be useful, | |||
* but WITHOUT ANY WARRANTY; without even the implied warranty of | |||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||
* GNU Affero General Public License for more details. | |||
* | |||
* You should have received a copy of the GNU Affero General Public License | |||
* along with this program. If not, see <http://www.gnu.org/licenses/>. | |||
* | |||
*/ | |||
namespace OCP\Activity\Exceptions; | |||
/** | |||
* @since 30.0.0 | |||
*/ | |||
class InvalidValueException extends \InvalidArgumentException { | |||
/** | |||
* @since 30.0.0 | |||
*/ | |||
public function __construct( | |||
protected string $field, | |||
?\Throwable $previous = null, | |||
) { | |||
parent::__construct('Value provided for ' . $field . ' is not valid', previous: $previous); | |||
} | |||
/** | |||
* @since 30.0.0 | |||
*/ | |||
public function getFieldIdentifier(): string { | |||
return $this->field; | |||
} | |||
} |
@@ -0,0 +1,48 @@ | |||
<?php | |||
declare(strict_types=1); | |||
/** | |||
* @copyright Copyright (c) 2024 Joas Schilling <coding@schilljs.com> | |||
* | |||
* @author Joas Schilling <coding@schilljs.com> | |||
* | |||
* @license GNU AGPL version 3 or any later version | |||
* | |||
* This program is free software: you can redistribute it and/or modify | |||
* it under the terms of the GNU Affero General Public License as | |||
* published by the Free Software Foundation, either version 3 of the | |||
* License, or (at your option) any later version. | |||
* | |||
* This program is distributed in the hope that it will be useful, | |||
* but WITHOUT ANY WARRANTY; without even the implied warranty of | |||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||
* GNU Affero General Public License for more details. | |||
* | |||
* You should have received a copy of the GNU Affero General Public License | |||
* along with this program. If not, see <http://www.gnu.org/licenses/>. | |||
* | |||
*/ | |||
namespace OCP\Activity\Exceptions; | |||
/** | |||
* @since 30.0.0 | |||
*/ | |||
class SettingNotFoundException extends \InvalidArgumentException { | |||
/** | |||
* @since 30.0.0 | |||
*/ | |||
public function __construct( | |||
protected string $setting, | |||
) { | |||
parent::__construct('Setting ' . $setting . ' not found'); | |||
} | |||
/** | |||
* @since 30.0.0 | |||
*/ | |||
public function getSettingId(): string { | |||
return $this->setting; | |||
} | |||
} |
@@ -0,0 +1,33 @@ | |||
<?php | |||
declare(strict_types=1); | |||
/** | |||
* @copyright Copyright (c) 2024 Joas Schilling <coding@schilljs.com> | |||
* | |||
* @author Joas Schilling <coding@schilljs.com> | |||
* | |||
* @license GNU AGPL version 3 or any later version | |||
* | |||
* This program is free software: you can redistribute it and/or modify | |||
* it under the terms of the GNU Affero General Public License as | |||
* published by the Free Software Foundation, either version 3 of the | |||
* License, or (at your option) any later version. | |||
* | |||
* This program is distributed in the hope that it will be useful, | |||
* but WITHOUT ANY WARRANTY; without even the implied warranty of | |||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||
* GNU Affero General Public License for more details. | |||
* | |||
* You should have received a copy of the GNU Affero General Public License | |||
* along with this program. If not, see <http://www.gnu.org/licenses/>. | |||
* | |||
*/ | |||
namespace OCP\Activity\Exceptions; | |||
/** | |||
* @since 30.0.0 | |||
*/ | |||
class UnknownActivityException extends \InvalidArgumentException { | |||
} |
@@ -30,6 +30,8 @@ declare(strict_types=1); | |||
namespace OCP\Activity; | |||
use OCP\Activity\Exceptions\InvalidValueException; | |||
/** | |||
* Interface IEvent | |||
* | |||
@@ -41,8 +43,9 @@ interface IEvent { | |||
* | |||
* @param string $app | |||
* @return IEvent | |||
* @throws \InvalidArgumentException if the app id is invalid | |||
* @throws InvalidValueException if the app id is invalid | |||
* @since 8.2.0 | |||
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException | |||
*/ | |||
public function setApp(string $app): self; | |||
@@ -51,28 +54,31 @@ interface IEvent { | |||
* | |||
* @param string $type | |||
* @return IEvent | |||
* @throws \InvalidArgumentException if the type is invalid | |||
* @throws InvalidValueException if the type is invalid | |||
* @since 8.2.0 | |||
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException | |||
*/ | |||
public function setType(string $type): self; | |||
/** | |||
* Set the affected user of the activity | |||
* | |||
* @param string $user | |||
* @param string $affectedUser | |||
* @return IEvent | |||
* @throws \InvalidArgumentException if the affected user is invalid | |||
* @throws InvalidValueException if the affected user is invalid | |||
* @since 8.2.0 | |||
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException | |||
*/ | |||
public function setAffectedUser(string $user): self; | |||
public function setAffectedUser(string $affectedUser): self; | |||
/** | |||
* Set the author of the activity | |||
* | |||
* @param string $author | |||
* @return IEvent | |||
* @throws \InvalidArgumentException if the author is invalid | |||
* @throws InvalidValueException if the author is invalid | |||
* @since 8.2.0 | |||
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException | |||
*/ | |||
public function setAuthor(string $author): self; | |||
@@ -81,8 +87,9 @@ interface IEvent { | |||
* | |||
* @param int $timestamp | |||
* @return IEvent | |||
* @throws \InvalidArgumentException if the timestamp is invalid | |||
* @throws InvalidValueException if the timestamp is invalid | |||
* @since 8.2.0 | |||
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException | |||
*/ | |||
public function setTimestamp(int $timestamp): self; | |||
@@ -92,8 +99,9 @@ interface IEvent { | |||
* @param string $subject | |||
* @param array $parameters | |||
* @return IEvent | |||
* @throws \InvalidArgumentException if the subject or parameters are invalid | |||
* @throws InvalidValueException if the subject or parameters are invalid | |||
* @since 8.2.0 | |||
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException | |||
*/ | |||
public function setSubject(string $subject, array $parameters = []): self; | |||
@@ -109,8 +117,9 @@ interface IEvent { | |||
* | |||
* @param string $subject | |||
* @return $this | |||
* @throws \InvalidArgumentException if the subject is invalid | |||
* @throws InvalidValueException if the subject is invalid | |||
* @since 11.0.0 | |||
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException | |||
*/ | |||
public function setParsedSubject(string $subject): self; | |||
@@ -132,8 +141,9 @@ interface IEvent { | |||
* @param string $subject | |||
* @param array $parameters | |||
* @return $this | |||
* @throws \InvalidArgumentException if the subject or parameters are invalid | |||
* @throws InvalidValueException if the subject or parameters are invalid | |||
* @since 11.0.0 | |||
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException | |||
*/ | |||
public function setRichSubject(string $subject, array $parameters = []): self; | |||
@@ -155,8 +165,9 @@ interface IEvent { | |||
* @param string $message | |||
* @param array $parameters | |||
* @return IEvent | |||
* @throws \InvalidArgumentException if the message or parameters are invalid | |||
* @throws InvalidValueException if the message or parameters are invalid | |||
* @since 8.2.0 | |||
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException | |||
*/ | |||
public function setMessage(string $message, array $parameters = []): self; | |||
@@ -172,8 +183,9 @@ interface IEvent { | |||
* | |||
* @param string $message | |||
* @return $this | |||
* @throws \InvalidArgumentException if the message is invalid | |||
* @throws InvalidValueException if the message is invalid | |||
* @since 11.0.0 | |||
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException | |||
*/ | |||
public function setParsedMessage(string $message): self; | |||
@@ -197,6 +209,7 @@ interface IEvent { | |||
* @return $this | |||
* @throws \InvalidArgumentException if the message or parameters are invalid | |||
* @since 11.0.0 | |||
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException | |||
*/ | |||
public function setRichMessage(string $message, array $parameters = []): self; | |||
@@ -219,8 +232,9 @@ interface IEvent { | |||
* @param int $objectId | |||
* @param string $objectName | |||
* @return IEvent | |||
* @throws \InvalidArgumentException if the object is invalid | |||
* @throws InvalidValueException if the object is invalid | |||
* @since 8.2.0 | |||
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException | |||
*/ | |||
public function setObject(string $objectType, int $objectId, string $objectName = ''): self; | |||
@@ -229,8 +243,9 @@ interface IEvent { | |||
* | |||
* @param string $link | |||
* @return IEvent | |||
* @throws \InvalidArgumentException if the link is invalid | |||
* @throws InvalidValueException if the link is invalid | |||
* @since 8.2.0 | |||
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException | |||
*/ | |||
public function setLink(string $link): self; | |||
@@ -315,8 +330,9 @@ interface IEvent { | |||
/** | |||
* @param string $icon | |||
* @return $this | |||
* @throws \InvalidArgumentException if the icon is invalid | |||
* @throws InvalidValueException if the icon is invalid | |||
* @since 11.0.0 | |||
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException | |||
*/ | |||
public function setIcon(string $icon): self; | |||
@@ -352,7 +368,7 @@ interface IEvent { | |||
public function isValidParsed(): bool; | |||
/** | |||
* Set whether or not a notification should be automatically generated for this activity. | |||
* Set whether a notification should be automatically generated for this activity. | |||
* | |||
* Set this to `false` if the app already generates a notification for the event. | |||
* | |||
@@ -363,7 +379,7 @@ interface IEvent { | |||
public function setGenerateNotification(bool $generate): self; | |||
/** | |||
* whether or not a notification should be automatically generated for this activity. | |||
* Whether a notification should be automatically generated for this activity. | |||
* | |||
* @return bool | |||
* @since 20.0.0 |
@@ -28,6 +28,10 @@ declare(strict_types=1); | |||
*/ | |||
namespace OCP\Activity; | |||
use OCP\Activity\Exceptions\FilterNotFoundException; | |||
use OCP\Activity\Exceptions\IncompleteActivityException; | |||
use OCP\Activity\Exceptions\SettingNotFoundException; | |||
/** | |||
* Interface IManager | |||
* | |||
@@ -61,8 +65,9 @@ interface IManager { | |||
* - setObject() | |||
* | |||
* @param IEvent $event | |||
* @throws \BadMethodCallException if required values have not been set | |||
* @throws IncompleteActivityException if required values have not been set | |||
* @since 8.2.0 | |||
* @since 30.0.0 throws {@see IncompleteActivityException} instead of \BadMethodCallException | |||
*/ | |||
public function publish(IEvent $event): void; | |||
@@ -92,8 +97,9 @@ interface IManager { | |||
/** | |||
* @param string $id | |||
* @return IFilter | |||
* @throws \InvalidArgumentException when the filter was not found | |||
* @throws FilterNotFoundException when the filter was not found | |||
* @since 11.0.0 | |||
* @since 30.0.0 throws {@see FilterNotFoundException} instead of \InvalidArgumentException | |||
*/ | |||
public function getFilterById(string $id): IFilter; | |||
@@ -124,8 +130,9 @@ interface IManager { | |||
/** | |||
* @param string $id | |||
* @return ActivitySettings | |||
* @throws \InvalidArgumentException when the setting was not found | |||
* @throws SettingNotFoundException when the setting was not found | |||
* @since 11.0.0 | |||
* @since 30.0.0 throws {@see SettingNotFoundException} instead of \InvalidArgumentException | |||
*/ | |||
public function getSettingById(string $id): ActivitySettings; | |||
@@ -158,7 +165,6 @@ interface IManager { | |||
* Set the user we need to use | |||
* | |||
* @param string|null $currentUserId | |||
* @throws \UnexpectedValueException If the user is invalid | |||
* @since 9.0.1 | |||
*/ | |||
public function setCurrentUserId(?string $currentUserId = null): void; |
@@ -22,6 +22,8 @@ | |||
*/ | |||
namespace OCP\Activity; | |||
use OCP\Activity\Exceptions\UnknownActivityException; | |||
/** | |||
* Interface IProvider | |||
* | |||
@@ -35,8 +37,11 @@ interface IProvider { | |||
* To do so, simply use setChildEvent($previousEvent) after setting the | |||
* combined subject on the current event. | |||
* @return IEvent | |||
* @throws \InvalidArgumentException Should be thrown if your provider does not know this event | |||
* @throws UnknownActivityException Should be thrown if your provider does not know this event | |||
* @since 11.0.0 | |||
* @since 30.0.0 Providers should throw {@see UnknownActivityException} instead of \InvalidArgumentException | |||
* when they did not handle the event. Throwing \InvalidArgumentException directly is deprecated and will | |||
* be logged as an error in Nextcloud 39. | |||
*/ | |||
public function parse($language, IEvent $event, ?IEvent $previousEvent = null); | |||
} |
@@ -23,6 +23,7 @@ | |||
namespace Test\Activity; | |||
use OCP\Activity\Exceptions\IncompleteActivityException; | |||
use OCP\IConfig; | |||
use OCP\IL10N; | |||
use OCP\IRequest; | |||
@@ -167,7 +168,7 @@ class ManagerTest extends TestCase { | |||
public function testPublishExceptionNoApp() { | |||
$this->expectException(\BadMethodCallException::class); | |||
$this->expectException(IncompleteActivityException::class); | |||
$event = $this->activityManager->generateEvent(); | |||
$this->activityManager->publish($event); | |||
@@ -175,7 +176,7 @@ class ManagerTest extends TestCase { | |||
public function testPublishExceptionNoType() { | |||
$this->expectException(\BadMethodCallException::class); | |||
$this->expectException(IncompleteActivityException::class); | |||
$event = $this->activityManager->generateEvent(); | |||
$event->setApp('test'); | |||
@@ -184,7 +185,7 @@ class ManagerTest extends TestCase { | |||
public function testPublishExceptionNoAffectedUser() { | |||
$this->expectException(\BadMethodCallException::class); | |||
$this->expectException(IncompleteActivityException::class); | |||
$event = $this->activityManager->generateEvent(); | |||
$event->setApp('test') | |||
@@ -194,7 +195,7 @@ class ManagerTest extends TestCase { | |||
public function testPublishExceptionNoSubject() { | |||
$this->expectException(\BadMethodCallException::class); | |||
$this->expectException(IncompleteActivityException::class); | |||
$event = $this->activityManager->generateEvent(); | |||
$event->setApp('test') |