トップページ　→関数リファレンス　→圧縮およびアーカイブ　→Phar　→Phar

関数・クラス解説

Phar::startBuffering

version:PHP 5 >= 5.3.0, PHP 7, PECL phar (公式)

Phar の書き込み操作のバッファリングを開始するが、ディスク上の Phar オブジェクトは変更しない

公式リファレンス

書式

public Phar::startBuffering ( ) : void

説明

技術的には必須ではありませんが、Phar::startBuffering() メソッドを使用すると、大量のファイルを含む Phar アーカイブの作成や変更が非常に高速になります。通常は、Phar アーカイブ内のファイルが作成あるいは変更されるたびに Phar アーカイブ全体を改めて作り直します。これによって、アーカイブが常に最新の状態となります。

しかし、単に新しい Phar アーカイブを作りたいときやアーカイブ全体を一度に書き出したいときなどは、これは不要です。同様に、いくつかの変更を行うときに、すべての変更がうまくいったことを確認してから実際にディスクに書き込みたいということもあるでしょう。これは、ちょうどデータベースのトランザクションの概念と同じようなものです。 Phar::startBuffering()/Phar::stopBuffering() の両メソッドが、このような場合のために用意されています。

Phar の書き込みバッファリングはアーカイブ単位で処理されます。 Phar アーカイブ foo.phar でバッファリングが有効であったとしても、それは Phar アーカイブ bar.phar の変更には影響しません。

返値

値を返しません。

サンプル

例1 Phar::startBuffering() の例 

// 確実に消しておきます
@unlink('brandnewphar.phar');
try {
    $p = new Phar(dirname(__FILE__) . '/brandnewphar.phar', 0, 'brandnewphar.phar');
} catch (Exception $e) {
    echo 'phar を作成できません:', $e;
}
echo '新しい phar のエントリ数は ' . $p->count() . " です\n";
$p->startBuffering();
$p['file.txt'] = 'hi';
$p['file2.txt'] = 'there';
$p['file2.txt']->setCompressedGZ();
$p['file3.txt'] = 'babyface';
$p['file3.txt']->setMetadata(42);
$p->setStub("stopBuffering();