Phar::loadPhar

(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 1.0.0)

Phar::loadPhar任意の phar アーカイブを、エイリアスを指定して読み込む

説明

final public static Phar::loadPhar(string $filename, ?string $alias = null): bool

これを使用して、外部の Phar アーカイブの内容を読み込むことができます。 phar へのエイリアスを指定することで、その後 phar を使用する場合に短い名前を使用できるので便利です。 また、データのみが含まれており、実行したり インクルードしたりする必要のない PHP スクリプトからなる Phar アーカイブを読み込む際にも便利です。

パラメータ

filename

オープンする phar アーカイブへの完全パスあるいは相対パス。

alias

この phar アーカイブをさす際に使用するエイリアス。 多くの場合は phar アーカイブ内で明示的なエイリアスを指定しており、 このような場合に新しいエイリアスを指定すると、 PharException がスローされます。

戻り値

成功した場合に true を、失敗した場合に false を返します。

エラー / 例外

すでに明示的なエイリアスを持っている phar アーカイブに対してエイリアスを渡すと、 PharException がスローされます。

例1 Phar::loadPhar() の例

Phar::loadPhar を使用すると、任意の場所にある外部の Phar アーカイブを読み込めます。 一方 Phar::mapPhar は Phar ローダのスタブ内で使用します。

<?php
try {
    
Phar::loadPhar('/path/to/phar.phar''my.phar');
    echo 
file_get_contents('phar://my.phar/file.txt');
} catch (
PharException $e) {
    echo 
$e;
}
?>

参考

  • Phar::mapPhar() - 現在実行されている (phar 形式の) ファイルを読み込み、その内容を登録する

関連キーワード:  phar, アーカイブ, Phar, 任意, 指定, loadPhar, mapPhar, 外部, スロー, PharException