PHP中的輸出緩沖控制

在 PHP 中，我們直接進行 echo 、 或者 print_r 的時候，輸出的內容就會直接打印出來。但是，在某些情況下，我們并不想直接打印，這個時候就可以使用輸出緩沖控制來進行輸出打印的控制。當然，這一套功能并不僅限出針對打印的內容，我們還可以做其它一些操作，這個我們放到最后再說。

清除輸出

首先，我們先來看看不讓 echo 之類的內容打印輸出。

ob_start();
echo 111, PHP_EOL;
echo "aaaa", PHP_EOL;
ob_end_clean();

相信有不少小伙伴應該見過 ob_start() 這個函數，它的作用就是開始一段輸出緩沖控制。在 ob_start() 之后的代碼中的輸出語句都會進入輸出緩沖區，這個時候，如果我們調用了 ob_end_clean() 、 ob_clean() 或者 ob_get_clean() ，則不會有任何輸出了。它們三個的作用都是清除輸出緩沖區的內容。具體的區別大家可以參考文章最后給出的函數說明或者官方文檔。

獲得輸出緩沖區的內容

ob_start();
echo 111, PHP_EOL;
echo "aaaa", PHP_EOL;
$v = ob_get_contents();
ob_end_clean();

echo $v;

上面說過，使用了 ob_end_clean() 就會清除輸出緩沖區里面的內容，但是在這段代碼中，我們使用 ob_get_contents() 函數直接將緩沖區的內容賦值給了變量 \$v 。這時候，$v 中就有了前面兩段 echo 中的內容，也就是說，這個一套操作我們就拿到了本身應該輸出的內容，并將它保存在了變量中。這樣做有什么用呢？我們可以獲得類似于 phpinfo() 、 var_dump() 這些直接輸出函數的內容了，并且不會打印在客戶端屏幕上。比如：

ob_start();
php_info();
$v = ob_get_contents();
ob_end_clean();

echo $v;

在 $v 中的內容就是 php_info() 的內容了。這就是輸出緩沖控制的第二個能力。

刷新（輸出）緩沖區內容

ob_start();
echo 111, PHP_EOL;
echo "aaaa", PHP_EOL;
flush();
ob_flush();

類似的，我們在緩沖區中想要再次直接輸出內容，使用 flush() 、ob_flush() 、 ob_end_flush() 及 ob_get_flush() 就可以了，其實就是相當于讓 ob_start() 之后的 echo 這類輸出語句重新生效并正常輸出。

另外，我們還可以使用一個函數進行自動的刷新。

ob_implicit_flush();

ob_start();
echo 111, PHP_EOL;
echo "aaaa", PHP_EOL;

使用 ob_implicit_flush() 之后，我們就不需要手動地調用 ob_flush() 之類的函數來刷新緩沖區內容了。

一些檢測函數

ob_start();
ob_start();

echo 123, PHP_EOL;

echo ob_get_length(), PHP_EOL;
// 3

echo ob_get_level(), PHP_EOL;
// 2

print_r(ob_get_status(true));

// Array
// (
//     [0] => Array
//         (
//             [name] => default output handler
//             [type] => 0
//             [flags] => 112
//             [level] => 0
//             [chunk_size] => 0
//             [buffer_size] => 16384
//             [buffer_used] => 0
//         )

//     [1] => Array
//         (
//             [name] => default output handler
//             [type] => 0
//             [flags] => 112
//             [level] => 1
//             [chunk_size] => 0
//             [buffer_size] => 16384
//             [buffer_used] => 17
//         )

// )

ob_get_flush();

ob_get_length() 會返回當前緩沖區里面內容的長度，這里我們只打印了一個 123 ，在緩沖區中保存了3個字符，所以輸出的正是 3 。ob_get_level() 返回的是當前緩沖區的層級，請注意，我們在上面調用了兩次 ob_start() ，也就是有兩層的緩沖區，這個緩沖區是可以嵌套的。ob_get_status() 函數是緩沖區的狀態信息，字段的說明可以查看官方文檔，這里不再贅述。

使用 ob_start() 的回調函數來進行輸出緩沖區的內容替換

這是一個例子，但是可以推廣到其他很功能，比如我們可以用來進行全局的輸出過濾、可以做 CSS 或 JS 文件的壓縮優化等等。

ob_start(function($text){
    return (str_replace("apples", "oranges", $text));
});

echo "It's like comparing apples to oranges", PHP_EOL;
ob_get_flush();

// It's like comparing oranges to oranges

最后的輸出結果就是將 apples 內容替換成了 oranges 內容。

添加 URL 重寫器

output_add_rewrite_var('var', 'value');
// some links
echo '<a href="file.php">link</a>
<a href="http://example.com">link2</a>';

// <a href="file.php?var=value">link</a>
// <a href="http://example.com">link2</a>

// a form
echo '<form action="script.php" method="post">
<input type="text" name="var2" />
</form>';

// <form action="script.php" method="post">
// <input type="hidden" name="var" value="value" />
// <input type="text" name="var2" />
// </form>

上面的代碼看出什么端倪了嘛？沒錯，使用 output_add_rewrite_var() 函數，我們可以在 PHP 輸出的時候為 HTML 的鏈接或者表單代碼增加一個參數。有沒有想到什么使用場景？POST 表單的 CSRF 攻擊的防范。

這個函數會根據 php.ini 文件中的 url_rewriter.tags 配置項來進行添加，在默認情況下這個配置項只支持 from 表單，同時，它還可以支持 a 標簽的href 、 area標簽的href 、 frame標簽的src 、 input標簽的src 等等。也就是說，會在這些標簽相對應的屬性中自動添加字段。當然，它也有一個反函數 output_reset_rewrite_vars() 用于取消之前增加的這個參數。