PEAR_PackageUpdate::loadPreferences --
設定ファイルから利用者の設定を読み込む
説明
設定ファイルから利用者の設定を読み込みます。
利用者が Windows を使用している場合、設定内容は
PEAR_CONFIG_SYSCONFIG ディレクトリ内のファイル
ppurc.ini に保存されます。
その他の OS を使用している場合、設定内容はホームディレクトリ内のファイル .ppurc
に保存されます。このファイルには設定内容の配列をシリアライズしたものが保存されており、
各パッケージについての更新確認の設定が含まれます。
注意
バージョン 0.7.0 以降では、設定内容の保存場所として別のディレクトリやファイル名を指定することが可能です。
これは、オプションのパラメータ $pref_file で指定します。
パラメータ
- string $pref_file
利用者の設定を読み込むファイルへのパス。
例外・エラー
利用者の設定ファイルに対する読み込みアクセス権限がない場合に
PEAR_PACKAGEUPDATE_ERROR_PREFFILE_READACCESS
をスローします。
利用者の設定ファイルが無効な形式である場合に
PEAR_PACKAGEUPDATE_ERROR_PREFFILE_CORRUPTED
をスローします。
パラメータ $pref_file で指定したファイルが存在しない場合に
PEAR_PACKAGEUPDATE_ERROR_INVALIDINIFILE
をスローします。
注意
since 0.4.0a1
この関数は、スタティックにコールする
ことはできません。
返り値
boolean - 設定の読み込みに成功した場合に TRUE、
それ以外の場合に FALSE を返します。