Class Ethna_PearWrapper

Description

wrapper class for PEAR_Command This class should be instantiated in ethna handler.

Located in /class/PearWrapper.php (line 26)


	
			
Variable Summary
 mixed $channel
 mixed $config
 mixed $registry
 mixed $target
 mixed $target_ctl
 mixed $ui
 mixed $_pearopt
Method Summary
 static string getPackageNameFromTgz (string $filename)
 Ethna_PearWrapper __construct ()
 bool confirmDialog ( $message, [ $default = 'yes'])
 void displayTable ( $caption, array $headline, array $rows)
 true|Ethna_Error doInfo (string $package)
 true|Ethna_Error doInstall (string $pkg_name, [string $state = null])
 true|Ethna_Error doInstallFromTgz (string $pkg_file)
 true|Ethna_Error doRemoteInfo (string $package)
 true|Ethna_Error doUninstall ( $package)
 true|Ethna_Error doUpgrade (string $pkg_name, [string $state = null])
 true|Ethna_Error doUpgradeFromTgz (string $pkg_file)
 string getCanonicalPackageName (string $package)
 string getState (string $package)
 string getVersion (string $package)
 true|Ethna_Error init (string $target, [string|null $app_dir = null], [string|null $channel = null])
 bool isChannelExists ()
 bool isInstalled (string $package)
 void setPearOpt ( $pearopt)
 true|Ethna_Error _run (string $command, array $options, array $params)
Variables
mixed $channel (line 34)
  • access: protected
mixed $config (line 43)
  • access: protected
mixed $registry (line 46)
  • access: protected
mixed $target (line 37)
  • access: protected
mixed $target_ctl (line 40)
  • access: protected
mixed $ui (line 49)
  • access: protected
mixed $_pearopt (line 52)
  • access: protected
Methods
static getPackageNameFromTgz (line 452)

get package info from tar/tgz file.

  • return: package name
  • access: public
string getPackageNameFromTgz (string $filename)
  • string $filename: package file name.
Constructor __construct (line 63)

Ethna_PearWrapper constructor

  • access: public
Ethna_PearWrapper __construct ()
confirmDialog (line 607)

provide yes-or-no dialog.

  • access: public
bool confirmDialog ( $message, [ $default = 'yes'])
  • $message
  • $default
displayTable (line 620)

provide table layout

  • access: public
void displayTable ( $caption, array $headline, array $rows)
  • array $headline: headline
  • array $rows: rows which have the same size as headline's.
  • $caption
doChannelDiscover (line 247)

do channel-discover

  • access: public
true|Ethna_Error doChannelDiscover ()
doChannelUpdate (line 276)

do channel-update

  • access: public
true|Ethna_Error doChannelUpdate ()
doClearCache (line 230)

do clear-cache

  • access: public
true|Ethna_Error doClearCache ()
doInfo (line 508)

do info (packages installed with ethna command)

  • access: public
true|Ethna_Error doInfo (string $package)
  • string $package: package name.
doInstall (line 321)

do install

  • access: public
true|Ethna_Error doInstall (string $pkg_name, [string $state = null])
  • string $pkg_name: package name.
  • string $state: package state.
doInstallFromTgz (line 339)

do install from local tgz file

  • access: public
true|Ethna_Error doInstallFromTgz (string $pkg_file)
  • string $pkg_file: package filename
doList (line 545)

do list (packages installed with ethna command)

  • access: public
true|Ethna_Error doList ()
doRemoteInfo (line 521)

do info (packages installable with ethna command)

  • access: public
true|Ethna_Error doRemoteInfo (string $package)
  • string $package: package name.
doRemoteList (line 557)

do remote-list (packages installable with ethna command)

  • access: public
true|Ethna_Error doRemoteList ()
doUninstall (line 426)

do uninstall (packages installed with ethna command)

  • access: public
true|Ethna_Error doUninstall ( $package)
  • $package
doUpgrade (line 354)

do upgrade

  • access: public
true|Ethna_Error doUpgrade (string $pkg_name, [string $state = null])
  • string $pkg_name: package name.
  • string $state: package state.
doUpgradeAll (line 533)

do upgrade-all

  • access: public
true|Ethna_Error doUpgradeAll ()
doUpgradeFromTgz (line 372)

do upgrade from local tgz file

  • access: public
true|Ethna_Error doUpgradeFromTgz (string $pkg_file)
  • string $pkg_file: package filename
getCanonicalPackageName (line 473)

get canonical package name (case sensitive)

  • return: canonical name
  • access: public
string getCanonicalPackageName (string $package)
  • string $package: package name.
getInstalledPackageList (line 491)

get installed package list

  • return: installed package list
  • access: public
array getInstalledPackageList ()
getState (line 413)

get package version

  • return: version string
  • access: public
string getState (string $package)
  • string $package: package name
getVersion (line 399)

get package version

  • return: version string
  • access: public
string getVersion (string $package)
  • string $package: package name
init (line 81)

setup PEAR_Config and so on.

  • access: public
true|Ethna_Error init (string $target, [string|null $app_dir = null], [string|null $channel = null])
  • string $target: whether 'master' or 'local'
  • string|null $app_dir: local application directory.
  • string|null $channel: channel for the package repository.
isChannelExists (line 264)

whether channel discovered or not

  • access: public
bool isChannelExists ()
isInstalled (line 386)

check package installed

  • access: public
bool isInstalled (string $package)
  • string $package: package name
setPearOpt (line 638)

(experimental)

  • access: public
void setPearOpt ( $pearopt)
  • $pearopt
_run (line 574)

run PEAR_Command.

  • see: PEAR_Command_Common::run, etc.
  • access: protected
true|Ethna_Error _run (string $command, array $options, array $params)
  • string $command: command name
  • array $options: options
  • array $params: parameters
_setLocalConfig (line 167)

config for local.

  • access: protected
true|Ethna_Error _setLocalConfig ()

Documentation generated on Fri, 11 Nov 2011 03:58:53 +0900 by phpDocumentor 1.4.3