From 20a1646fc6336635cee89426e3a60bb22cb138de Mon Sep 17 00:00:00 2001
From: JoshyPHP <s9e.dev@gmail.com>
Date: Fri, 6 Mar 2015 10:50:05 +0100
Subject: [ticket/11768] Renamed utils

PHPBB3-11768
---
 phpBB/phpbb/textformatter/utils_interface.php | 58 +++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 phpBB/phpbb/textformatter/utils_interface.php

(limited to 'phpBB/phpbb/textformatter/utils_interface.php')

diff --git a/phpBB/phpbb/textformatter/utils_interface.php b/phpBB/phpbb/textformatter/utils_interface.php
new file mode 100644
index 0000000000..45610f7ecb
--- /dev/null
+++ b/phpBB/phpbb/textformatter/utils_interface.php
@@ -0,0 +1,58 @@
+<?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;
+
+/**
+* Used to manipulate a parsed text
+*/
+interface utils_interface
+{
+	/**
+	* Replace BBCodes and other formatting elements with whitespace
+	*
+	* NOTE: preserves smilies as text
+	*
+	* @param  string $text
+	* @return string
+	*/
+	public function clean_formatting($text);
+
+	/**
+	* Remove given BBCode at given nesting depth
+	*
+	* @param  string  $text        Parsed text
+	* @param  string  $bbcode_name BBCode's name
+	* @param  integer $depth       Minimum nesting depth (number of parents of the same name)
+	* @return string
+	*/
+	public function remove_bbcode($text, $bbcode_name, $depth = 0);
+
+	/**
+	* Remove BBCodes and other formatting from a parsed text
+	*
+	* NOTE: preserves smilies as text
+	*
+	* @param  string $text
+	* @return string
+	*/
+	public function remove_formatting($text);
+
+	/**
+	* Return a parsed text to its original form
+	*
+	* @param  string $text
+	* @return string
+	*/
+	public function unparse($text);
+}
-- 
cgit v1.2.1