aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/RichObjectStrings/IRichTextFormatter.php
blob: 1d72f480b072e3c3dbfee3f4a2a8fde5a8caf95d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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;
}