1	<?php
2	/**
3	*
4	* This file is part of the phpBB Forum Software package.
5	*
6	* @copyright (c) phpBB Limited <https://www.phpbb.com>
7	* @license GNU General Public License, version 2 (GPL-2.0)
8	*
9	* For full copyright and license information, please see
10	* the docs/CREDITS.txt file.
11	*
12	*/
13
14	namespace phpbb\textformatter;
15
16	interface acp_utils_interface
17	{
18	/**
19	* There is an issue with the definition
20	*/
21	const BBCODE_STATUS_INVALID_DEFINITION = 'invalid_definition';
22
23	/**
24	* There is an issue with the template
25	*/
26	const BBCODE_STATUS_INVALID_TEMPLATE = 'invalid_template';
27
28	/**
29	* The BBCode is valid and can be safely used by anyone
30	*/
31	const BBCODE_STATUS_SAFE = 'safe';
32
33	/**
34	* The BBCode is valid but may be unsafe to use
35	*/
36	const BBCODE_STATUS_UNSAFE = 'unsafe';
37
38	/**
39	* Analyse given BBCode definition for issues and safeness
40	*
41	* Required elements in the return array:
42	*  - status: see BBCODE_STATUS_* constants
43	*
44	* Optional elements in the return array:
45	*  - name:       Name of the BBCode based on the definition. Required if status is "safe".
46	*  - error_text: Textual description of the issue in plain text or as a L_* string.
47	*  - error_html: Visual description of the issue in HTML.
48	*
49	* @param  string $definition BBCode definition, e.g. [b]{TEXT}[/b]
50	* @param  string $template   BBCode template, e.g. <b>{TEXT}</b>
51	* @return array
52	*/
53	public function analyse_bbcode(string $definition, string $template): array;
54	}