Phar::mount

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

Phar::mount — 外部のパスあるいはファイルを phar アーカイブ内に仮想的にマウントする

説明

final public static Phar::mount(string $pharPath, string $externalPath): void

Unix のファイルシステムで外部のデバイスをディレクトリツリー上にマウントできるのと同様に、 Phar::mount() を使用すると外部のファイルやディレクトリをあたかもアーカイブ内にあるかのように参照することができるようになります。これを使用すると、外部の設定ファイルをアーカイブ内にあるかのように扱うなどの高度な抽象化が可能となります。

パラメータ

pharPath: マウントする場所として使用する phar アーカイブ内のパス。これは phar アーカイブ内の相対パスでなければならず、また、既に存在するパスを指定することはできません。
externalPath: phar アーカイブ内にマウントしたい外部ファイルあるいはディレクトリのパスあるいは URL。

戻り値

戻り値はありません。失敗した場合は PharException をスローします。

エラー / 例外

パスのマウント時に問題が発生した場合は PharException をスローします。

例

例1 Phar::mount() の例

次の例は、外部の設定ファイルをまるでそれが phar アーカイブ内のパス上にあるかのように扱うものです。

まず、phar アーカイブ内のコードを示します。

<?php
$configuration = simplexml_load_string(file_get_contents(
    Phar::running(false) . '/config.xml'));
?>

次は、設定ファイルをマウントする外部コードです。

<?php
// まずは、抽象化した config.xml
// と実際のディスク上のファイルを関連づけます
Phar::mount('phar://config.xml', '/home/example/config.xml');
// アプリケーションを実行します
include '/path/to/archive.phar';
?>

もうひとつの方法として、コードを phar アーカイブのスタブ内に置くというものがあります。これは、ユーザーが設定ファイルを指定しなかった場合にデフォルトの設定ファイルを使用する例です。

<?php
// まずは、抽象化した config.xml
// と実際のディスク上のファイルを関連づけます
if (defined('EXTERNAL_CONFIG')) {
    Phar::mount('config.xml', EXTERNAL_CONFIG);
    if (file_exists(__DIR__ . '/extra_config.xml')) {
        Phar::mount('extra.xml', __DIR__ . '/extra_config.xml');
    }
} else {
    Phar::mount('config.xml', 'phar://' . __FILE__ . '/default_config.xml');
    Phar::mount('extra.xml', 'phar://' . __FILE__ . '/default_extra.xml');
}
// アプリケーションを実行します
include 'phar://' . __FILE__ . '/index.php';
__HALT_COMPILER();
?>

...and the code externally to load this phar archive:

<?php
define('EXTERNAL_CONFIG', '/home/example/config.xml');
// アプリケーションを実行します
include '/path/to/archive.phar';
?>