Class: PEAR_Frontend_CLI

Source Location: /PEAR-1.4.10RC1/PEAR/Frontend/CLI.php

Class Overview

PEAR
   |
   --PEAR_Frontend
      |
      --PEAR_Frontend_CLI

Command-line Frontend for the PEAR Installer

Author(s):

Greg Beaver <cellog at php.net>
Stig Bakken <ssb at php.net>

Version:

Release: @package_version@

Copyright:

1997-2006 The PHP Group

Inherited Variables

Inherited Methods

Class: PEAR_Frontend

PEAR_Frontend::addTempFile(): This can be overridden to allow session-based temporary file management
PEAR_Frontend::isIncludeable()
PEAR_Frontend::log()
PEAR_Frontend::setConfig()
PEAR_Frontend::setFrontendClass(): Set the frontend class that will be used by calls to singleton()
PEAR_Frontend::setFrontendObject(): Set the frontend class that will be used by calls to singleton()
PEAR_Frontend::singleton(): Retrieve the frontend object

Class: PEAR

PEAR::PEAR(): Constructor. Registers this object in $_PEAR_destructor_object_list for destructor emulation if a destructor object exists.
PEAR::delExpect(): This method deletes all occurences of the specified element from the expected error codes stack.
PEAR::expectError(): This method is used to tell which errors you expect to get.
PEAR::getStaticProperty(): If you have a class that's mostly/entirely static, and you need static
PEAR::isError(): Tell whether a value is a PEAR error.
PEAR::loadExtension(): OS independant PHP extension load. Remember to take care on the correct extension name for case sensitive OSes.
PEAR::popErrorHandling(): Pop the last error handler used
PEAR::popExpect(): This method pops one element off the expected error codes stack.
PEAR::pushErrorHandling(): Push a new error handler on top of the error handler options stack. With this you can easily override the actual error handler for some code and restore it later with popErrorHandling.
PEAR::raiseError(): This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied. If the $mode and $options parameters are not specified, the object's defaults are used.
PEAR::registerShutdownFunc(): Use this function to register a shutdown method for static classes.
PEAR::setErrorHandling(): Sets how errors generated by this object should be handled.
PEAR::staticPopErrorHandling()
PEAR::staticPushErrorHandling()
PEAR::throwError(): Simpler form of raiseError with fewer options. In most cases message, code and userinfo are enough.
PEAR::_PEAR(): Destructor (the emulated type of...). Does nothing right now, but is included for forward compatibility, so subclass destructors should always call it.

Class Details

[line 40]
Command-line Frontend for the PEAR Installer

Author: Greg Beaver <cellog@php.net>
Author: Stig Bakken <ssb@php.net>
Version: Release: @package_version@
Copyright: 1997-2006 The PHP Group
Link: http://pear.php.net/package/PEAR
Since: Class available since Release 0.1
License: PHP License 3.0

[ Top ]

Class Variables

$lp = ''

[line 50]

Type:

mixed

[ Top ]

$params = array()

[line 52]

Type:

mixed

[ Top ]

$term = array(
        'bold' => '',
        'normal' => '',
        )

[line 53]

Type:

mixed

[ Top ]

$type = 'CLI'

[line 49]

What type of user interface this frontend is for.

Access: public

Type:

string

[ Top ]

Method Detail

PEAR_Frontend_CLI (Constructor) [line 62]

PEAR_Frontend_CLI PEAR_Frontend_CLI(
)

[ Top ]

bold [line 731]

void bold(

$text)

Parameters:

$text —

[ Top ]

confirmDialog [line 299]

array confirmDialog(
array
$params)

Ask for user input, confirm the answers and continue until the user is satisfied

Parameters:

array $params — an array of arrays, format array('name' => 'paramname', 'prompt' => 'text to display', 'type' => 'string'[, default => 'default value'])

[ Top ]

display [line 99]

void display(

$text)

Parameters:

$text —

[ Top ]

displayError [line 115]

void displayError(
object PEAR_Error
$eobj)

Parameters:

object PEAR_Error $eobj — object

[ Top ]

displayFatalError [line 126]

void displayFatalError(
object PEAR_Error
$eobj)

Parameters:

object PEAR_Error $eobj — object

[ Top ]

displayHeading [line 157]

void displayHeading(

$title)

Parameters:

$title —

[ Top ]

displayLine [line 86]

void displayLine(

$text)

Parameters:

$text —

[ Top ]

endTable [line 488]

void endTable(
)

[ Top ]

log [line 719]

void log(

$text, [
$append_crlf = true])

Overrides PEAR_Frontend::log() (parent method not documented)

Parameters:

	`$text`	—
	`$append_crlf`	—

[ Top ]

outputData [line 594]

void outputData(

$data, [
$command = '_default'])

Parameters:

	`$data`	—
	`$command`	—

[ Top ]

runInstallScript [line 196]

void runInstallScript(
array
$xml, 
&$script, object
$script, string
2)

Parameters:

array	`$xml`	—	contents of postinstallscript tag
object	`$script`	—	post-installation script
string	`2`	—	install\|upgrade
	`&$script`	—

[ Top ]

runPostinstallScripts [line 184]

void runPostinstallScripts(

&$scripts)

Parameters:

&$scripts —

[ Top ]

skipParamgroup [line 179]

void skipParamgroup(
string
$id)

Instruct the runInstallScript method to skip a paramgroup that matches the id value passed in.

This method is useful for dynamically configuring which sections of a post-install script will be run based on the user's setup, which is very useful for making flexible post-install scripts without losing the cross-Frontend ability to retrieve user input

Parameters:

string $id —

[ Top ]

startTable [line 416]

void startTable(
[
$params = array()])

Parameters:

$params —

[ Top ]

tableRow [line 433]

void tableRow(

$columns, [
$rowparams = array()], [
$colparams = array()])

Parameters:

	`$columns`	—
	`$rowparams`	—
	`$colparams`	—

[ Top ]

userConfirm [line 388]

void userConfirm(

$prompt, [
$default = 'yes'])

Parameters:

	`$prompt`	—
	`$default`	—

[ Top ]

userDialog [line 340]

void userDialog(

$command, 
$prompts, [
$types = array()], [
$defaults = array()])

Parameters:

	`$command`	—
	`$prompts`	—
	`$types`	—
	`$defaults`	—

[ Top ]

Class: PEAR_Frontend_CLI

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class: PEAR_Frontend

Class: PEAR

Class Details

Class Variables

$lp = ''

$params = array()

$term = array( 'bold' => '', 'normal' => '', )

$type = 'CLI'

Method Detail

PEAR_Frontend_CLI (Constructor) [line 62]

bold [line 731]

Parameters:

confirmDialog [line 299]

Parameters:

display [line 99]

Parameters:

displayError [line 115]

Parameters:

displayFatalError [line 126]

Parameters:

displayHeading [line 157]

Parameters:

displayLine [line 86]

Parameters:

endTable [line 488]

log [line 719]

Parameters:

outputData [line 594]

Parameters:

runInstallScript [line 196]

Parameters:

runPostinstallScripts [line 184]

Parameters:

skipParamgroup [line 179]

Parameters:

startTable [line 416]

Parameters:

tableRow [line 433]

Parameters:

userConfirm [line 388]

Parameters:

userDialog [line 340]

Parameters:

$term = array(
'bold' => '',
'normal' => '',
)