Class: PEAR_Frontend

Source Location: /PEAR-1.4.3/PEAR/Frontend.php

Class Overview

PEAR
   |
   --PEAR_Frontend

Singleton-based frontend for PEAR user input/output

Author(s):

Greg Beaver <cellog at php.net>

Version:

Release: 1.4.3

Copyright:

1997-2005 The PHP Group

Methods

Child classes:

PEAR_Frontend_CLI: Command-line Frontend for the PEAR Installer

Inherited Variables

Inherited Methods

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 46]
Singleton-based frontend for PEAR user input/output

Author: Greg Beaver <cellog@php.net>
Version: Release: 1.4.3
Copyright: 1997-2005 The PHP Group
Link: http://pear.php.net/package/PEAR
Since: Class available since Release 1.4.0a1
License: PHP License 3.0

[ Top ]

Method Detail

addTempFile [line 133]

void addTempFile(

$file)

This can be overridden to allow session-based temporary file management

By default, all files are deleted at the end of a session. The web installer needs to be able to sustain a list over many sessions in order to support user interaction with install scripts

Parameters:

$file —

[ Top ]

isIncludeable [line 101]

boolean isIncludeable(
string
$path)

Parameters:

string $path — relative or absolute include path

[ Top ]

log [line 138]

void log(

$level, 
$msg, [
$append_crlf = true])

Overridden in child classes as:

PEAR_Frontend_CLI::log()

Parameters:

	`$level`	—
	`$msg`	—
	`$append_crlf`	—

[ Top ]

setConfig [line 122]

void setConfig(
PEAR_Config
&$config)

Parameters:

PEAR_Config &$config —

[ Top ]

setFrontendClass [line 67]

void &setFrontendClass(

$uiclass)

Parameters:

$uiclass —

[ Top ]

singleton [line 53]

PEAR_Frontend_CLI|PEAR_Frontend_Web|PEAR_Frontend_Gtk &singleton(
[
$type = null])

Retrieve the frontend object

Parameters:

$type —

[ Top ]