diff options
| author | JoshyPHP <s9e.dev@gmail.com> | 2015-03-26 15:28:04 +0100 |
|---|---|---|
| committer | JoshyPHP <s9e.dev@gmail.com> | 2015-04-02 19:16:04 +0200 |
| commit | 55c3fc02cfe1ce151bfb65c31ec72fc75f9d7872 (patch) | |
| tree | 424a91afdbb04be94201bbf08ea95f975d8f9503 /phpBB/phpbb/textformatter/utils_interface.php | |
| parent | f75f63b264b2005faedb699dd867bd1d9c429a09 (diff) | |
| download | forums-55c3fc02cfe1ce151bfb65c31ec72fc75f9d7872.tar forums-55c3fc02cfe1ce151bfb65c31ec72fc75f9d7872.tar.gz forums-55c3fc02cfe1ce151bfb65c31ec72fc75f9d7872.tar.bz2 forums-55c3fc02cfe1ce151bfb65c31ec72fc75f9d7872.tar.xz forums-55c3fc02cfe1ce151bfb65c31ec72fc75f9d7872.zip | |
[ticket/11768] Updated utils service
Updated docblocks.
Removed remove_formatting() because it overlaps with clean_formatting()
PHPBB3-11768
Diffstat (limited to 'phpBB/phpbb/textformatter/utils_interface.php')
| -rw-r--r-- | phpBB/phpbb/textformatter/utils_interface.php | 22 |
1 files changed, 6 insertions, 16 deletions
diff --git a/phpBB/phpbb/textformatter/utils_interface.php b/phpBB/phpbb/textformatter/utils_interface.php index 45610f7ecb..132dc8ece4 100644 --- a/phpBB/phpbb/textformatter/utils_interface.php +++ b/phpBB/phpbb/textformatter/utils_interface.php @@ -23,36 +23,26 @@ interface utils_interface * * NOTE: preserves smilies as text * - * @param string $text - * @return string + * @param string $text Parsed text + * @return string Plain text */ public function clean_formatting($text); /** - * Remove given BBCode at given nesting depth + * 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 + * @return string Parsed text */ 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 + * @param string $text Parsed text + * @return string Original plain text */ public function unparse($text); } |