Inheritance diagram for PEAR:

Collaboration diagram for PEAR:

Public Member Functions
	PEAR ($error_class=null)
	Constructor.
	_PEAR ()
	Destructor (the emulated type of...).
&	getStaticProperty ($class, $var)
	If you have a class that's mostly/entirely static, and you need static properties, you can use this method to simulate them.
	registerShutdownFunc ($func, $args=array())
	Use this function to register a shutdown method for static classes.
	isError ($data, $code=null)
	Tell whether a value is a PEAR error.
	setErrorHandling ($mode=null, $options=null)
	Sets how errors generated by this object should be handled.
	expectError ($code= '*')
	This method is used to tell which errors you expect to get.
	popExpect ()
	This method pops one element off the expected error codes stack.
	_checkDelExpect ($error_code)
	This method checks unsets an error code if available.
	delExpect ($error_code)
	This method deletes all occurences of the specified element from the expected error codes stack.
&	raiseError ($message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false)
	This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied.
&	throwError ($message=null, $code=null, $userinfo=null)
	Simpler form of raiseError with fewer options.
	staticPushErrorHandling ($mode, $options=null)
	staticPopErrorHandling ()
	pushErrorHandling ($mode, $options=null)
	Push a new error handler on top of the error handler options stack.
	popErrorHandling ()
	Pop the last error handler used.
	loadExtension ($ext)
	OS independant PHP extension load.

Data Fields
	$_debug = false
	$_default_error_mode = null
	$_default_error_options = null
	$_default_error_handler = ''
	$_error_class = 'PEAR_Error'
	$_expected_errors = array()

Detailed Description

Definition at line 102 of file PEAR.php.

Member Function Documentation

PEAR::_checkDelExpect ( $error_code )

This method checks unsets an error code if available.

Parameters

mixed error code

Returns: bool true if the error code was unset, false otherwise private

Since: PHP 4.3.0

Definition at line 425 of file PEAR.php.

Referenced by delExpect().

    {
        $deleted = false;
        foreach ($this->_expected_errors AS $key => $error_array) {
            if (in_array($error_code, $error_array)) {
                unset($this->_expected_errors[$key][array_search($error_code, $error_array)]);
                $deleted = true;
            }
            // clean up empty arrays
            if (0 == count($this->_expected_errors[$key])) {
                unset($this->_expected_errors[$key]);
            }
        }
        return $deleted;
    }

Here is the caller graph for this function:

PEAR::_PEAR ( )

Destructor (the emulated type of...).

Does nothing right now, but is included for forward compatibility, so subclass destructors should always call it.

See the note in the class desciption about output from destructors.

public

Returns: void

Definition at line 209 of file PEAR.php.

                     {
        if ($this->_debug) {
            printf("PEAR destructor called, class=%s\n", strtolower(get_class($this)));
        }
    }

PEAR::delExpect ( $error_code )

This method deletes all occurences of the specified element from the expected error codes stack.

Parameters

mixed $error_code error code that should be deleted

Returns: mixed list of error codes that were deleted or error public

Since: PHP 4.3.0

Definition at line 455 of file PEAR.php.

References _checkDelExpect(), and raiseError().

    {
        $deleted = false;
        if ((is_array($error_code) && (0 != count($error_code)))) {
            // $error_code is a non-empty array here;
            // we walk through it trying to unset all
            // values
            foreach($error_code as $key => $error) {
                if ($this->_checkDelExpect($error)) {
                    $deleted =  true;
                } else {
                    $deleted = false;
                }
            }
            return $deleted ? true : PEAR::raiseError("The expected error you submitted does not exist"); // IMPROVE ME
        } elseif (!empty($error_code)) {
            // $error_code comes alone, trying to unset it
            if ($this->_checkDelExpect($error_code)) {
                return true;
            } else {
                return PEAR::raiseError("The expected error you submitted does not exist"); // IMPROVE ME
            }
        } else {
            // $error_code is empty
            return PEAR::raiseError("The expected error you submitted is empty"); // IMPROVE ME
        }
    }

Here is the call graph for this function:

PEAR::expectError ( $code = '*' )

This method is used to tell which errors you expect to get.

Expected errors are always returned with error mode PEAR_ERROR_RETURN. Expected error codes are stored in a stack, and this method pushes a new element onto it. The list of expected errors are in effect until they are popped off the stack with the popExpect() method.

Note that this method can not be called statically

Parameters

mixed $code a single error code or an array of error codes to expect

Returns: int the new depth of the "expected errors" stack public

Definition at line 390 of file PEAR.php.

References $_expected_errors.

Referenced by MDB2_Driver_oci8\nextID(), MDB2_Driver_pgsql\nextID(), MDB2_Driver_mysql\nextID(), and MDB2_Driver_mysqli\nextID().

    {
        if (is_array($code)) {
            array_push($this->_expected_errors, $code);
        } else {
            array_push($this->_expected_errors, array($code));
        }
        return sizeof($this->_expected_errors);
    }

Here is the caller graph for this function:

& PEAR::getStaticProperty	(	$class,
		$var
	)

If you have a class that's mostly/entirely static, and you need static properties, you can use this method to simulate them.

Eg. in your method(s) do this: $myVar = &PEAR::getStaticProperty('myclass', 'myVar'); You MUST use a reference, or they will not persist!

public

Parameters

string	$class	The calling classname, to prevent clashes
string	$var	The variable to retrieve.

Returns: mixed A reference to the variable. If not set it will be auto initialised to NULL.

Definition at line 230 of file PEAR.php.

Referenced by _PEAR_call_destructors(), and PEAR_Error\PEAR_Error().

    {
        static $properties;
        if (!isset($properties[$class])) {
            $properties[$class] = array();
        }
        if (!array_key_exists($var, $properties[$class])) {
            $properties[$class][$var] = null;
        }
        return $properties[$class][$var];
    }

Here is the caller graph for this function:

PEAR::isError	(	$data,
		$code = `null`
	)

Tell whether a value is a PEAR error.

Parameters

mixed	$data	the value to test
int	$code	if $data is an error object, return true only if $code is a string and $obj->getMessage() == $code or $code is an integer and $obj->getCode() == $code public

Returns: bool true if parameter is an error

Definition at line 279 of file PEAR.php.

    {
        if (is_a($data, 'PEAR_Error')) {
            if (is_null($code)) {
                return true;
            } elseif (is_string($code)) {
                return $data->getMessage() == $code;
            } else {
                return $data->getCode() == $code;
            }
        }
        return false;
    }

Here is the caller graph for this function:

PEAR::loadExtension ( $ext )

OS independant PHP extension load.

Remember to take care on the correct extension name for case sensitive OSes.

Parameters

string $ext The extension name

Returns: bool Success or not on the dl() call

Definition at line 745 of file PEAR.php.

Referenced by MDB2_Driver_oci8\_doConnect(), Auth_Container_SAP\Auth_Container_SAP(), MDB2_Driver_mysqli\connect(), MDB2_Driver_mysql\connect(), and MDB2_Driver_pgsql\connect().

    {
        if (!extension_loaded($ext)) {
            // if either returns true dl() will produce a FATAL error, stop that
            if ((ini_get('enable_dl') != 1) || (ini_get('safe_mode') == 1)) {
                return false;
            }
            if (OS_WINDOWS) {
                $suffix = '.dll';
            } elseif (PHP_OS == 'HP-UX') {
                $suffix = '.sl';
            } elseif (PHP_OS == 'AIX') {
                $suffix = '.a';
            } elseif (PHP_OS == 'OSX') {
                $suffix = '.bundle';
            } else {
                $suffix = '.so';
            }
            return @dl('php_'.$ext.$suffix) || @dl($ext.$suffix);
        }
        return true;
    }

Here is the caller graph for this function:

PEAR::PEAR ( $error_class = null )

Constructor.

Registers this object in $_PEAR_destructor_object_list for destructor emulation if a destructor object exists.

Parameters

string $error_class (optional) which class to use for error objects, defaults to PEAR_Error. public

Returns: void

Definition at line 170 of file PEAR.php.

References $GLOBALS.

Referenced by Auth_RADIUS\Auth_RADIUS(), ilBMFBase_Object\ilBMFBase_Object(), ilErrorHandling\ilErrorHandling(), ilSetup\ilSetup(), and ilValidator\ilValidator().

    {
        $classname = strtolower(get_class($this));
        if ($this->_debug) {
            print "PEAR constructor called, class=$classname\n";
        }
        if ($error_class !== null) {
            $this->_error_class = $error_class;
        }
        while ($classname && strcasecmp($classname, "pear")) {
            $destructor = "_$classname";
            if (method_exists($this, $destructor)) {
                global $_PEAR_destructor_object_list;
                $_PEAR_destructor_object_list[] = &$this;
                if (!isset($GLOBALS['_PEAR_SHUTDOWN_REGISTERED'])) {
                    register_shutdown_function("_PEAR_call_destructors");
                    $GLOBALS['_PEAR_SHUTDOWN_REGISTERED'] = true;
                }
                break;
            } else {
                $classname = get_parent_class($classname);
            }
        }
    }

Here is the caller graph for this function:

PEAR::popErrorHandling ( )

Pop the last error handler used.

Returns: bool Always true

See Also: PEAR::pushErrorHandling

Definition at line 721 of file PEAR.php.

References $GLOBALS, $options, and setErrorHandling().

    {
        $stack = &$GLOBALS['_PEAR_error_handler_stack'];
        array_pop($stack);
        list($mode, $options) = $stack[sizeof($stack) - 1];
        array_pop($stack);
        if (isset($this) && is_a($this, 'PEAR')) {
            $this->setErrorHandling($mode, $options);
        } else {
            PEAR::setErrorHandling($mode, $options);
        }
        return true;
    }

Here is the call graph for this function:

PEAR::popExpect ( )

This method pops one element off the expected error codes stack.

Returns: array the list of error codes that were popped

Definition at line 409 of file PEAR.php.

Referenced by MDB2_Driver_oci8\nextID(), MDB2_Driver_pgsql\nextID(), MDB2_Driver_mysql\nextID(), and MDB2_Driver_mysqli\nextID().

    {
        return array_pop($this->_expected_errors);
    }

Here is the caller graph for this function:

PEAR::pushErrorHandling	(	$mode,
		$options = `null`
	)

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.

Parameters

mixed	$mode	(same as setErrorHandling)
mixed	$options	(same as setErrorHandling)

Returns: bool Always true

See Also: PEAR::setErrorHandling

Definition at line 690 of file PEAR.php.

References $_default_error_mode, $_default_error_options, $GLOBALS, $options, and setErrorHandling().

    {
        $stack = &$GLOBALS['_PEAR_error_handler_stack'];
        if (isset($this) && is_a($this, 'PEAR')) {
            $def_mode    = &$this->_default_error_mode;
            $def_options = &$this->_default_error_options;
        } else {
            $def_mode    = &$GLOBALS['_PEAR_default_error_mode'];
            $def_options = &$GLOBALS['_PEAR_default_error_options'];
        }
        $stack[] = array($def_mode, $def_options);
        if (isset($this) && is_a($this, 'PEAR')) {
            $this->setErrorHandling($mode, $options);
        } else {
            PEAR::setErrorHandling($mode, $options);
        }
        $stack[] = array($mode, $options);
        return true;
    }

Here is the call graph for this function:

& PEAR::raiseError	(	$message = `null`,
		$code = `null`,
		$mode = `null`,
		$options = `null`,
		$userinfo = `null`,
		$error_class = `null`,
		$skipmsg = `false`
	)

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.

Parameters

mixed	$message	a text error message or a PEAR error object
int	$code	a numeric error code (it is up to your class to define these if you want to use codes)
int	$mode	One of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT, PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE, PEAR_ERROR_CALLBACK, PEAR_ERROR_EXCEPTION.
mixed	$options	If $mode is PEAR_ERROR_TRIGGER, this parameter specifies the PHP-internal error level (one of E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR). If $mode is PEAR_ERROR_CALLBACK, this parameter specifies the callback function or method. In other error modes this parameter is ignored.
string	$userinfo	If you need to pass along for example debug information, this parameter is meant for that.
string	$error_class	The returned error object will be instantiated from this class, if specified.
bool	$skipmsg	If true, raiseError will only pass error codes, the error message parameter will be dropped.

public

Returns: object a PEAR error object

See Also: PEAR::setErrorHandling

Since: PHP 4.0.5

Definition at line 524 of file PEAR.php.

References $_default_error_mode, $_default_error_options, $_error_class, $GLOBALS, $options, and PEAR_ERROR_RETURN.

    {
        // The error is yet a PEAR error object
        if (is_object($message)) {
            $code        = $message->getCode();
            $userinfo    = $message->getUserInfo();
            $error_class = $message->getType();
            $message->error_message_prefix = '';
            $message     = $message->getMessage();
        }
        if (isset($this) && isset($this->_expected_errors) && sizeof($this->_expected_errors) > 0 && sizeof($exp = end($this->_expected_errors))) {
            if ($exp[0] == "*" ||
                (is_int(reset($exp)) && in_array($code, $exp)) ||
                (is_string(reset($exp)) && in_array($message, $exp))) {
                $mode = PEAR_ERROR_RETURN;
            }
        }
        // No mode given, try global ones
        if ($mode === null) {
            // Class error handler
            if (isset($this) && isset($this->_default_error_mode)) {
                $mode    = $this->_default_error_mode;
                $options = $this->_default_error_options;
            // Global error handler
            } elseif (isset($GLOBALS['_PEAR_default_error_mode'])) {
                $mode    = $GLOBALS['_PEAR_default_error_mode'];
                $options = $GLOBALS['_PEAR_default_error_options'];
            }
        }
        if ($error_class !== null) {
            $ec = $error_class;
        } elseif (isset($this) && isset($this->_error_class)) {
            $ec = $this->_error_class;
        } else {
            $ec = 'PEAR_Error';
        }
        if (intval(PHP_VERSION) < 5) {
            // little non-eval hack to fix bug #12147
            include 'PEAR/FixPHP5PEARWarnings.php';
            return $a;
        }
        if ($skipmsg) {
            $a = new $ec($code, $mode, $options, $userinfo);
        } else {
            $a = new $ec($message, $code, $mode, $options, $userinfo);
        }
        return $a;
    }

Here is the caller graph for this function:

PEAR::registerShutdownFunc	(	$func,
		$args = `array()`
	)

Use this function to register a shutdown method for static classes.

public

Parameters

mixed	$func	The function name (or array of class/method) to call
mixed	$args	The arguments to pass to the function

Returns: void

Definition at line 254 of file PEAR.php.

References $GLOBALS.

Referenced by System\mktemp().

    {
        // if we are called statically, there is a potential
        // that no shutdown func is registered.  Bug #6445
        if (!isset($GLOBALS['_PEAR_SHUTDOWN_REGISTERED'])) {
            register_shutdown_function("_PEAR_call_destructors");
            $GLOBALS['_PEAR_SHUTDOWN_REGISTERED'] = true;
        }
        $GLOBALS['_PEAR_shutdown_funcs'][] = array($func, $args);
    }

Here is the caller graph for this function:

PEAR::setErrorHandling	(	$mode = `null`,
		$options = `null`
	)

Sets how errors generated by this object should be handled.

Can be invoked both in objects and statically. If called statically, setErrorHandling sets the default behaviour for all PEAR objects. If called in an object, setErrorHandling sets the default behaviour for that object.

Parameters

int	$mode	One of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT, PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE, PEAR_ERROR_CALLBACK or PEAR_ERROR_EXCEPTION.
mixed	$options	When $mode is PEAR_ERROR_TRIGGER, this is the error level (one of E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR).

When $mode is PEAR_ERROR_CALLBACK, this parameter is expected to be the callback function or method. A callback function is a string with the name of the function, a callback method is an array of two elements: the element at index 0 is the object, and the element at index 1 is the name of the method to call in the object.

When $mode is PEAR_ERROR_PRINT or PEAR_ERROR_DIE, this is a printf format string used when printing the error message.

public

Returns: void

See Also: PEAR_ERROR_RETURN; PEAR_ERROR_PRINT; PEAR_ERROR_TRIGGER; PEAR_ERROR_DIE; PEAR_ERROR_CALLBACK; PEAR_ERROR_EXCEPTION

Since: PHP 4.0.5

Definition at line 335 of file PEAR.php.

References $_default_error_mode, $_default_error_options, $GLOBALS, $options, PEAR_ERROR_CALLBACK, PEAR_ERROR_DIE, PEAR_ERROR_EXCEPTION, PEAR_ERROR_PRINT, PEAR_ERROR_RETURN, and PEAR_ERROR_TRIGGER.

Referenced by ilDB\connect(), ilDB\connectHost(), ilSetup\ilSetup(), ilValidator\ilValidator(), ilInitialisation\initCore(), ilUtil\is_email(), popErrorHandling(), and pushErrorHandling().

    {
        if (isset($this) && is_a($this, 'PEAR')) {
            $setmode     = &$this->_default_error_mode;
            $setoptions  = &$this->_default_error_options;
        } else {
            $setmode     = &$GLOBALS['_PEAR_default_error_mode'];
            $setoptions  = &$GLOBALS['_PEAR_default_error_options'];
        }
        switch ($mode) {
            case PEAR_ERROR_EXCEPTION:
            case PEAR_ERROR_RETURN:
            case PEAR_ERROR_PRINT:
            case PEAR_ERROR_TRIGGER:
            case PEAR_ERROR_DIE:
            case null:
                $setmode = $mode;
                $setoptions = $options;
                break;
            case PEAR_ERROR_CALLBACK:
                $setmode = $mode;
                // class/object method callback
                if (is_callable($options)) {
                    $setoptions = $options;
                } else {
                    trigger_error("invalid error callback", E_USER_WARNING);
                }
                break;
            default:
                trigger_error("invalid error mode", E_USER_WARNING);
                break;
        }
    }

Here is the caller graph for this function:

PEAR::staticPopErrorHandling ( )

Definition at line 640 of file PEAR.php.

References $GLOBALS, $options, PEAR_ERROR_CALLBACK, PEAR_ERROR_DIE, PEAR_ERROR_EXCEPTION, PEAR_ERROR_PRINT, PEAR_ERROR_RETURN, and PEAR_ERROR_TRIGGER.

    {
        $stack = &$GLOBALS['_PEAR_error_handler_stack'];
        $setmode     = &$GLOBALS['_PEAR_default_error_mode'];
        $setoptions  = &$GLOBALS['_PEAR_default_error_options'];
        array_pop($stack);
        list($mode, $options) = $stack[sizeof($stack) - 1];
        array_pop($stack);
        switch ($mode) {
            case PEAR_ERROR_EXCEPTION:
            case PEAR_ERROR_RETURN:
            case PEAR_ERROR_PRINT:
            case PEAR_ERROR_TRIGGER:
            case PEAR_ERROR_DIE:
            case null:
                $setmode = $mode;
                $setoptions = $options;
                break;
            case PEAR_ERROR_CALLBACK:
                $setmode = $mode;
                // class/object method callback
                if (is_callable($options)) {
                    $setoptions = $options;
                } else {
                    trigger_error("invalid error callback", E_USER_WARNING);
                }
                break;
            default:
                trigger_error("invalid error mode", E_USER_WARNING);
                break;
        }
        return true;
    }

PEAR::staticPushErrorHandling	(	$mode,
		$options = `null`
	)

Definition at line 605 of file PEAR.php.

References $GLOBALS, $options, PEAR_ERROR_CALLBACK, PEAR_ERROR_DIE, PEAR_ERROR_EXCEPTION, PEAR_ERROR_PRINT, PEAR_ERROR_RETURN, and PEAR_ERROR_TRIGGER.

    {
        $stack = &$GLOBALS['_PEAR_error_handler_stack'];
        $def_mode    = &$GLOBALS['_PEAR_default_error_mode'];
        $def_options = &$GLOBALS['_PEAR_default_error_options'];
        $stack[] = array($def_mode, $def_options);
        switch ($mode) {
            case PEAR_ERROR_EXCEPTION:
            case PEAR_ERROR_RETURN:
            case PEAR_ERROR_PRINT:
            case PEAR_ERROR_TRIGGER:
            case PEAR_ERROR_DIE:
            case null:
                $def_mode = $mode;
                $def_options = $options;
                break;
            case PEAR_ERROR_CALLBACK:
                $def_mode = $mode;
                // class/object method callback
                if (is_callable($options)) {
                    $def_options = $options;
                } else {
                    trigger_error("invalid error callback", E_USER_WARNING);
                }
                break;
            default:
                trigger_error("invalid error mode", E_USER_WARNING);
                break;
        }
        $stack[] = array($mode, $options);
        return true;
    }

& PEAR::throwError	(	$message = `null`,
		$code = `null`,
		$userinfo = `null`
	)

Simpler form of raiseError with fewer options.

In most cases message, code and userinfo are enough.

Parameters

string $message

Definition at line 591 of file PEAR.php.

References raiseError().

Referenced by Auth\Auth(), ilValidator\isModeEnabled(), ilValidator\purgeObjects(), ilValidator\removeInvalidChilds(), ilValidator\removeInvalidReferences(), ilValidator\removeInvalidRolefolders(), ilValidator\restoreDeletedObjects(), ilValidator\restoreMissingObjects(), ilValidator\restoreReference(), ilValidator\restoreSubTrees(), ilValidator\restoreTrash(), ilValidator\restoreUnboundObjects(), and ilValidator\setMode().

    {
        if (isset($this) && is_a($this, 'PEAR')) {
            $a = &$this->raiseError($message, $code, null, null, $userinfo);
            return $a;
        } else {
            $a = &PEAR::raiseError($message, $code, null, null, $userinfo);
            return $a;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

PEAR::$_debug = false

Definition at line 112 of file PEAR.php.

PEAR::$_default_error_handler = ''

Definition at line 138 of file PEAR.php.

PEAR::$_default_error_mode = null

Definition at line 120 of file PEAR.php.

Referenced by pushErrorHandling(), raiseError(), MDB2_Driver_Common\raiseError(), and setErrorHandling().

PEAR::$_default_error_options = null

Definition at line 129 of file PEAR.php.

Referenced by pushErrorHandling(), raiseError(), MDB2_Driver_Common\raiseError(), and setErrorHandling().

PEAR::$_error_class = 'PEAR_Error'

Definition at line 146 of file PEAR.php.

Referenced by raiseError().

PEAR::$_expected_errors = array()

Definition at line 154 of file PEAR.php.

Referenced by expectError().

The documentation for this class was generated from the following file:

Services/PEAR/lib/PEAR.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

Field Documentation