Static Public Member Functions |
| static & | getStaticProperty ($class, $var) |
| static | isError ($data, $code=null) |
| static & | raiseError ($message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false) |
Detailed Description
Definition at line 102 of file PEAR.php.
Member Function Documentation
| _checkDelExpect |
( |
|
$error_code | ) |
|
This method checks unsets an error code if available
- Parameters
-
- 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.
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.
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.
| 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.
| static& getStaticProperty |
( |
|
$class, |
|
|
|
$var |
|
) |
| |
|
static |
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.
| static isError |
( |
|
$data, |
|
|
|
$code = null |
|
) |
| |
|
static |
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.
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.
| 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.
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.
| 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.
| static& raiseError |
( |
|
$message = null, |
|
|
|
$code = null, |
|
|
|
$mode = null, |
|
|
|
$options = null, |
|
|
|
$userinfo = null, |
|
|
|
$error_class = null, |
|
|
|
$skipmsg = false |
|
) |
| |
|
static |
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.
| 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.
| 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.
| staticPopErrorHandling |
( |
| ) |
|
| staticPushErrorHandling |
( |
|
$mode, |
|
|
|
$options = null |
|
) |
| |
| & throwError |
( |
|
$message = null, |
|
|
|
$code = null, |
|
|
|
$userinfo = null |
|
) |
| |
Simpler form of raiseError with fewer options. In most cases message, code and userinfo are enough.
- Parameters
-
Definition at line 591 of file PEAR.php.
Field Documentation
| $_default_error_handler = '' |
| $_default_error_mode = null |
| $_default_error_options = null |
| $_expected_errors = array() |
The documentation for this class was generated from the following file:
1.8.1.2
