Phar::setDefaultStub
(PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0)
Phar::setDefaultStub — Phar アーカイブの PHP ローダー (起動スタブ) をデフォルトのローダーに設定する
説明
public Phar::setDefaultStub
([ string $index
[, string $webindex
]] ) : bool
注意:
このメソッドは、
php.ini
のphar.readonly
が0
でないと Phar オブジェクトで動作しません。それ以外の場合は PharException がスローされます。
このメソッドは、 Phar::createDefaultStub() と Phar::setStub() の両方の機能を組み合わせた便利なメソッドです。
パラメータ
index
- コマンドラインからアクセスした場合に実行する、 phar アーカイブ内の相対パス。
webindex
- ウェブブラウザからアクセスした場合に実行する、 phar アーカイブ内の相対パス。
返り値
成功した場合に true
を、失敗した場合に false
を返します。
エラー / 例外
phar.readonly が php.ini で有効になっている場合に UnexpectedValueException をスローします。 変更内容をディスクに書き込む際にエラーが発生した場合は PharException をスローします。
例
例1 Phar::setDefaultStub() の例
<?phptry { $phar = new Phar('myphar.phar'); $phar->setDefaultStub('cli.php', 'web/index.php'); // これは、以下と同じ意味です // $phar->setStub($phar->createDefaultStub('cli.php', 'web/index.php'));} catch (Exception $e) { // エラー処理}?>
参考
- Phar::setStub() - Phar アーカイブの PHP ローダ (あるいは起動スタブ) を設定する
- Phar::createDefaultStub() - phar ファイルフォーマット用のスタブを作成する