From 8411db62576a73beb921d58953bb5b767d4ee079 Mon Sep 17 00:00:00 2001
From: JoshyPHP <s9e.dev@gmail.com>
Date: Fri, 6 Mar 2015 10:21:15 +0100
Subject: [ticket/11768] Renamed interfaces
PHPBB3-11768
---
phpBB/phpbb/textformatter/parser_interface.php | 111 +++++++++++++++++++++++++
1 file changed, 111 insertions(+)
create mode 100644 phpBB/phpbb/textformatter/parser_interface.php
(limited to 'phpBB/phpbb/textformatter/parser_interface.php')
diff --git a/phpBB/phpbb/textformatter/parser_interface.php b/phpBB/phpbb/textformatter/parser_interface.php
new file mode 100644
index 0000000000..37d538470d
--- /dev/null
+++ b/phpBB/phpbb/textformatter/parser_interface.php
@@ -0,0 +1,111 @@
+<?php
+/**
+*
+* This file is part of the phpBB Forum Software package.
+*
+* @copyright (c) phpBB Limited <https://www.phpbb.com>
+* @license GNU General Public License, version 2 (GPL-2.0)
+*
+* For full copyright and license information, please see
+* the docs/CREDITS.txt file.
+*
+*/
+
+namespace phpbb\textformatter;
+
+interface parser_interface
+{
+ /**
+ * Parse given text
+ *
+ * @param string $text
+ * @return string
+ */
+ public function parse($text);
+
+ /**
+ * Disable a specific BBCode
+ *
+ * @param string $name BBCode name
+ * @return null
+ */
+ public function disable_bbcode($name);
+
+ /**
+ * Disable BBCodes in general
+ */
+ public function disable_bbcodes();
+
+ /**
+ * Disable the censor
+ */
+ public function disable_censor();
+
+ /**
+ * Disable magic URLs
+ */
+ public function disable_magic_url();
+
+ /**
+ * Disable smilies
+ */
+ public function disable_smilies();
+
+ /**
+ * Enable a specific BBCode
+ *
+ * @param string $name BBCode name
+ * @return null
+ */
+ public function enable_bbcode($name);
+
+ /**
+ * Enable BBCodes in general
+ */
+ public function enable_bbcodes();
+
+ /**
+ * Enable the censor
+ */
+ public function enable_censor();
+
+ /**
+ * Enable magic URLs
+ */
+ public function enable_magic_url();
+
+ /**
+ * Enable smilies
+ */
+ public function enable_smilies();
+
+ /**
+ * Get the list of errors that were generated during last parsing
+ *
+ * @return array
+ */
+ public function get_errors();
+
+ /**
+ * Set a variable to be used by the parser
+ *
+ * - max_font_size
+ * - max_img_height
+ * - max_img_width
+ * - max_smilies
+ * - max_urls
+ *
+ * @param string $name
+ * @param mixed $value
+ * @return null
+ */
+ public function set_var($name, $value);
+
+ /**
+ * Set multiple variables to be used by the parser
+ *
+ * @param array Associative array of [name => value]
+ * @return null
+ */
+ public function set_vars(array $vars);
+}
--
cgit v1.2.1
From 40c54898ccd80744ba159784d631328e0338bad2 Mon Sep 17 00:00:00 2001
From: JoshyPHP <s9e.dev@gmail.com>
Date: Fri, 6 Mar 2015 13:08:18 +0100
Subject: [ticket/11768] Updated various annotations
PHPBB3-11768
---
phpBB/phpbb/textformatter/parser_interface.php | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
(limited to 'phpBB/phpbb/textformatter/parser_interface.php')
diff --git a/phpBB/phpbb/textformatter/parser_interface.php b/phpBB/phpbb/textformatter/parser_interface.php
index 37d538470d..3cb9f8e977 100644
--- a/phpBB/phpbb/textformatter/parser_interface.php
+++ b/phpBB/phpbb/textformatter/parser_interface.php
@@ -104,7 +104,7 @@ interface parser_interface
/**
* Set multiple variables to be used by the parser
*
- * @param array Associative array of [name => value]
+ * @param array $vars Associative array of [name => value]
* @return null
*/
public function set_vars(array $vars);
--
cgit v1.2.1
From 7b552152b416d9f0c2e873f6f70c4d3cec575ea6 Mon Sep 17 00:00:00 2001
From: JoshyPHP <s9e.dev@gmail.com>
Date: Fri, 8 May 2015 14:51:46 +0200
Subject: [ticket/13801] Updated comments for clarity
PHPBB3-13801
---
phpBB/phpbb/textformatter/parser_interface.php | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
(limited to 'phpBB/phpbb/textformatter/parser_interface.php')
diff --git a/phpBB/phpbb/textformatter/parser_interface.php b/phpBB/phpbb/textformatter/parser_interface.php
index 3cb9f8e977..ad611fb5b4 100644
--- a/phpBB/phpbb/textformatter/parser_interface.php
+++ b/phpBB/phpbb/textformatter/parser_interface.php
@@ -82,7 +82,8 @@ interface parser_interface
/**
* Get the list of errors that were generated during last parsing
*
- * @return array
+ * @return array[] Array of arrays. Each array contains a lang string at index 0 plus any number
+ * of optional parameters
*/
public function get_errors();
--
cgit v1.2.1