Class PEAR_Command_Install

Description

PEAR commands for installation or deinstallation/upgrading of packages.

Located in /maintenance/libraries/pear/PEAR/Command/Install.php (line 29)

PEAR
   |
   --PEAR_Command_Common
      |
      --PEAR_Command_Install
Variable Summary
 mixed $commands
Method Summary
 PEAR_Command_Install PEAR_Command_Install (mixed &$ui, mixed &$config)
 void doBundle (mixed $command, mixed $options, mixed $params)
 void doInstall (mixed $command, mixed $options, mixed $params)
 void doUninstall (mixed $command, mixed $options, mixed $params)
Variables
mixed $commands = array(
'install' => array(
'summary' => 'Install Package',
'function' => 'doInstall',
'shortcut' => 'i',
'options' => array(
'force' => array(
'shortopt' => 'f',
'doc' => 'will overwrite newer installed packages',
),'nodeps'=>array('shortopt'=>'n','doc'=>'ignore dependencies, install anyway',),'register-only'=>array('shortopt'=>'r','doc'=>'do not install files, only register the package as installed',),'soft'=>array('shortopt'=>'s','doc'=>'soft install, fail silently, or upgrade if already installed',),'nobuild'=>array('shortopt'=>'B','doc'=>'don\'t build C extensions',),'nocompress'=>array('shortopt'=>'Z','doc'=>'request uncompressed files when downloading',),'installroot'=>array('shortopt'=>'R','arg'=>'DIR','doc'=>'root directory used when installing files (ala PHP\'s INSTALL_ROOT)',),'ignore-errors'=>array('doc'=>'force install even if there were errors',),'alldeps'=>array('shortopt'=>'a','doc'=>'install all required and optional dependencies',),'onlyreqdeps'=>array('shortopt'=>'o','doc'=>'install all required dependencies',),),'doc'=>'<package> ...
Installs one or more PEAR packages. You can specify a package to
install in four ways:

"Package-1.0.tgz" : installs from a local file

"http://example.com/Package-1.0.tgz" : installs from
anywhere on the net.

"package.xml" : installs the package described in
package.xml. Useful for testing, or for wrapping a PEAR package in
another package manager such as RPM.

"Package" : queries your configured server
({config master_server}) and downloads the newest package with
the preferred quality/state ({config preferred_state}).

More than one package may be specified at once. It is ok to mix these
four ways of specifying packages.
'),'upgrade'=>array('summary'=>'Upgrade Package','function'=>'doInstall','shortcut'=>'up','options'=>array('force'=>array('shortopt'=>'f','doc'=>'overwrite newer installed packages',),'nodeps'=>array('shortopt'=>'n','doc'=>'ignore dependencies, upgrade anyway',),'register-only'=>array('shortopt'=>'r','doc'=>'do not install files, only register the package as upgraded',),'nobuild'=>array('shortopt'=>'B','doc'=>'don\'t build C extensions',),'nocompress'=>array('shortopt'=>'Z','doc'=>'request uncompressed files when downloading',),'installroot'=>array('shortopt'=>'R','arg'=>'DIR','doc'=>'root directory used when installing files (ala PHP\'s INSTALL_ROOT)',),'ignore-errors'=>array('doc'=>'force install even if there were errors',),'alldeps'=>array('shortopt'=>'a','doc'=>'install all required and optional dependencies',),'onlyreqdeps'=>array('shortopt'=>'o','doc'=>'install all required dependencies',),),'doc'=>'<package> ...
Upgrades one or more PEAR packages. See documentation for the
"install" command for ways to specify a package.

When upgrading, your package will be updated if the provided new
package has a higher version number (use the -f option if you need to
upgrade anyway).

More than one package may be specified at once.
'),'upgrade-all'=>array('summary'=>'Upgrade All Packages','function'=>'doInstall','shortcut'=>'ua','options'=>array('nodeps'=>array('shortopt'=>'n','doc'=>'ignore dependencies, upgrade anyway',),'register-only'=>array('shortopt'=>'r','doc'=>'do not install files, only register the package as upgraded',),'nobuild'=>array('shortopt'=>'B','doc'=>'don\'t build C extensions',),'nocompress'=>array('shortopt'=>'Z','doc'=>'request uncompressed files when downloading',),'installroot'=>array('shortopt'=>'R','arg'=>'DIR','doc'=>'root directory used when installing files (ala PHP\'s INSTALL_ROOT)',),'ignore-errors'=>array('doc'=>'force install even if there were errors',),),'doc'=>'
Upgrades all packages that have a newer release available. Upgrades are
done only if there is a release available of the state specified in
"preferred_state" (currently {config preferred_state}), or a state considered
more stable.
'),'uninstall'=>array('summary'=>'Un-install Package','function'=>'doUninstall','shortcut'=>'un','options'=>array('nodeps'=>array('shortopt'=>'n','doc'=>'ignore dependencies, uninstall anyway',),'register-only'=>array('shortopt'=>'r','doc'=>'do not remove files, only register the packages as not installed',),'installroot'=>array('shortopt'=>'R','arg'=>'DIR','doc'=>'root directory used when installing files (ala PHP\'s INSTALL_ROOT)',),'ignore-errors'=>array('doc'=>'force install even if there were errors',),),'doc'=>'<package> ...
Uninstalls one or more PEAR packages. More than one package may be
specified at once.
'),'bundle'=>array('summary'=>'Unpacks a Pecl Package','function'=>'doBundle','shortcut'=>'bun','options'=>array('destination'=>array('shortopt'=>'d','arg'=>'DIR','doc'=>'Optional destination directory for unpacking (defaults to current path or "ext" if exists)',),'force'=>array('shortopt'=>'f','doc'=>'Force the unpacking even if there were errors in the package',),),'doc'=>'<package>
Unpacks a Pecl Package into the selected location. It will download the
package if needed.
'),)
(line 33)

Inherited Variables

Inherited from PEAR_Command_Common

PEAR_Command_Common::$config
PEAR_Command_Common::$ui
PEAR_Command_Common::$_deps_rel_trans
PEAR_Command_Common::$_deps_type_trans
Methods
Constructor PEAR_Command_Install (line 204)

PEAR_Command_Install constructor.

  • access: public
PEAR_Command_Install PEAR_Command_Install (mixed &$ui, mixed &$config)
doBundle (line 341)
void doBundle (mixed $command, mixed $options, mixed $params)
doInstall (line 213)
void doInstall (mixed $command, mixed $options, mixed $params)
doUninstall (line 293)
void doUninstall (mixed $command, mixed $options, mixed $params)

Inherited Methods

Inherited From PEAR_Command_Common

 PEAR_Command_Common::PEAR_Command_Common()
 PEAR_Command_Common::getCommands()
 PEAR_Command_Common::getGetoptArgs()
 PEAR_Command_Common::getHelp()
 PEAR_Command_Common::getHelpArgs()
 PEAR_Command_Common::getOptions()
 PEAR_Command_Common::getShortcuts()
 PEAR_Command_Common::run()

Documentation generated on Fri, 3 Dec 2004 12:26:53 +0000 by phpDocumentor 1.3.0RC3