PEAR_PackageUpdate::factory

PEAR_PackageUpdate::factory --  PEAR_PackageUpdate フロントエンドのインスタンスを作成するためのファクトリメソッド

概要

require_once 'PEAR/PackageUpdate.php';

mixed PEAR_PackageUpdate::factory (string $driver, string $packageName, string $channel [, string $user_file = '' [, string $system_file = '' [, string $pref_file = '']]])

説明

PEAR_PackageUpdate フロントエンドのインスタンスを作成するためのファクトリメソッドです。

パラメータ

string $driver

フロントエンドドライバクラスの名前。 Gtk2Cli あるいは Web のいずれかでなければなりません。

string $packageName

更新するパッケージの名前。たとえば PEAR_PackageFileManager_Web など。

string $channel

$packageName が公開されているチャネルの名前。 pear.php.net のような完全修飾形式の名前か、あるいは pear のような短縮名を指定します。

string $user_file

PEAR のユーザ定義オプションを読み込むファイルへのパス。

string $system_file

PEAR のシステム全体のデフォルト設定を読み込むファイルへのパス。

string $pref_file

ユーザの設定を読み込むファイルへのパス。

例外・エラー

無効なドライバ名 (Gtk2、Cli、Web 以外) を指定した場合に PEAR_PACKAGEUPDATE_ERROR_NONEXISTENTDRIVER をスローします。

注意

since 0.4.0a1

この関数は、スタティックにコール されます。

返り値

mixed - 新しいオブジェクトへの参照、 あるいはオブジェクトが作成できなかった場合 (ドライバ名が無効の場合など) に FALSE を返します。