Change SetupResult API to named constructors

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>

1 files changed, 34 insertions, 1 deletions

diff --git a/lib/public/SetupCheck/SetupResult.php b/lib/public/SetupCheck/SetupResult.php
index 158a9489cfe..27026f82815 100644
--- a/lib/public/SetupCheck/SetupResult.php
+++ b/lib/public/SetupCheck/SetupResult.php
@@ -38,10 +38,11 @@ class SetupResult implements \JsonSerializable {
 	public const ERROR = 'error';
 
 	/**
+	 * @brief Private constructor, use success()/info()/warning()/error() instead
 	 * @param self::SUCCESS|self::INFO|self::WARNING|self::ERROR $severity
 	 * @since 28.0.0
 	 */
-	public function __construct(
+	private function __construct(
 		private string $severity,
 		private ?string $description = null,
 		private ?string $linkToDoc = null,
@@ -49,6 +50,38 @@ class SetupResult implements \JsonSerializable {
 	}
 
 	/**
+	 * @brief Create a success result object
+	 * @since 28.0.0
+	 */
+	public static function success(?string $description = null, ?string $linkToDoc = null): self {
+		return new self(self::SUCCESS, $description, $linkToDoc);
+	}
+
+	/**
+	 * @brief Create an info result object
+	 * @since 28.0.0
+	 */
+	public static function info(?string $description = null, ?string $linkToDoc = null): self {
+		return new self(self::INFO, $description, $linkToDoc);
+	}
+
+	/**
+	 * @brief Create a warning result object
+	 * @since 28.0.0
+	 */
+	public static function warning(?string $description = null, ?string $linkToDoc = null): self {
+		return new self(self::WARNING, $description, $linkToDoc);
+	}
+
+	/**
+	 * @brief Create an error result object
+	 * @since 28.0.0
+	 */
+	public static function error(?string $description = null, ?string $linkToDoc = null): self {
+		return new self(self::ERROR, $description, $linkToDoc);
+	}
+
+	/**
 	 * @brief Get the severity for the setup check result
 	 *
 	 * @return self::SUCCESS|self::INFO|self::WARNING|self::ERROR