PHP模板引擎正則替換函數 preg_replace 與 preg_replace_callback 使用總結

在編寫PHP模板引擎工具類時，之前經常使用的一個正則替換函數爲 preg_replace()，加上正則修飾符 /e，就可以執行強大的回調函數，實現模板引擎編譯（其實就是字符串替換）。

詳情介紹參考博文：PHP函數preg_replace() 正則替換全部符合條件的字符串 

應用舉例以下：

<?php
/**
 * 模板解析類
 */
class Template {

	public function compile($template) {

		// if邏輯
		$template = preg_replace("/\<\!\-\-\{if\s+(.+?)\}\-\-\>/e", "\$this->ifTag('\\1')", $template);

		return $template;
	}

	/**
	 * if 標籤
	 */
	protected function ifTag($str) {

		//$str = stripslashes($str); // 去反轉義

		return '<?php if (' . $str . ') { ?>';
	}
}

$template = 'xxx<!--{if $user[\'userName\']}-->yyy<!--{if $user["password"]}-->zzz';

$tplComplier = new Template();

$template = $tplComplier->compile($template);

echo $template;

?>

輸出結果爲：

xxx<?php if ($user['userName']) { ?>yyy<?php if ($user[\"password\"]) { ?>zzz

仔細觀察，發現 $user["password"] 中的雙引號被轉義了，這不是咱們想要的結果。

爲了可以正常輸出，還必須反轉義一下，

可是，若是字符串中自己含有反轉義雙引號的話，咱們此時反轉義，本來的反轉義就變成了非反轉義了，這個結果又不是咱們想要的，

因此說這個函數在這方面用的不爽！

 

後來，發現一個更專業級的 正則替換回調函數 preg_replace_callback()。

mixed preg_replace_callback ( mixed pattern, callback callback, mixed subject [, int limit] )

本函數的行爲幾乎和 preg_replace() 同樣，除了不是提供一個 replacement 參數，而是指定一個 callback 函數。該函數將以目標字符串中的匹配數組做爲輸入參數，並返回用於替換的字符串。

回調函數 callback：

一個回調函數，在每次須要替換時調用，調用時函數獲得的參數是從subject 中匹配到的結果。回調函數返回真正參與替換的字符串。這是該回調函數的簽名：

string handler ( array $matches )

像上面所看到的，回調函數一般只有一個參數，且是數組類型。

 

羅列一些有關preg_replace_callback()函數的實例：

Example #1 preg_replace_callback() 和 匿名函數

<?php
/* 一個unix樣式的命令行過濾器，用於將段落開始部分的大寫字母轉換爲小寫。 */
$fp = fopen("php://stdin", "r") or die("can't read stdin");
while (!feof($fp)) {
    $line = fgets($fp);
    $line = preg_replace_callback(
        '|<p>\s*\w|',
        function ($matches) {
            return strtolower($matches[0]);
        },
        $line
    );
    echo $line;
}
fclose($fp);
?>

若是回調函數是個匿名函數，在PHP5.3中，經過關鍵字use，支持給匿名函數傳多個參數，以下所示：

<?php 
$string = "Some numbers: one: 1; two: 2; three: 3 end"; 
$ten = 10; 
$newstring = preg_replace_callback( 
    '/(\\d+)/', 
    function($match) use ($ten) { return (($match[0] + $ten)); }, 
    $string 
    ); 
echo $newstring; 
#prints "Some numbers: one: 11; two: 12; three: 13 end"; 
?>

 

Example #2 preg_replace_callback() 和 通常函數

<?php
// 將文本中的年份增長一年.
$text = "April fools day is 04/01/2002\n";
$text.= "Last christmas was 12/24/2001\n";
// 回調函數
function next_year($matches) {
  // 一般: $matches[0]是完成的匹配
  // $matches[1]是第一個捕獲子組的匹配
  // 以此類推
  return $matches[1].($matches[2]+1);
}
echo preg_replace_callback(
            "|(\d{2}/\d{2}/)(\d{4})|",
            "next_year",
            $text);

?>

 

Example #3 preg_replace_callback() 和 類方法

如何在類的內部調用非靜態函數？你能夠按以下操做：

對於 PHP 5.2，第二個參數 像這樣 array($this, 'replace') ：

<?php
class test_preg_callback{

  private function process($text){
    $reg = "/\{([0-9a-zA-Z\- ]+)\:([0-9a-zA-Z\- ]+):?\}/";
    return preg_replace_callback($reg, array($this, 'replace'), $text);
  }
  
  private function replace($matches){
    if (method_exists($this, $matches[1])){
      return @$this->$matches[1]($matches[2]);     
    }
  }  
}
?>

對於 PHP5.3，第二個參數像這樣 "self::replace" ：

注意，也能夠是 array($this, 'replace')。

<?php
class test_preg_callback{

  private function process($text){
    $reg = "/\{([0-9a-zA-Z\- ]+)\:([0-9a-zA-Z\- ]+):?\}/";
    return preg_replace_callback($reg, "self::replace", $text);
  }
  
  private function replace($matches){
    if (method_exists($this, $matches[1])){
      return @$this->$matches[1]($matches[2]);     
    }
  }  
}
?>

 

根據上面所學到的知識點，把模板引擎類改造以下：

<?php
/**
 * 模板解析類
 */
class Template {

	public function compile($template) {

		// if邏輯
		$template = preg_replace_callback("/\<\!\-\-\{if\s+(.+?)\}\-\-\>/", array($this, 'ifTag'), $template);

		return $template;
	}

	/**
	 * if 標籤
	 */
	protected function ifTag($matches) {
		return '<?php if (' . $matches[1] . ') { ?>';
	}
}

$template = 'xxx<!--{if $user[\'userName\']}-->yyy<!--{if $user["password"]}-->zzz';

$tplComplier = new Template();

$template = $tplComplier->compile($template);

echo $template;

?>

輸出結果爲：

xxx<?php if ($user['userName']) { ?>yyy<?php if ($user["password"]) { ?>zzz

正是咱們想要的結果，雙引號沒有被反轉義！

 

 

 

參考：

http://cn2.php.net/preg_replace_callback/