Docs For Class HTML_Progress2

Class: HTML_Progress2_Error

Class Overview

PEAR_Error
   |
   --HTML_Progress2_Error

This class creates a progress error object, extending the PEAR_Error class.

Author(s):

Laurent Laville <pear at laurent-laville.org>

Version:

Release: @package_version@

Copyright:

2005-2008 Laurent Laville

Methods

Inherited Variables

Inherited Methods

Class Details

[line 59]
This class creates a progress error object, extending the PEAR_Error class.

Author: Laurent Laville <pear@laurent-laville.org>
Version: Release: @package_version@
Copyright: 2005-2008 Laurent Laville
Link: http://pear.php.net/package/HTML_Progress2
Since: Class available since Release 2.0.0RC1
License: New BSD License

Method Detail

__construct (Constructor) [line 100]

HTML_Progress2_Error __construct(
[string
$message = null], [int
$code = null], [int
$mode = null], [mixed
$options = null], [string
$userinfo = null])

Constructor (ZE2)

Since: version 2.0.0 (2005-10-01)
Access: public

Parameters:

string	`$message`	—	(optional) Final error message
int	`$code`	—	(optional) Error code
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
mixed	`$options`	—	(optional) error level, _OR_ in the case of PEAR_ERROR_CALLBACK, the callback function
string	`$userinfo`	—	(optional) additional user/debug info

[ Top ]

HTML_Progress2_Error (Constructor) [line 77]

HTML_Progress2_Error HTML_Progress2_Error(
[string
$message = null], [int
$code = null], [int
$mode = null], [mixed
$options = null], [string
$userinfo = null])

Constructor (ZE1)

Since: version 2.0.0 (2005-10-01)
Access: public

Parameters:

string	`$message`	—	(optional) Final error message
int	`$code`	—	(optional) Error code
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
mixed	`$options`	—	(optional) error level, _OR_ in the case of PEAR_ERROR_CALLBACK, the callback function
string	`$userinfo`	—	(optional) additional user/debug info

[ Top ]

getLevel [line 160]

int getLevel(
)

Get error level from an error object

Return: error level
Since: version 2.0.0 (2005-10-01)
Access: public

[ Top ]

log [line 172]

void log(
)

Default callback function/method from an error object

Since: version 2.0.0 (2005-10-01)
Access: public

[ Top ]

sprintContextExec [line 197]

string sprintContextExec(
string
$format)

Returns the context of execution formatted.

Since: version 2.0.0 (2005-10-01)
Access: public

Parameters:

string $format — the context of execution format

[ Top ]