diff options
author | Côme Chilliet <come.chilliet@nextcloud.com> | 2024-01-22 17:46:38 +0100 |
---|---|---|
committer | backportbot[bot] <backportbot[bot]@users.noreply.github.com> | 2024-01-29 21:11:18 +0000 |
commit | 7fe2c6f3f0011b07307b6b6a1ec605a7b816d416 (patch) | |
tree | bdbbd531d5e9ca71aa37039310747afe2a81f130 /lib | |
parent | 27c5c17f1ed0a70d856398b49058571903061fe3 (diff) | |
download | nextcloud-server-7fe2c6f3f0011b07307b6b6a1ec605a7b816d416.tar.gz nextcloud-server-7fe2c6f3f0011b07307b6b6a1ec605a7b816d416.zip |
Document throwing behavior of SetupResult upon invalid rich object
Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
Diffstat (limited to 'lib')
-rw-r--r-- | lib/public/SetupCheck/SetupResult.php | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/lib/public/SetupCheck/SetupResult.php b/lib/public/SetupCheck/SetupResult.php index 835cbe8b4a2..e5183fa0a6d 100644 --- a/lib/public/SetupCheck/SetupResult.php +++ b/lib/public/SetupCheck/SetupResult.php @@ -47,6 +47,7 @@ class SetupResult implements \JsonSerializable { /** * @brief Private constructor, use success()/info()/warning()/error() instead * @param self::SUCCESS|self::INFO|self::WARNING|self::ERROR $severity + * @throws \OCP\RichObjectStrings\InvalidObjectExeption * @since 28.0.0 * @since 28.0.2 Optional parameter ?array $descriptionParameters * @since 28.0.2 throws \OCP\RichObjectStrings\InvalidObjectExeption @@ -66,8 +67,10 @@ class SetupResult implements \JsonSerializable { * @brief Create a success result object * @param ?string $description Translated detailed description to display to the user * @param ?string $linkToDoc URI of related relevent documentation, be it from Nextcloud or another project + * @throws \OCP\RichObjectStrings\InvalidObjectExeption * @since 28.0.0 * @since 28.0.2 Optional parameter ?array $descriptionParameters + * @since 28.0.2 throws \OCP\RichObjectStrings\InvalidObjectExeption */ public static function success(?string $description = null, ?string $linkToDoc = null, ?array $descriptionParameters = null): self { return new self(self::SUCCESS, $description, $descriptionParameters, $linkToDoc); @@ -77,8 +80,10 @@ class SetupResult implements \JsonSerializable { * @brief Create an info result object * @param ?string $description Translated detailed description to display to the user * @param ?string $linkToDoc URI of related relevent documentation, be it from Nextcloud or another project + * @throws \OCP\RichObjectStrings\InvalidObjectExeption * @since 28.0.0 * @since 28.0.2 Optional parameter ?array $descriptionParameters + * @since 28.0.2 throws \OCP\RichObjectStrings\InvalidObjectExeption */ public static function info(?string $description = null, ?string $linkToDoc = null, ?array $descriptionParameters = null): self { return new self(self::INFO, $description, $descriptionParameters, $linkToDoc); @@ -88,8 +93,10 @@ class SetupResult implements \JsonSerializable { * @brief Create a warning result object * @param ?string $description Translated detailed description to display to the user * @param ?string $linkToDoc URI of related relevent documentation, be it from Nextcloud or another project + * @throws \OCP\RichObjectStrings\InvalidObjectExeption * @since 28.0.0 * @since 28.0.2 Optional parameter ?array $descriptionParameters + * @since 28.0.2 throws \OCP\RichObjectStrings\InvalidObjectExeption */ public static function warning(?string $description = null, ?string $linkToDoc = null, ?array $descriptionParameters = null): self { return new self(self::WARNING, $description, $descriptionParameters, $linkToDoc); @@ -99,8 +106,10 @@ class SetupResult implements \JsonSerializable { * @brief Create an error result object * @param ?string $description Translated detailed description to display to the user * @param ?string $linkToDoc URI of related relevent documentation, be it from Nextcloud or another project + * @throws \OCP\RichObjectStrings\InvalidObjectExeption * @since 28.0.0 * @since 28.0.2 Optional parameter ?array $descriptionParameters + * @since 28.0.2 throws \OCP\RichObjectStrings\InvalidObjectExeption */ public static function error(?string $description = null, ?string $linkToDoc = null, ?array $descriptionParameters = null): self { return new self(self::ERROR, $description, $descriptionParameters, $linkToDoc); |