Merge pull request #48137 from nextcloud/enh/add-rich-object-formatter

feat: Add OCP interface to format richtext into string

1 files changed, 25 insertions, 0 deletions

diff --git a/lib/public/RichObjectStrings/IRichTextFormatter.php b/lib/public/RichObjectStrings/IRichTextFormatter.php
new file mode 100644
index 00000000000..1d72f480b07
--- /dev/null
+++ b/lib/public/RichObjectStrings/IRichTextFormatter.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCP\RichObjectStrings;
+
+/**
+ * Parse rich text and format it with the richobjects
+ *
+ * @since 31.0.0
+ */
+interface IRichTextFormatter {
+	/**
+	 * @since 31.0.0
+	 * @param string $message
+	 * @param array<string,array<string,string>> $parameters
+	 * @throws \InvalidArgumentException if a parameter has no name or no type
+	 */
+	public function richToParsed(string $message, array $parameters): string;
+}