Created
June 28, 2012 20:44
-
-
Save rodneyrehm/3013807 to your computer and use it in GitHub Desktop.
Smarty: Whitespace Control - Prefilter Plugin
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php | |
/** | |
* Smarty Whitespace Control | |
* | |
* {-tag} remove white space infront of tag up to the previous non-whitespace character or beginning of the line | |
* "text \n\n\t {-tag}" -> "text \n\n{tag}" | |
* "text \n\n\t text\t {-tag}" -> "text \n\n\t text{tag}" | |
* {--tag} remove white space infront of tag up to the previous non-whitespace character | |
* "text \n\n\t {--tag}" -> "text{tag}" | |
* "text \n\n\t text\t {--tag}" -> "text \n\n\t text{tag}" | |
* {+-tag} | |
* {-+tag} replace white space infront of tag up to the previous non-whitespace character by a single line-break | |
* "text \n\n\t {-+tag}" -> "text\n{tag}" | |
* "text \n\n\t text\t {-+tag}" -> "text \n\n\t text\n{tag}" | |
* | |
* {tag-} remove white space after tag up to the next non-whitespace character or end of the line | |
* "{tag-} \n\n\t text" -> "{tag}\n\n\t text" | |
* "{tag-} text \n\n\t text" -> "{tag}text \n\n\t text" | |
* {tag--} remove white space after tag up to the next non-whitespace character | |
* "{tag--} \n\n\t text" -> "{tag}text" | |
* "{tag--} text \n\n\t text" -> "{tag}text \n\n\t text" | |
* {tag+-} | |
* {tag-+} replace white space after tag up to the next non-whitespace character by a single line-break | |
* "{tag-+} \n\n\t text" -> "{tag}\n\ntext" | |
* "{tag-+} text \n\n\t text" -> "{tag}\n\ntext \n\n\t text" | |
* | |
* {tag+} replace white space after tag up to the end of the line with an additional line-break | |
* "{tag+} \n\t text" -> "{tag}\n\n\t text" | |
* "{tag+} text \n\n\t text" -> "{tag}\n\ntext \n\n\t text" | |
* | |
* Any combination of the above, say {--tag+} is possible. Any + modifiers are executed before - modifiers, so | |
* "{tag+-}{--tag}" will lead to "{tag}{tag}" | |
* | |
* NOTE: {tag+} and {tag-+} cause two trailing \n. This is done because PHP itself throws away the first \n. | |
* So \n\n in the template will lead to \n in the output | |
* | |
* @param string $string raw template source | |
* @param Smarty_Internal_Template $template Template instance | |
* @return string raw template source after whitespace control was applied | |
* @author Rodney Rehm | |
*/ | |
function smarty_prefilter_whitespace_control($string, Smarty_Internal_Template $template) { | |
$ldelim = $template->smarty->left_delimiter; | |
$rdelim = $template->smarty->right_delimiter; | |
$_ldelim = preg_quote($ldelim); | |
$_rdelim = preg_quote($rdelim); | |
// remove preceeding whitepsace preserving a single line-break | |
$string = preg_replace('#\s*'. $_ldelim .'(?:-\+|\+-)#', "\n" . $ldelim, $string); | |
// remove trailing whitespace preserving s single line-break | |
$string = preg_replace('#(?:\+-|-\+)'. $_rdelim .'\s*#', $rdelim . "\n\n", $string); | |
// remove preceeding whitepsace | |
$string = preg_replace('#\s*'. $_ldelim .'--|[^\S\r\n]*'. $_ldelim .'-#', $ldelim, $string); | |
// remove trailing whitespace | |
$string = preg_replace('#--'. $_rdelim .'\s*|-'. $_rdelim .'[^\S\r\n]*#', $rdelim, $string); | |
// force trailing line-break | |
$string = preg_replace('#\+'. $_rdelim .'(?:\s*[\r\n]|[^\S\r\n]*)#', $rdelim . "\n\n", $string); | |
return $string; | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php | |
require_once 'prefilter.whitespace_control.php'; | |
// Smarty_Internal_Template stub for testing | |
class Smarty_Internal_Template { | |
public $smarty; | |
} | |
$tpl = new Smarty_Internal_Template(); | |
$tpl->smarty = new StdClass(); | |
$tpl->smarty->left_delimiter = '{'; | |
$tpl->smarty->right_delimiter = '}'; | |
$tests = array( | |
"text \n\n\t {-tag}" => "text \n\n{tag}", | |
"text \n\n\t text\t {-tag}" => "text \n\n\t text{tag}", | |
"text \n\n\t {--tag}" => "text{tag}", | |
"text \n\n\t text\t {--tag}" => "text \n\n\t text{tag}", | |
"text \n\n\t {-+tag}" => "text\n{tag}", | |
"text \n\n\t text\t {-+tag}" => "text \n\n\t text\n{tag}", | |
"{tag-} \n\n\t text" => "{tag}\n\n\t text", | |
"{tag-} text \n\n\t text" => "{tag}text \n\n\t text", | |
"{tag--} \n\n\t text" => "{tag}text", | |
"{tag--} text \n\n\t text" => "{tag}text \n\n\t text", | |
"{tag-+} \n\n\t text" => "{tag}\n\ntext", | |
"{tag-+} text \n\n\t text" => "{tag}\n\ntext \n\n\t text", | |
"{tag+} \n\t text" => "{tag}\n\n\t text", | |
"{tag+} text \n\n\t text" => "{tag}\n\ntext \n\n\t text", | |
"{tag+-}{--tag}" => "{tag}{tag}", | |
); | |
function nl($string) { | |
$string = str_replace("\n", '\n', $string); | |
$string = str_replace("\t", '\t', $string); | |
return $string; | |
} | |
foreach ($tests as $in => $out) { | |
$res = smarty_prefilter_whitespace_control($in, $tpl); | |
if ($res !== $out) { | |
echo "failed '", nl($in), "' got '", nl($res), "' but expected '", nl($out), "'\n"; | |
} | |
} | |
echo "\n"; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment