diff options
| author | Tristan Darricau <tristan.darricau@sensiolabs.com> | 2015-04-05 23:32:38 +0200 |
|---|---|---|
| committer | Tristan Darricau <tristan.darricau@sensiolabs.com> | 2015-04-05 23:32:38 +0200 |
| commit | 3a6a61a8dd6a2c8e14b42450496287f87c3c5975 (patch) | |
| tree | ed41376b47d199f3a5ea44ed8d26e6015c693271 /phpBB/phpbb/textformatter/utils_interface.php | |
| parent | 5ac13c7ddc19a574878959fe6906d5d6cf30da51 (diff) | |
| parent | 4e80565fe7862da4ea1948c6ece1099a59a1020f (diff) | |
| download | forums-3a6a61a8dd6a2c8e14b42450496287f87c3c5975.tar forums-3a6a61a8dd6a2c8e14b42450496287f87c3c5975.tar.gz forums-3a6a61a8dd6a2c8e14b42450496287f87c3c5975.tar.bz2 forums-3a6a61a8dd6a2c8e14b42450496287f87c3c5975.tar.xz forums-3a6a61a8dd6a2c8e14b42450496287f87c3c5975.zip | |
Merge pull request #3461 from s9e/ticket/11768
[3.2][ticket/11768] Integrate s9e\TextFormatter
Diffstat (limited to 'phpBB/phpbb/textformatter/utils_interface.php')
| -rw-r--r-- | phpBB/phpbb/textformatter/utils_interface.php | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/phpBB/phpbb/textformatter/utils_interface.php b/phpBB/phpbb/textformatter/utils_interface.php new file mode 100644 index 0000000000..132dc8ece4 --- /dev/null +++ b/phpBB/phpbb/textformatter/utils_interface.php @@ -0,0 +1,48 @@ +<?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 Parsed text + * @return string Plain text + */ + public function clean_formatting($text); + + /** + * Remove given BBCode and its content, 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 Parsed text + */ + public function remove_bbcode($text, $bbcode_name, $depth = 0); + + /** + * Return a parsed text to its original form + * + * @param string $text Parsed text + * @return string Original plain text + */ + public function unparse($text); +} |