PEAR_ErrorStack::singleton

PEAR_ErrorStack::singleton() – Return a single error stack for this package.

Synopsis

require_once 'PEAR/ErrorStack.php';

PEAR_ErrorStack & PEAR_ErrorStack::singleton ( string $package , callback $msgCallback = false , callback $contextCallback = false , boolean $throwPEAR_Error = false , string $stackClass = 'PEAR_ErrorStack' )

Backwards Compatibility Warning

As of PEAR 1.3.2, PEAR_ErrorStack no longer instantiates and returns an Exception object in PHP5, and the second-to-last parameter has been removed. Code that relies upon this behavior will break.

Description

Note that all parameters are ignored if the stack for package $package has already been instantiated

Parameter

string $package

name of the package this error stack represents

callback $msgCallback

callback used for error message generation

callback $contextCallback

callback used for context generation, defaults to getFileLine()

boolean $throwPEAR_Error

If TRUE, then PEAR::raiseError() will be called and a PEAR_Error object will be returned from calls to PEAR_ErrorStack::push()

string $stackClass

class to instantiate

Throws

No exceptions thrown.

Note

This function should be called statically.

Set an error code => error message mapping callback (Previous) Get a list of all errors since last purge, organized by package (Next)
Last updated: Wed, 26 Nov 2014 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

There are no user contributed notes for this page.