PEAR_Config::setInstallRoot

PEAR_Config::setInstallRoot() – setInstallRoot

Synopsis

require_once '/Config.php'; (since PEAR 1.4.0)

void PEAR_Config::setInstallRoot ( string|false $root )

Description

インストール時の --installroot オプションを実装する際に使用します。 以前のバージョンの PEAR では、この機能は PEAR_Installer::install() で実装されていました。しかし、これではチャネルに対応することが困難であることから、 よりよいカプセル化を行うために PEAR_Config に移動されました。

パスはフルパスで指定します。ディレクトリを指定するあらゆる設定項目に対して、 このメソッドで指定した installroot が先頭に付加されます。例えば、 php_dir/usr/lib/php に設定されており、 setInstallRoot()/hoopla/boo を設定した場合、 get() が返す設定値は /hoopla/boo/usr/lib/php となります。 installroot をリセットするには、空の文字列 '' を使用します。

Parameter

string|FALSE $root

すべての _dir 変数の先頭に付加するインストールディレクトリ。 無効にするには FALSE を指定します。

Throws

例外はスローされません。

Note

This function can not be called statically.