From 7fe2c6f3f0011b07307b6b6a1ec605a7b816d416 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=B4me=20Chilliet?= Date: Mon, 22 Jan 2024 17:46:38 +0100 Subject: [PATCH] Document throwing behavior of SetupResult upon invalid rich object MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Côme Chilliet --- lib/public/SetupCheck/SetupResult.php | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/lib/public/SetupCheck/SetupResult.php b/lib/public/SetupCheck/SetupResult.php index 835cbe8b4a2c3..e5183fa0a6d7c 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 @@ private function __construct( * @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 @@ public static function success(?string $description = null, ?string $linkToDoc = * @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 @@ public static function info(?string $description = null, ?string $linkToDoc = nu * @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 @@ public static function warning(?string $description = null, ?string $linkToDoc = * @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);