Introduction to PEAR_PackageUpdate (Previous) (Next) PEAR_PackageUpdate::isIncludable
View this page in Last updated: Sun, 28 Sep 2008
English | French | German | Hungarian | Japanese | Polish | Spanish | Plain HTML

PEAR_PackageUpdate::factory

PEAR_PackageUpdate::factory --  Factory method for creating PEAR_PackageUpdate frontend instances.

Synopsis

require_once 'PEAR/PackageUpdate.php';

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

Description

Factory method for creating PEAR_PackageUpdate frontend instances.

Parameter

string $driver

The name of a frontend driver class. Must be one of Gtk2, Cli, or Web.

string $packageName

The name of the package to be updated. Example: PEAR_PackageFileManager_Web.

string $channel

The name of the channel $packageName is hosted on. This may be a fully qualified channel name such as pear.php.net or a short channel name like pear.

string $user_file

The path to the file to read PEAR user-defined options from.

string $system_file

The path to the file to read PEAR system-wide defaults from.

string $pref_file

The path to the file to read user's preferences from.

Throws

throws PEAR_PACKAGEUPDATE_ERROR_NONEXISTENTDRIVER, when invalid driver name is used (i.e. Gtk2, Cli, Web).

Note

since 0.4.0a1

This function should be called statically.

Return value

mixed - reference to a new object or FALSE if the object could not be created (i.e. invalid driver name).

Introduction to PEAR_PackageUpdate (Previous) (Next) PEAR_PackageUpdate::isIncludable
Download Documentation Last updated: Sun, 28 Sep 2008
Do you think that something on this page is wrong? Please file a bug report or add a note.
User Notes:
There are no user contributed notes for this page.