Phar::addFile

(PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0)

Phar::addFile — ファイルシステム上のファイルを phar アーカイブに追加する

説明

public Phar::addFile ( string $file [, string $localname ] ) : void

注意:

このメソッドは、php.ini の phar.readonly が 0 でないと Phar オブジェクトで動作しません。それ以外の場合は PharException がスローされます。

このメソッドを使用すると、任意のファイルあるいは URL を phar アーカイブに追加することができます。 オプションの 2 番目のパラメータ localname を指定すると、 ファイルはその名前でアーカイブ内に格納されます。指定しなかった場合は、 file パラメータをアーカイブ内のパスとして使用します。 URL を使用する場合は、localname を指定しないと例外がスローされます。 このメソッドは ZipArchive::addFile() と同じようなものです。

パラメータ

file

phar アーカイブに追加したいディスク上のファイルへのフルパスあるいは相対パス。

localname

ファイルをアーカイブ内に格納するときのパス。

返り値

返り値はありません。失敗時には例外をスローします。

例

例1 Phar::addFile() の例

<?php
try {
    $a = new Phar('/path/to/phar.phar');

    $a->addFile('/full/path/to/file');
    // 格納したファイルを確認します
    $b = $a['full/path/to/file']->getContent();

    $a->addFile('/full/path/to/file', 'my/file.txt');
    $c = $a['my/file.txt']->getContent();

    // URL の使用例
    $a->addFile('http://www.example.com', 'example.html');
} catch (Exception $e) {
    // ここでエラー処理をします
}
?>

参考