WebSVN – Applications.papyrus – Diff – /trunk/api/pear/PEAR.php


<?php
/**
 
 * PEAR, the PHP Extension and Application Repository
 *
 * PEAR class and PEAR_Error class
 *
 * PHP versions 4 and 5
 
 *
 * LICENSE: This source file is subject to version 3.0 of the PHP license
 
 * that is available through the world-wide-web at the following URI:
 * http://www.php.net/license/3_0.txt.  If you did not receive a copy of
 * the PHP License and are unable to obtain it through the web, please
 
 * send a note to license@php.net so we can mail you a copy immediately.
 *
 * @category   pear
 * @package    PEAR
 * @author     Sterling Hughes <sterling@php.net>
 * @author     Stig Bakken <ssb@php.net>
 * @author     Tomas V.V.Cox <cox@idecnet.com>
 * @author     Greg Beaver <cellog@php.net>
 * @copyright  1997-2006 The PHP Group
 * @license    http://www.php.net/license/3_0.txt  PHP License 3.0
 
 * @version    CVS: $Id: PEAR.php,v 1.2 2006-12-14 15:04:29 jp_milcent Exp $
 * @link       http://pear.php.net/package/PEAR
 * @since      File available since Release 0.1
 */
 
/**#@+
 * ERROR constants
 */
define('PEAR_ERROR_RETURN',     1);
define('PEAR_ERROR_PRINT',      2);
define('PEAR_ERROR_TRIGGER',    4);
define('PEAR_ERROR_DIE',        8);
define('PEAR_ERROR_CALLBACK',  16);
/**
 * WARNING: obsolete
 * @deprecated
 */
define('PEAR_ERROR_EXCEPTION', 32);
/**#@-*/
define('PEAR_ZE2', (function_exists('version_compare') &&
                    version_compare(zend_version(), "2-dev", "ge")));
 
if (substr(PHP_OS, 0, 3) == 'WIN') {
    define('OS_WINDOWS', true);
    define('OS_UNIX',    false);
    define('PEAR_OS',    'Windows');
} else {
    define('OS_WINDOWS', false);
    define('OS_UNIX',    true);
    define('PEAR_OS',    'Unix'); // blatant assumption
}
 
// instant backwards compatibility
if (!defined('PATH_SEPARATOR')) {
    if (OS_WINDOWS) {
        define('PATH_SEPARATOR', ';');
    } else {
        define('PATH_SEPARATOR', ':');
    }
}
 
$GLOBALS['_PEAR_default_error_mode']     = PEAR_ERROR_RETURN;
$GLOBALS['_PEAR_default_error_options']  = E_USER_NOTICE;
$GLOBALS['_PEAR_destructor_object_list'] = array();
$GLOBALS['_PEAR_shutdown_funcs']         = array();
$GLOBALS['_PEAR_error_handler_stack']    = array();
 
@ini_set('track_errors', true);
 
/**
 * Base class for other PEAR classes.  Provides rudimentary
 * emulation of destructors.
 *
 * If you want a destructor in your class, inherit PEAR and make a
 * destructor method called _yourclassname (same name as the
 * constructor, but with a "_" prefix).  Also, in your constructor you
 * have to call the PEAR constructor: $this->PEAR();.
 * The destructor method will be called without parameters.  Note that
 * at in some SAPI implementations (such as Apache), any output during
 * the request shutdown (in which destructors are called) seems to be
 * discarded.  If you need to get any debug information from your
 * destructor, use error_log(), syslog() or something similar.
 *
 * IMPORTANT! To use the emulated destructors you need to create the
 * objects by reference: $obj =& new PEAR_child;
 *
 * @category   pear
 * @package    PEAR
 * @author     Stig Bakken <ssb@php.net>
 * @author     Tomas V.V. Cox <cox@idecnet.com>
 * @author     Greg Beaver <cellog@php.net>
 * @copyright  1997-2006 The PHP Group
 * @license    http://www.php.net/license/3_0.txt  PHP License 3.0
 * @version    Release: 1.4.11
 * @link       http://pear.php.net/package/PEAR
 * @see        PEAR_Error
 * @since      Class available since PHP 4.0.2
 * @link        http://pear.php.net/manual/en/core.pear.php#core.pear.pear
 */
class PEAR
{
    // {{{ properties
 
    /**
     * Whether to enable internal debug messages.
     *
     * @var     bool
     * @access  private
     */
    var $_debug = false;
 
    /**
     * Default error mode for this object.
     *
     * @var     int
     * @access  private
     */
    var $_default_error_mode = null;
 
    /**
     * Default error options used for this object when error mode
     * is PEAR_ERROR_TRIGGER.
     *
     * @var     int
     * @access  private
     */
    var $_default_error_options = null;
 
    /**
     * Default error handler (callback) for this object, if error mode is
     * PEAR_ERROR_CALLBACK.
     *
     * @var     string
     * @access  private
     */
    var $_default_error_handler = '';
 
    /**
     * Which class to use for error objects.
     *
     * @var     string
     * @access  private
     */
    var $_error_class = 'PEAR_Error';
 
    /**
     * An array of expected errors.
     *
     * @var     array
     * @access  private
     */
    var $_expected_errors = array();
 
    // }}}
 
    // {{{ constructor
 
    /**
     * Constructor.  Registers this object in
     * $_PEAR_destructor_object_list for destructor emulation if a
     * destructor object exists.
     *
     * @param string $error_class  (optional) which class to use for
     *        error objects, defaults to PEAR_Error.
     * @access public
     * @return void
     */
    function PEAR($error_class = null)
    {
        $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);
            }
        }
    }
 
    // }}}
    // {{{ destructor
 
    /**
     * 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.
     *
     * @access public
     * @return void
     */
    function _PEAR() {
        if ($this->_debug) {
            printf("PEAR destructor called, class=%s\n", strtolower(get_class($this)));
        }
    }
 
    // }}}
    // {{{ getStaticProperty()
 
    /**
    * 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!
    *
    * @access public
    * @param  string $class  The calling classname, to prevent clashes
    * @param  string $var    The variable to retrieve.
    * @return mixed   A reference to the variable. If not set it will be
    *                 auto initialised to NULL.
    */
    function &getStaticProperty($class, $var)
    {
        static $properties;
        return $properties[$class][$var];
    }
 
    // }}}
    // {{{ registerShutdownFunc()
 
    /**
    * Use this function to register a shutdown method for static
    * classes.
    *
    * @access public
    * @param  mixed $func  The function name (or array of class/method) to call
    * @param  mixed $args  The arguments to pass to the function
    * @return void
    */
    function registerShutdownFunc($func, $args = array())
    {
        // 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);
    }
 
    // }}}
    // {{{ isError()
 
    /**
     * Tell whether a value is a PEAR error.
     *
     * @param   mixed $data   the value to test
     * @param   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
     * @access  public
     * @return  bool    true if parameter is an error
     */
    function isError($data, $code = null)
    {
        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;
    }
 
    // }}}
    // {{{ setErrorHandling()
 
    /**
     * 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.
     *
     * @param int $mode
     *        One of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT,
     *        PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE,
     *        PEAR_ERROR_CALLBACK or PEAR_ERROR_EXCEPTION.
     *
     * @param 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.
     *
     * @access public
     * @return void
     * @see PEAR_ERROR_RETURN
     * @see PEAR_ERROR_PRINT
     * @see PEAR_ERROR_TRIGGER
     * @see PEAR_ERROR_DIE
     * @see PEAR_ERROR_CALLBACK
     * @see PEAR_ERROR_EXCEPTION
     *
     * @since PHP 4.0.5
     */
 
    function setErrorHandling($mode = null, $options = null)
    {
        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;
        }
    }
 
    // }}}
    // {{{ expectError()
 
    /**
     * 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
     *
     * @param mixed $code a single error code or an array of error codes to expect
     *
     * @return int     the new depth of the "expected errors" stack
     * @access public
     */
    function expectError($code = '*')
    {
        if (is_array($code)) {
            array_push($this->_expected_errors, $code);
        } else {
            array_push($this->_expected_errors, array($code));
        }
        return sizeof($this->_expected_errors);
    }
 
    // }}}
    // {{{ popExpect()
 
    /**
     * This method pops one element off the expected error codes
     * stack.
     *
     * @return array   the list of error codes that were popped
     */
    function popExpect()
    {
        return array_pop($this->_expected_errors);
    }
 
    // }}}
    // {{{ _checkDelExpect()
 
    /**
     * This method checks unsets an error code if available
     *
     * @param mixed error code
     * @return bool true if the error code was unset, false otherwise
     * @access private
     * @since PHP 4.3.0
     */
    function _checkDelExpect($error_code)
    {
        $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;
    }
 
    // }}}
    // {{{ delExpect()
 
    /**
     * This method deletes all occurences of the specified element from
     * the expected error codes stack.
     *
     * @param  mixed $error_code error code that should be deleted
     * @return mixed list of error codes that were deleted or error
     * @access public
     * @since PHP 4.3.0
     */
    function delExpect($error_code)
    {
        $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
        }
    }
 
    // }}}
    // {{{ 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.
     *
     * @param mixed $message a text error message or a PEAR error object
     *
     * @param int $code      a numeric error code (it is up to your class
     *                  to define these if you want to use codes)
     *
     * @param int $mode      One of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT,
     *                  PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE,
     *                  PEAR_ERROR_CALLBACK, PEAR_ERROR_EXCEPTION.
     *
     * @param 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.
     *
     * @param string $userinfo If you need to pass along for example debug
     *                  information, this parameter is meant for that.
     *
     * @param string $error_class The returned error object will be
     *                  instantiated from this class, if specified.
     *
     * @param bool $skipmsg If true, raiseError will only pass error codes,
     *                  the error message parameter will be dropped.
     *
     * @access public
     * @return object   a PEAR error object
     * @see PEAR::setErrorHandling
     * @since PHP 4.0.5
     */
    function &raiseError($message = null,
                         $code = null,
                         $mode = null,
                         $options = null,
                         $userinfo = null,
                         $error_class = null,
                         $skipmsg = false)
    {
        // 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 ($skipmsg) {
            $a = &new $ec($code, $mode, $options, $userinfo);
            return $a;
        } else {
            $a = &new $ec($message, $code, $mode, $options, $userinfo);
            return $a;
        }
    }
 
    // }}}
    // {{{ throwError()
 
    /**
     * Simpler form of raiseError with fewer options.  In most cases
     * message, code and userinfo are enough.
     *
     * @param string $message
     *
     */
    function &throwError($message = null,
                         $code = null,
                         $userinfo = null)
    {
        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;
        }
    }
 
    // }}}
    function staticPushErrorHandling($mode, $options = null)
    {
        $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;
    }
 
    function staticPopErrorHandling()
    {
        $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;
    }
 
    // {{{ 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.
     *
     * @param mixed $mode (same as setErrorHandling)
     * @param mixed $options (same as setErrorHandling)
     *
     * @return bool Always true
     *
     * @see PEAR::setErrorHandling
     */
    function pushErrorHandling($mode, $options = null)
    {
        $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;
    }
 
    // }}}
    // {{{ popErrorHandling()
 
    /**
    * Pop the last error handler used
    *
    * @return bool Always true
    *
    * @see PEAR::pushErrorHandling
    */
    function popErrorHandling()
    {
        $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;
    }
 
    // }}}
    // {{{ loadExtension()
 
    /**
    * OS independant PHP extension load. Remember to take care
    * on the correct extension name for case sensitive OSes.
    *
    * @param string $ext The extension name
    * @return bool Success or not on the dl() call
    */
    function loadExtension($ext)
    {
        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;
    }
 
    // }}}
}
 
// {{{ _PEAR_call_destructors()
 
function _PEAR_call_destructors()
{
    global $_PEAR_destructor_object_list;
    if (is_array($_PEAR_destructor_object_list) &&
        sizeof($_PEAR_destructor_object_list))
    {
        reset($_PEAR_destructor_object_list);
        if (@PEAR::getStaticProperty('PEAR', 'destructlifo')) {
            $_PEAR_destructor_object_list = array_reverse($_PEAR_destructor_object_list);
        }
        while (list($k, $objref) = each($_PEAR_destructor_object_list)) {
            $classname = get_class($objref);
            while ($classname) {
                $destructor = "_$classname";
                if (method_exists($objref, $destructor)) {
                    $objref->$destructor();
                    break;
                } else {
                    $classname = get_parent_class($classname);
                }
            }
        }
        // Empty the object list to ensure that destructors are
        // not called more than once.
        $_PEAR_destructor_object_list = array();
    }
 
    // Now call the shutdown functions
    if (is_array($GLOBALS['_PEAR_shutdown_funcs']) AND !empty($GLOBALS['_PEAR_shutdown_funcs'])) {
        foreach ($GLOBALS['_PEAR_shutdown_funcs'] as $value) {
            call_user_func_array($value[0], $value[1]);
        }
    }
}
 
// }}}
/**
 * Standard PEAR error class for PHP 4
 *
 * This class is supserseded by {@link PEAR_Exception} in PHP 5
 *
 * @category   pear
 * @package    PEAR
 * @author     Stig Bakken <ssb@php.net>
 * @author     Tomas V.V. Cox <cox@idecnet.com>
 * @author     Gregory Beaver <cellog@php.net>
 * @copyright  1997-2006 The PHP Group
 * @license    http://www.php.net/license/3_0.txt  PHP License 3.0
 * @version    Release: 1.4.11
 * @link       http://pear.php.net/manual/en/core.pear.pear-error.php
 * @see        PEAR::raiseError(), PEAR::throwError()
 * @since      Class available since PHP 4.0.2
 */
class PEAR_Error
{
    // {{{ properties
 
    var $error_message_prefix = '';
    var $mode                 = PEAR_ERROR_RETURN;
    var $level                = E_USER_NOTICE;
    var $code                 = -1;
    var $message              = '';
    var $userinfo             = '';
    var $backtrace            = null;
 
    // }}}
    // {{{ constructor
 
    /**
     * PEAR_Error constructor
     *
     * @param string $message  message
     *
     * @param int $code     (optional) error code
     *
     * @param int $mode     (optional) error mode, one of: PEAR_ERROR_RETURN,
     * PEAR_ERROR_PRINT, PEAR_ERROR_DIE, PEAR_ERROR_TRIGGER,
     * PEAR_ERROR_CALLBACK or PEAR_ERROR_EXCEPTION
     *
     * @param mixed $options   (optional) error level, _OR_ in the case of
     * PEAR_ERROR_CALLBACK, the callback function or object/method
     * tuple.
     *
     * @param string $userinfo (optional) additional user/debug info
     *
     * @access public
     *
     */
    function PEAR_Error($message = 'unknown error', $code = null,
                        $mode = null, $options = null, $userinfo = null)
    {
        if ($mode === null) {
            $mode = PEAR_ERROR_RETURN;
        }
        $this->message   = $message;
        $this->code      = $code;
        $this->mode      = $mode;
        $this->userinfo  = $userinfo;
        if (function_exists("debug_backtrace")) {
            if (@!PEAR::getStaticProperty('PEAR_Error', 'skiptrace')) {
                $this->backtrace = debug_backtrace();
            }
        }
        if ($mode & PEAR_ERROR_CALLBACK) {
            $this->level = E_USER_NOTICE;
            $this->callback = $options;
        } else {
            if ($options === null) {
                $options = E_USER_NOTICE;
            }
            $this->level = $options;
            $this->callback = null;
        }
        if ($this->mode & PEAR_ERROR_PRINT) {
            if (is_null($options) || is_int($options)) {
                $format = "%s";
            } else {
                $format = $options;
            }
            printf($format, $this->getMessage());
        }
        if ($this->mode & PEAR_ERROR_TRIGGER) {
            trigger_error($this->getMessage(), $this->level);
        }
        if ($this->mode & PEAR_ERROR_DIE) {
            $msg = $this->getMessage();
            if (is_null($options) || is_int($options)) {
                $format = "%s";
                if (substr($msg, -1) != "\n") {
                    $msg .= "\n";
                }
            } else {
                $format = $options;
            }
            die(sprintf($format, $msg));
        }
        if ($this->mode & PEAR_ERROR_CALLBACK) {
            if (is_callable($this->callback)) {
                call_user_func($this->callback, $this);
            }
        }
        if ($this->mode & PEAR_ERROR_EXCEPTION) {
            trigger_error("PEAR_ERROR_EXCEPTION is obsolete, use class PEAR_Exception for exceptions", E_USER_WARNING);
            eval('$e = new Exception($this->message, $this->code);throw($e);');
        }
    }
 
    // }}}
    // {{{ getMode()
 
    /**
     * Get the error mode from an error object.
     *
     * @return int error mode
     * @access public
     */
    function getMode() {
        return $this->mode;
    }
 
    // }}}
    // {{{ getCallback()
 
    /**
     * Get the callback function/method from an error object.
     *
     * @return mixed callback function or object/method array
     * @access public
     */
    function getCallback() {
        return $this->callback;
    }
 
    // }}}
    // {{{ getMessage()
 
 
    /**
     * Get the error message from an error object.
     *
     * @return  string  full error message
     * @access public
     */
    function getMessage()
    {
        return ($this->error_message_prefix . $this->message);
    }
 
 
    // }}}
    // {{{ getCode()
 
    /**
     * Get error code from an error object
     *
     * @return int error code
     * @access public
     */
     function getCode()
     {
        return $this->code;
     }
 
    // }}}
    // {{{ getType()
 
    /**
     * Get the name of this error/exception.
     *
     * @return string error/exception name (type)
     * @access public
     */
    function getType()
    {
        return get_class($this);
    }
 
    // }}}
    // {{{ getUserInfo()
 
    /**
     * Get additional user-supplied information.
     *
     * @return string user-supplied information
     * @access public
     */
    function getUserInfo()
    {
        return $this->userinfo;
    }
 
    // }}}
    // {{{ getDebugInfo()
 
    /**
     * Get additional debug information supplied by the application.
     *
     * @return string debug information
     * @access public
     */
    function getDebugInfo()
    {
        return $this->getUserInfo();
    }
 
    // }}}
    // {{{ getBacktrace()
 
    /**
     * Get the call backtrace from where the error was generated.
     * Supported with PHP 4.3.0 or newer.
     *
     * @param int $frame (optional) what frame to fetch
     * @return array Backtrace, or NULL if not available.
     * @access public
     */
    function getBacktrace($frame = null)
    {
        if (defined('PEAR_IGNORE_BACKTRACE')) {
            return null;
        }
        if ($frame === null) {
            return $this->backtrace;
        }
        return $this->backtrace[$frame];
    }
 
    // }}}
    // {{{ addUserInfo()
 
    function addUserInfo($info)
    {
        if (empty($this->userinfo)) {
            $this->userinfo = $info;
        } else {
            $this->userinfo .= " ** $info";
        }
    }
 
    // }}}
    // {{{ toString()
 
    /**
     * Make a string representation of this object.
     *
     * @return string a string with an object summary
     * @access public
     */
    function toString() {
        $modes = array();
        $levels = array(E_USER_NOTICE  => 'notice',
                        E_USER_WARNING => 'warning',
                        E_USER_ERROR   => 'error');
        if ($this->mode & PEAR_ERROR_CALLBACK) {
            if (is_array($this->callback)) {
                $callback = (is_object($this->callback[0]) ?
                    strtolower(get_class($this->callback[0])) :
                    $this->callback[0]) . '::' .
                    $this->callback[1];
            } else {
                $callback = $this->callback;
            }
            return sprintf('[%s: message="%s" code=%d mode=callback '.
                           'callback=%s prefix="%s" info="%s"]',
                           strtolower(get_class($this)), $this->message, $this->code,
                           $callback, $this->error_message_prefix,
                           $this->userinfo);
        }
        if ($this->mode & PEAR_ERROR_PRINT) {
            $modes[] = 'print';
        }
        if ($this->mode & PEAR_ERROR_TRIGGER) {
            $modes[] = 'trigger';
        }
        if ($this->mode & PEAR_ERROR_DIE) {
            $modes[] = 'die';
        }
        if ($this->mode & PEAR_ERROR_RETURN) {
            $modes[] = 'return';
        }
        return sprintf('[%s: message="%s" code=%d mode=%s level=%s '.
                       'prefix="%s" info="%s"]',
                       strtolower(get_class($this)), $this->message, $this->code,
                       implode("|", $modes), $levels[$this->level],
                       $this->error_message_prefix,
                       $this->userinfo);
    }
 
    // }}}
}
 
/*
 * Local Variables:
 * mode: php
 * tab-width: 4
 * c-basic-offset: 4
 * End:
 */
?>

Rev 320	Rev 1173
1	`<?php`	1	`<?php`
2	`//`	2	`/**`
3	`// +--------------------------------------------------------------------+`	-
4	`// \| PEAR, the PHP Extension and Application Repository \|`	3	`* PEAR, the PHP Extension and Application Repository`
-		4	`*`
5	`// +--------------------------------------------------------------------+`	5	`* PEAR class and PEAR_Error class`
-		6	`*`
6	`// \| Copyright (c) 1997-2004 The PHP Group \|`	7	`* PHP versions 4 and 5`
7	`// +--------------------------------------------------------------------+`	-
-		8	`*`
8	`// \| This source file is subject to version 3.0 of the PHP license, \|`	9	`* LICENSE: This source file is subject to version 3.0 of the PHP license`
9	`// \| that is bundled with this package in the file LICENSE, and is \|`	-
10	`// \| available through the world-wide-web at the following url: \|`	10	`* that is available through the world-wide-web at the following URI:`
11	`// \| http://www.php.net/license/3_0.txt. \|`	11	`* http://www.php.net/license/3_0.txt. If you did not receive a copy of`
12	`// \| If you did not receive a copy of the PHP license and are unable to \|`	12	`* the PHP License and are unable to obtain it through the web, please`
13	`// \| obtain it through the world-wide-web, please send a note to \|`	-
14	`// \| license@php.net so we can mail you a copy immediately. \|`	13	`* send a note to license@php.net so we can mail you a copy immediately.`
-		14	`*`
-		15	`* @category pear`
15	`// +--------------------------------------------------------------------+`	16	`* @package PEAR`
16	`// \| Authors: Sterling Hughes <sterling@php.net> \|`	17	`* @author Sterling Hughes <sterling@php.net>`
17	`// \| Stig Bakken <ssb@php.net> \|`	18	`* @author Stig Bakken <ssb@php.net>`
18	`// \| Tomas V.V.Cox <cox@idecnet.com> \|`	19	`* @author Tomas V.V.Cox <cox@idecnet.com>`
-		20	`* @author Greg Beaver <cellog@php.net>`
-		21	`* @copyright 1997-2006 The PHP Group`
19	`// +--------------------------------------------------------------------+`	22	`* @license http://www.php.net/license/3_0.txt PHP License 3.0`
20	`//`	-
21	`// $Id: PEAR.php,v 1.1 2005-03-30 08:50:19 jpm Exp $`	23	`* @version CVS: $Id: PEAR.php,v 1.2 2006-12-14 15:04:29 jp_milcent Exp $`
-		24	`* @link http://pear.php.net/package/PEAR`
-		25	`* @since File available since Release 0.1`
22	`//`	26	`*/`
-		27
-		28	`/**#@+`
-		29	`* ERROR constants`
23		30	`*/`
24	`define('PEAR_ERROR_RETURN', 1);`	31	`define('PEAR_ERROR_RETURN', 1);`
25	`define('PEAR_ERROR_PRINT', 2);`	32	`define('PEAR_ERROR_PRINT', 2);`
26	`define('PEAR_ERROR_TRIGGER', 4);`	33	`define('PEAR_ERROR_TRIGGER', 4);`
27	`define('PEAR_ERROR_DIE', 8);`	34	`define('PEAR_ERROR_DIE', 8);`
28	`define('PEAR_ERROR_CALLBACK', 16);`	35	`define('PEAR_ERROR_CALLBACK', 16);`
29	`/**`	36	`/**`
30	`* WARNING: obsolete`	37	`* WARNING: obsolete`
31	`* @deprecated`	38	`* @deprecated`
32	`*/`	39	`*/`
33	`define('PEAR_ERROR_EXCEPTION', 32);`	40	`define('PEAR_ERROR_EXCEPTION', 32);`
-		41	`/*#@-/`
34	`define('PEAR_ZE2', (function_exists('version_compare') &&`	42	`define('PEAR_ZE2', (function_exists('version_compare') &&`
35	`version_compare(zend_version(), "2-dev", "ge")));`	43	`version_compare(zend_version(), "2-dev", "ge")));`
36		44
37	`if (substr(PHP_OS, 0, 3) == 'WIN') {`	45	`if (substr(PHP_OS, 0, 3) == 'WIN') {`
38	`define('OS_WINDOWS', true);`	46	`define('OS_WINDOWS', true);`
39	`define('OS_UNIX', false);`	47	`define('OS_UNIX', false);`
40	`define('PEAR_OS', 'Windows');`	48	`define('PEAR_OS', 'Windows');`
41	`} else {`	49	`} else {`
42	`define('OS_WINDOWS', false);`	50	`define('OS_WINDOWS', false);`
43	`define('OS_UNIX', true);`	51	`define('OS_UNIX', true);`
44	`define('PEAR_OS', 'Unix'); // blatant assumption`	52	`define('PEAR_OS', 'Unix'); // blatant assumption`
45	`}`	53	`}`
46		54
47	`// instant backwards compatibility`	55	`// instant backwards compatibility`
48	`if (!defined('PATH_SEPARATOR')) {`	56	`if (!defined('PATH_SEPARATOR')) {`
49	`if (OS_WINDOWS) {`	57	`if (OS_WINDOWS) {`
50	`define('PATH_SEPARATOR', ';');`	58	`define('PATH_SEPARATOR', ';');`
51	`} else {`	59	`} else {`
52	`define('PATH_SEPARATOR', ':');`	60	`define('PATH_SEPARATOR', ':');`
53	`}`	61	`}`
54	`}`	62	`}`
55		63
56	`$GLOBALS['_PEAR_default_error_mode'] = PEAR_ERROR_RETURN;`	64	`$GLOBALS['_PEAR_default_error_mode'] = PEAR_ERROR_RETURN;`
57	`$GLOBALS['_PEAR_default_error_options'] = E_USER_NOTICE;`	65	`$GLOBALS['_PEAR_default_error_options'] = E_USER_NOTICE;`
58	`$GLOBALS['_PEAR_destructor_object_list'] = array();`	66	`$GLOBALS['_PEAR_destructor_object_list'] = array();`
59	`$GLOBALS['_PEAR_shutdown_funcs'] = array();`	67	`$GLOBALS['_PEAR_shutdown_funcs'] = array();`
60	`$GLOBALS['_PEAR_error_handler_stack'] = array();`	68	`$GLOBALS['_PEAR_error_handler_stack'] = array();`
61		69
62	`@ini_set('track_errors', true);`	70	`@ini_set('track_errors', true);`
63		71
64	`/**`	72	`/**`
65	`* Base class for other PEAR classes. Provides rudimentary`	73	`* Base class for other PEAR classes. Provides rudimentary`
66	`* emulation of destructors.`	74	`* emulation of destructors.`
67	`*`	75	`*`
68	`* If you want a destructor in your class, inherit PEAR and make a`	76	`* If you want a destructor in your class, inherit PEAR and make a`
69	`* destructor method called _yourclassname (same name as the`	77	`* destructor method called _yourclassname (same name as the`
70	`* constructor, but with a "_" prefix). Also, in your constructor you`	78	`* constructor, but with a "_" prefix). Also, in your constructor you`
71	`* have to call the PEAR constructor: $this->PEAR();.`	79	`* have to call the PEAR constructor: $this->PEAR();.`
72	`* The destructor method will be called without parameters. Note that`	80	`* The destructor method will be called without parameters. Note that`
73	`* at in some SAPI implementations (such as Apache), any output during`	81	`* at in some SAPI implementations (such as Apache), any output during`
74	`* the request shutdown (in which destructors are called) seems to be`	82	`* the request shutdown (in which destructors are called) seems to be`
75	`* discarded. If you need to get any debug information from your`	83	`* discarded. If you need to get any debug information from your`
76	`* destructor, use error_log(), syslog() or something similar.`	84	`* destructor, use error_log(), syslog() or something similar.`
77	`*`	85	`*`
78	`* IMPORTANT! To use the emulated destructors you need to create the`	86	`* IMPORTANT! To use the emulated destructors you need to create the`
79	`* objects by reference: $obj =& new PEAR_child;`	87	`* objects by reference: $obj =& new PEAR_child;`
80	`*`	88	`*`
-		89	`* @category pear`
81	`* @since PHP 4.0.2`	90	`* @package PEAR`
82	`* @author Stig Bakken <ssb@php.net>`	91	`* @author Stig Bakken <ssb@php.net>`
-		92	`* @author Tomas V.V. Cox <cox@idecnet.com>`
-		93	`* @author Greg Beaver <cellog@php.net>`
-		94	`* @copyright 1997-2006 The PHP Group`
-		95	`* @license http://www.php.net/license/3_0.txt PHP License 3.0`
-		96	`* @version Release: 1.4.11`
83	`* @see http://pear.php.net/manual/`	97	`* @link http://pear.php.net/package/PEAR`
-		98	`* @see PEAR_Error`
-		99	`* @since Class available since PHP 4.0.2`
-		100	`* @link http://pear.php.net/manual/en/core.pear.php#core.pear.pear`
84	`*/`	101	`*/`
85	`class PEAR`	102	`class PEAR`
86	`{`	103	`{`
87	`// {{{ properties`	104	`// {{{ properties`
88		105
89	`/**`	106	`/**`
90	`* Whether to enable internal debug messages.`	107	`* Whether to enable internal debug messages.`
91	`*`	108	`*`
92	`* @var bool`	109	`* @var bool`
93	`* @access private`	110	`* @access private`
94	`*/`	111	`*/`
95	`var $_debug = false;`	112	`var $_debug = false;`
96		113
97	`/**`	114	`/**`
98	`* Default error mode for this object.`	115	`* Default error mode for this object.`
99	`*`	116	`*`
100	`* @var int`	117	`* @var int`
101	`* @access private`	118	`* @access private`
102	`*/`	119	`*/`
103	`var $_default_error_mode = null;`	120	`var $_default_error_mode = null;`
104		121
105	`/**`	122	`/**`
106	`* Default error options used for this object when error mode`	123	`* Default error options used for this object when error mode`
107	`* is PEAR_ERROR_TRIGGER.`	124	`* is PEAR_ERROR_TRIGGER.`
108	`*`	125	`*`
109	`* @var int`	126	`* @var int`
110	`* @access private`	127	`* @access private`
111	`*/`	128	`*/`
112	`var $_default_error_options = null;`	129	`var $_default_error_options = null;`
113		130
114	`/**`	131	`/**`
115	`* Default error handler (callback) for this object, if error mode is`	132	`* Default error handler (callback) for this object, if error mode is`
116	`* PEAR_ERROR_CALLBACK.`	133	`* PEAR_ERROR_CALLBACK.`
117	`*`	134	`*`
118	`* @var string`	135	`* @var string`
119	`* @access private`	136	`* @access private`
120	`*/`	137	`*/`
121	`var $_default_error_handler = '';`	138	`var $_default_error_handler = '';`
122		139
123	`/**`	140	`/**`
124	`* Which class to use for error objects.`	141	`* Which class to use for error objects.`
125	`*`	142	`*`
126	`* @var string`	143	`* @var string`
127	`* @access private`	144	`* @access private`
128	`*/`	145	`*/`
129	`var $_error_class = 'PEAR_Error';`	146	`var $_error_class = 'PEAR_Error';`
130		147
131	`/**`	148	`/**`
132	`* An array of expected errors.`	149	`* An array of expected errors.`
133	`*`	150	`*`
134	`* @var array`	151	`* @var array`
135	`* @access private`	152	`* @access private`
136	`*/`	153	`*/`
137	`var $_expected_errors = array();`	154	`var $_expected_errors = array();`
138		155
139	`// }}}`	156	`// }}}`
140		157
141	`// {{{ constructor`	158	`// {{{ constructor`
142		159
143	`/**`	160	`/**`
144	`* Constructor. Registers this object in`	161	`* Constructor. Registers this object in`
145	`* $_PEAR_destructor_object_list for destructor emulation if a`	162	`* $_PEAR_destructor_object_list for destructor emulation if a`
146	`* destructor object exists.`	163	`* destructor object exists.`
147	`*`	164	`*`
148	`* @param string $error_class (optional) which class to use for`	165	`* @param string $error_class (optional) which class to use for`
149	`* error objects, defaults to PEAR_Error.`	166	`* error objects, defaults to PEAR_Error.`
150	`* @access public`	167	`* @access public`
151	`* @return void`	168	`* @return void`
152	`*/`	169	`*/`
153	`function PEAR($error_class = null)`	170	`function PEAR($error_class = null)`
154	`{`	171	`{`
155	`$classname = strtolower(get_class($this));`	172	`$classname = strtolower(get_class($this));`
156	`if ($this->_debug) {`	173	`if ($this->_debug) {`
157	`print "PEAR constructor called, class=$classname\n";`	174	`print "PEAR constructor called, class=$classname\n";`
158	`}`	175	`}`
159	`if ($error_class !== null) {`	176	`if ($error_class !== null) {`
160	`$this->_error_class = $error_class;`	177	`$this->_error_class = $error_class;`
161	`}`	178	`}`
162	`while ($classname && strcasecmp($classname, "pear")) {`	179	`while ($classname && strcasecmp($classname, "pear")) {`
163	`$destructor = "_$classname";`	180	`$destructor = "_$classname";`
164	`if (method_exists($this, $destructor)) {`	181	`if (method_exists($this, $destructor)) {`
165	`global $_PEAR_destructor_object_list;`	182	`global $_PEAR_destructor_object_list;`
166	`$_PEAR_destructor_object_list[] = &$this;`	183	`$_PEAR_destructor_object_list[] = &$this;`
167	`if (!isset($GLOBALS['_PEAR_SHUTDOWN_REGISTERED'])) {`	184	`if (!isset($GLOBALS['_PEAR_SHUTDOWN_REGISTERED'])) {`
168	`register_shutdown_function("_PEAR_call_destructors");`	185	`register_shutdown_function("_PEAR_call_destructors");`
169	`$GLOBALS['_PEAR_SHUTDOWN_REGISTERED'] = true;`	186	`$GLOBALS['_PEAR_SHUTDOWN_REGISTERED'] = true;`
170	`}`	187	`}`
171	`break;`	188	`break;`
172	`} else {`	189	`} else {`
173	`$classname = get_parent_class($classname);`	190	`$classname = get_parent_class($classname);`
174	`}`	191	`}`
175	`}`	192	`}`
176	`}`	193	`}`
177		194
178	`// }}}`	195	`// }}}`
179	`// {{{ destructor`	196	`// {{{ destructor`
180		197
181	`/**`	198	`/**`
182	`* Destructor (the emulated type of...). Does nothing right now,`	199	`* Destructor (the emulated type of...). Does nothing right now,`
183	`* but is included for forward compatibility, so subclass`	200	`* but is included for forward compatibility, so subclass`
184	`* destructors should always call it.`	201	`* destructors should always call it.`
185	`*`	202	`*`
186	`* See the note in the class desciption about output from`	203	`* See the note in the class desciption about output from`
187	`* destructors.`	204	`* destructors.`
188	`*`	205	`*`
189	`* @access public`	206	`* @access public`
190	`* @return void`	207	`* @return void`
191	`*/`	208	`*/`
192	`function _PEAR() {`	209	`function _PEAR() {`
193	`if ($this->_debug) {`	210	`if ($this->_debug) {`
194	`printf("PEAR destructor called, class=%s\n", strtolower(get_class($this)));`	211	`printf("PEAR destructor called, class=%s\n", strtolower(get_class($this)));`
195	`}`	212	`}`
196	`}`	213	`}`
197		214
198	`// }}}`	215	`// }}}`
199	`// {{{ getStaticProperty()`	216	`// {{{ getStaticProperty()`
200		217
201	`/**`	218	`/**`
202	`* If you have a class that's mostly/entirely static, and you need static`	219	`* If you have a class that's mostly/entirely static, and you need static`
203	`* properties, you can use this method to simulate them. Eg. in your method(s)`	220	`* properties, you can use this method to simulate them. Eg. in your method(s)`
204	`* do this: $myVar = &PEAR::getStaticProperty('myclass', 'myVar');`	221	`* do this: $myVar = &PEAR::getStaticProperty('myclass', 'myVar');`
205	`* You MUST use a reference, or they will not persist!`	222	`* You MUST use a reference, or they will not persist!`
206	`*`	223	`*`
207	`* @access public`	224	`* @access public`
208	`* @param string $class The calling classname, to prevent clashes`	225	`* @param string $class The calling classname, to prevent clashes`
209	`* @param string $var The variable to retrieve.`	226	`* @param string $var The variable to retrieve.`
210	`* @return mixed A reference to the variable. If not set it will be`	227	`* @return mixed A reference to the variable. If not set it will be`
211	`* auto initialised to NULL.`	228	`* auto initialised to NULL.`
212	`*/`	229	`*/`
213	`function &getStaticProperty($class, $var)`	230	`function &getStaticProperty($class, $var)`
214	`{`	231	`{`
215	`static $properties;`	232	`static $properties;`
216	`return $properties[$class][$var];`	233	`return $properties[$class][$var];`
217	`}`	234	`}`
218		235
219	`// }}}`	236	`// }}}`
220	`// {{{ registerShutdownFunc()`	237	`// {{{ registerShutdownFunc()`
221		238
222	`/**`	239	`/**`
223	`* Use this function to register a shutdown method for static`	240	`* Use this function to register a shutdown method for static`
224	`* classes.`	241	`* classes.`
225	`*`	242	`*`
226	`* @access public`	243	`* @access public`
227	`* @param mixed $func The function name (or array of class/method) to call`	244	`* @param mixed $func The function name (or array of class/method) to call`
228	`* @param mixed $args The arguments to pass to the function`	245	`* @param mixed $args The arguments to pass to the function`
229	`* @return void`	246	`* @return void`
230	`*/`	247	`*/`
231	`function registerShutdownFunc($func, $args = array())`	248	`function registerShutdownFunc($func, $args = array())`
232	`{`	249	`{`
-		250	`// if we are called statically, there is a potential`
-		251	`// that no shutdown func is registered. Bug #6445`
-		252	`if (!isset($GLOBALS['_PEAR_SHUTDOWN_REGISTERED'])) {`
-		253	`register_shutdown_function("_PEAR_call_destructors");`
-		254	`$GLOBALS['_PEAR_SHUTDOWN_REGISTERED'] = true;`
-		255	`}`
233	`$GLOBALS['_PEAR_shutdown_funcs'][] = array($func, $args);`	256	`$GLOBALS['_PEAR_shutdown_funcs'][] = array($func, $args);`
234	`}`	257	`}`
235		258
236	`// }}}`	259	`// }}}`
237	`// {{{ isError()`	260	`// {{{ isError()`
238		261
239	`/**`	262	`/**`
240	`* Tell whether a value is a PEAR error.`	263	`* Tell whether a value is a PEAR error.`
241	`*`	264	`*`
242	`* @param mixed $data the value to test`	265	`* @param mixed $data the value to test`
243	`* @param int $code if $data is an error object, return true`	266	`* @param int $code if $data is an error object, return true`
244	`* only if $code is a string and`	267	`* only if $code is a string and`
245	`* $obj->getMessage() == $code or`	268	`* $obj->getMessage() == $code or`
246	`* $code is an integer and $obj->getCode() == $code`	269	`* $code is an integer and $obj->getCode() == $code`
247	`* @access public`	270	`* @access public`
248	`* @return bool true if parameter is an error`	271	`* @return bool true if parameter is an error`
249	`*/`	272	`*/`
250	`function isError($data, $code = null)`	273	`function isError($data, $code = null)`
251	`{`	274	`{`
252	`if (is_a($data, 'PEAR_Error')) {`	275	`if (is_a($data, 'PEAR_Error')) {`
253	`if (is_null($code)) {`	276	`if (is_null($code)) {`
254	`return true;`	277	`return true;`
255	`} elseif (is_string($code)) {`	278	`} elseif (is_string($code)) {`
256	`return $data->getMessage() == $code;`	279	`return $data->getMessage() == $code;`
257	`} else {`	280	`} else {`
258	`return $data->getCode() == $code;`	281	`return $data->getCode() == $code;`
259	`}`	282	`}`
260	`}`	283	`}`
261	`return false;`	284	`return false;`
262	`}`	285	`}`
263		286
264	`// }}}`	287	`// }}}`
265	`// {{{ setErrorHandling()`	288	`// {{{ setErrorHandling()`
266		289
267	`/**`	290	`/**`
268	`* Sets how errors generated by this object should be handled.`	291	`* Sets how errors generated by this object should be handled.`
269	`* Can be invoked both in objects and statically. If called`	292	`* Can be invoked both in objects and statically. If called`
270	`* statically, setErrorHandling sets the default behaviour for all`	293	`* statically, setErrorHandling sets the default behaviour for all`
271	`* PEAR objects. If called in an object, setErrorHandling sets`	294	`* PEAR objects. If called in an object, setErrorHandling sets`
272	`* the default behaviour for that object.`	295	`* the default behaviour for that object.`
273	`*`	296	`*`
274	`* @param int $mode`	297	`* @param int $mode`
275	`* One of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT,`	298	`* One of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT,`
276	`* PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE,`	299	`* PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE,`
277	`* PEAR_ERROR_CALLBACK or PEAR_ERROR_EXCEPTION.`	300	`* PEAR_ERROR_CALLBACK or PEAR_ERROR_EXCEPTION.`
278	`*`	301	`*`
279	`* @param mixed $options`	302	`* @param mixed $options`
280	`* When $mode is PEAR_ERROR_TRIGGER, this is the error level (one`	303	`* When $mode is PEAR_ERROR_TRIGGER, this is the error level (one`
281	`* of E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR).`	304	`* of E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR).`
282	`*`	305	`*`
283	`* When $mode is PEAR_ERROR_CALLBACK, this parameter is expected`	306	`* When $mode is PEAR_ERROR_CALLBACK, this parameter is expected`
284	`* to be the callback function or method. A callback`	307	`* to be the callback function or method. A callback`
285	`* function is a string with the name of the function, a`	308	`* function is a string with the name of the function, a`
286	`* callback method is an array of two elements: the element`	309	`* callback method is an array of two elements: the element`
287	`* at index 0 is the object, and the element at index 1 is`	310	`* at index 0 is the object, and the element at index 1 is`
288	`* the name of the method to call in the object.`	311	`* the name of the method to call in the object.`
289	`*`	312	`*`
290	`* When $mode is PEAR_ERROR_PRINT or PEAR_ERROR_DIE, this is`	313	`* When $mode is PEAR_ERROR_PRINT or PEAR_ERROR_DIE, this is`
291	`* a printf format string used when printing the error`	314	`* a printf format string used when printing the error`
292	`* message.`	315	`* message.`
293	`*`	316	`*`
294	`* @access public`	317	`* @access public`
295	`* @return void`	318	`* @return void`
296	`* @see PEAR_ERROR_RETURN`	319	`* @see PEAR_ERROR_RETURN`
297	`* @see PEAR_ERROR_PRINT`	320	`* @see PEAR_ERROR_PRINT`
298	`* @see PEAR_ERROR_TRIGGER`	321	`* @see PEAR_ERROR_TRIGGER`
299	`* @see PEAR_ERROR_DIE`	322	`* @see PEAR_ERROR_DIE`
300	`* @see PEAR_ERROR_CALLBACK`	323	`* @see PEAR_ERROR_CALLBACK`
301	`* @see PEAR_ERROR_EXCEPTION`	324	`* @see PEAR_ERROR_EXCEPTION`
302	`*`	325	`*`
303	`* @since PHP 4.0.5`	326	`* @since PHP 4.0.5`
304	`*/`	327	`*/`
305		328
306	`function setErrorHandling($mode = null, $options = null)`	329	`function setErrorHandling($mode = null, $options = null)`
307	`{`	330	`{`
308	`if (isset($this) && is_a($this, 'PEAR')) {`	331	`if (isset($this) && is_a($this, 'PEAR')) {`
309	`$setmode = &$this->_default_error_mode;`	332	`$setmode = &$this->_default_error_mode;`
310	`$setoptions = &$this->_default_error_options;`	333	`$setoptions = &$this->_default_error_options;`
311	`} else {`	334	`} else {`
312	`$setmode = &$GLOBALS['_PEAR_default_error_mode'];`	335	`$setmode = &$GLOBALS['_PEAR_default_error_mode'];`
313	`$setoptions = &$GLOBALS['_PEAR_default_error_options'];`	336	`$setoptions = &$GLOBALS['_PEAR_default_error_options'];`
314	`}`	337	`}`
315		338
316	`switch ($mode) {`	339	`switch ($mode) {`
317	`case PEAR_ERROR_EXCEPTION:`	340	`case PEAR_ERROR_EXCEPTION:`
318	`case PEAR_ERROR_RETURN:`	341	`case PEAR_ERROR_RETURN:`
319	`case PEAR_ERROR_PRINT:`	342	`case PEAR_ERROR_PRINT:`
320	`case PEAR_ERROR_TRIGGER:`	343	`case PEAR_ERROR_TRIGGER:`
321	`case PEAR_ERROR_DIE:`	344	`case PEAR_ERROR_DIE:`
322	`case null:`	345	`case null:`
323	`$setmode = $mode;`	346	`$setmode = $mode;`
324	`$setoptions = $options;`	347	`$setoptions = $options;`
325	`break;`	348	`break;`
326		349
327	`case PEAR_ERROR_CALLBACK:`	350	`case PEAR_ERROR_CALLBACK:`
328	`$setmode = $mode;`	351	`$setmode = $mode;`
329	`// class/object method callback`	352	`// class/object method callback`
330	`if (is_callable($options)) {`	353	`if (is_callable($options)) {`
331	`$setoptions = $options;`	354	`$setoptions = $options;`
332	`} else {`	355	`} else {`
333	`trigger_error("invalid error callback", E_USER_WARNING);`	356	`trigger_error("invalid error callback", E_USER_WARNING);`
334	`}`	357	`}`
335	`break;`	358	`break;`
336		359
337	`default:`	360	`default:`
338	`trigger_error("invalid error mode", E_USER_WARNING);`	361	`trigger_error("invalid error mode", E_USER_WARNING);`
339	`break;`	362	`break;`
340	`}`	363	`}`
341	`}`	364	`}`
342		365
343	`// }}}`	366	`// }}}`
344	`// {{{ expectError()`	367	`// {{{ expectError()`
345		368
346	`/**`	369	`/**`
347	`* This method is used to tell which errors you expect to get.`	370	`* This method is used to tell which errors you expect to get.`
348	`* Expected errors are always returned with error mode`	371	`* Expected errors are always returned with error mode`
349	`* PEAR_ERROR_RETURN. Expected error codes are stored in a stack,`	372	`* PEAR_ERROR_RETURN. Expected error codes are stored in a stack,`
350	`* and this method pushes a new element onto it. The list of`	373	`* and this method pushes a new element onto it. The list of`
351	`* expected errors are in effect until they are popped off the`	374	`* expected errors are in effect until they are popped off the`
352	`* stack with the popExpect() method.`	375	`* stack with the popExpect() method.`
353	`*`	376	`*`
354	`* Note that this method can not be called statically`	377	`* Note that this method can not be called statically`
355	`*`	378	`*`
356	`* @param mixed $code a single error code or an array of error codes to expect`	379	`* @param mixed $code a single error code or an array of error codes to expect`
357	`*`	380	`*`
358	`* @return int the new depth of the "expected errors" stack`	381	`* @return int the new depth of the "expected errors" stack`
359	`* @access public`	382	`* @access public`
360	`*/`	383	`*/`
361	`function expectError($code = '*')`	384	`function expectError($code = '*')`
362	`{`	385	`{`
363	`if (is_array($code)) {`	386	`if (is_array($code)) {`
364	`array_push($this->_expected_errors, $code);`	387	`array_push($this->_expected_errors, $code);`
365	`} else {`	388	`} else {`
366	`array_push($this->_expected_errors, array($code));`	389	`array_push($this->_expected_errors, array($code));`
367	`}`	390	`}`
368	`return sizeof($this->_expected_errors);`	391	`return sizeof($this->_expected_errors);`
369	`}`	392	`}`
370		393
371	`// }}}`	394	`// }}}`
372	`// {{{ popExpect()`	395	`// {{{ popExpect()`
373		396
374	`/**`	397	`/**`
375	`* This method pops one element off the expected error codes`	398	`* This method pops one element off the expected error codes`
376	`* stack.`	399	`* stack.`
377	`*`	400	`*`
378	`* @return array the list of error codes that were popped`	401	`* @return array the list of error codes that were popped`
379	`*/`	402	`*/`
380	`function popExpect()`	403	`function popExpect()`
381	`{`	404	`{`
382	`return array_pop($this->_expected_errors);`	405	`return array_pop($this->_expected_errors);`
383	`}`	406	`}`
384		407
385	`// }}}`	408	`// }}}`
386	`// {{{ _checkDelExpect()`	409	`// {{{ _checkDelExpect()`
387		410
388	`/**`	411	`/**`
389	`* This method checks unsets an error code if available`	412	`* This method checks unsets an error code if available`
390	`*`	413	`*`
391	`* @param mixed error code`	414	`* @param mixed error code`
392	`* @return bool true if the error code was unset, false otherwise`	415	`* @return bool true if the error code was unset, false otherwise`
393	`* @access private`	416	`* @access private`
394	`* @since PHP 4.3.0`	417	`* @since PHP 4.3.0`
395	`*/`	418	`*/`
396	`function _checkDelExpect($error_code)`	419	`function _checkDelExpect($error_code)`
397	`{`	420	`{`
398	`$deleted = false;`	421	`$deleted = false;`
399		422
400	`foreach ($this->_expected_errors AS $key => $error_array) {`	423	`foreach ($this->_expected_errors AS $key => $error_array) {`
401	`if (in_array($error_code, $error_array)) {`	424	`if (in_array($error_code, $error_array)) {`
402	`unset($this->_expected_errors[$key][array_search($error_code, $error_array)]);`	425	`unset($this->_expected_errors[$key][array_search($error_code, $error_array)]);`
403	`$deleted = true;`	426	`$deleted = true;`
404	`}`	427	`}`
405		428
406	`// clean up empty arrays`	429	`// clean up empty arrays`
407	`if (0 == count($this->_expected_errors[$key])) {`	430	`if (0 == count($this->_expected_errors[$key])) {`
408	`unset($this->_expected_errors[$key]);`	431	`unset($this->_expected_errors[$key]);`
409	`}`	432	`}`
410	`}`	433	`}`
411	`return $deleted;`	434	`return $deleted;`
412	`}`	435	`}`
413		436
414	`// }}}`	437	`// }}}`
415	`// {{{ delExpect()`	438	`// {{{ delExpect()`
416		439
417	`/**`	440	`/**`
418	`* This method deletes all occurences of the specified element from`	441	`* This method deletes all occurences of the specified element from`
419	`* the expected error codes stack.`	442	`* the expected error codes stack.`
420	`*`	443	`*`
421	`* @param mixed $error_code error code that should be deleted`	444	`* @param mixed $error_code error code that should be deleted`
422	`* @return mixed list of error codes that were deleted or error`	445	`* @return mixed list of error codes that were deleted or error`
423	`* @access public`	446	`* @access public`
424	`* @since PHP 4.3.0`	447	`* @since PHP 4.3.0`
425	`*/`	448	`*/`
426	`function delExpect($error_code)`	449	`function delExpect($error_code)`
427	`{`	450	`{`
428	`$deleted = false;`	451	`$deleted = false;`
429		452
430	`if ((is_array($error_code) && (0 != count($error_code)))) {`	453	`if ((is_array($error_code) && (0 != count($error_code)))) {`
431	`// $error_code is a non-empty array here;`	454	`// $error_code is a non-empty array here;`
432	`// we walk through it trying to unset all`	455	`// we walk through it trying to unset all`
433	`// values`	456	`// values`
434	`foreach($error_code as $key => $error) {`	457	`foreach($error_code as $key => $error) {`
435	`if ($this->_checkDelExpect($error)) {`	458	`if ($this->_checkDelExpect($error)) {`
436	`$deleted = true;`	459	`$deleted = true;`
437	`} else {`	460	`} else {`
438	`$deleted = false;`	461	`$deleted = false;`
439	`}`	462	`}`
440	`}`	463	`}`
441	`return $deleted ? true : PEAR::raiseError("The expected error you submitted does not exist"); // IMPROVE ME`	464	`return $deleted ? true : PEAR::raiseError("The expected error you submitted does not exist"); // IMPROVE ME`
442	`} elseif (!empty($error_code)) {`	465	`} elseif (!empty($error_code)) {`
443	`// $error_code comes alone, trying to unset it`	466	`// $error_code comes alone, trying to unset it`
444	`if ($this->_checkDelExpect($error_code)) {`	467	`if ($this->_checkDelExpect($error_code)) {`
445	`return true;`	468	`return true;`
446	`} else {`	469	`} else {`
447	`return PEAR::raiseError("The expected error you submitted does not exist"); // IMPROVE ME`	470	`return PEAR::raiseError("The expected error you submitted does not exist"); // IMPROVE ME`
448	`}`	471	`}`
449	`} else {`	472	`} else {`
450	`// $error_code is empty`	473	`// $error_code is empty`
451	`return PEAR::raiseError("The expected error you submitted is empty"); // IMPROVE ME`	474	`return PEAR::raiseError("The expected error you submitted is empty"); // IMPROVE ME`
452	`}`	475	`}`
453	`}`	476	`}`
454		477
455	`// }}}`	478	`// }}}`
456	`// {{{ raiseError()`	479	`// {{{ raiseError()`
457		480
458	`/**`	481	`/**`
459	`* This method is a wrapper that returns an instance of the`	482	`* This method is a wrapper that returns an instance of the`
460	`* configured error class with this object's default error`	483	`* configured error class with this object's default error`
461	`* handling applied. If the $mode and $options parameters are not`	484	`* handling applied. If the $mode and $options parameters are not`
462	`* specified, the object's defaults are used.`	485	`* specified, the object's defaults are used.`
463	`*`	486	`*`
464	`* @param mixed $message a text error message or a PEAR error object`	487	`* @param mixed $message a text error message or a PEAR error object`
465	`*`	488	`*`
466	`* @param int $code a numeric error code (it is up to your class`	489	`* @param int $code a numeric error code (it is up to your class`
467	`* to define these if you want to use codes)`	490	`* to define these if you want to use codes)`
468	`*`	491	`*`
469	`* @param int $mode One of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT,`	492	`* @param int $mode One of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT,`
470	`* PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE,`	493	`* PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE,`
471	`* PEAR_ERROR_CALLBACK, PEAR_ERROR_EXCEPTION.`	494	`* PEAR_ERROR_CALLBACK, PEAR_ERROR_EXCEPTION.`
472	`*`	495	`*`

Subversion Repositories Applications.papyrus

(root)/trunk/api/pear/PEAR.php @ 445 – Rev 320 → 1173