METHODS

Constructors

$obj->close

Only when initiated with a FILENAME, the file will be closed. In any other case, nothing will be done.

$class->new( TYPE, NAME, OPTIONS )
Option Defined in Default

accept

Log::Report::Dispatcher

depend on mode

charset

Log::Report::Dispatcher

<undef>

died

undef

exceptions

[]

format_reason

Log::Report::Dispatcher

'LOWERCASE'

locale

Log::Report::Dispatcher

<system locale>

mode

Log::Report::Dispatcher

'NORMAL'

accept => REASONS
charset => CHARSET
died => STRING
The exit string ($@) of the eval'ed block.
exceptions => ARRAY-of-EXCEPTIONS
format_reason => 'UPPERCASE'|'LOWERCASE'|'UCFIRST'|'IGNORE'|CODE
locale => LOCALE
mode => 'NORMAL'|'VERBOSE'|'ASSERT'|'DEBUG'|0..3

Accessors

$obj->died( [STRING] )

The message which was reported by eval, which is used internally to catch problems in the try block.

$obj->exceptions

Returns all collected Log::Report::Exceptions. The last of them may be a fatal one. The other are non-fatal.

$obj->isDisabled
See isDisabled in Log::Report::Dispatcher.
$obj->mode
See mode in Log::Report::Dispatcher.
$obj->name
See name in Log::Report::Dispatcher.
$obj->needs
See needs in Log::Report::Dispatcher.
$obj->type
See type in Log::Report::Dispatcher.

Logging

$obj->collectLocation
$class->collectLocation
See collectLocation in Log::Report::Dispatcher.
$obj->collectStack( [MAXDEPTH] )
$class->collectStack( [MAXDEPTH] )
See collectStack in Log::Report::Dispatcher.
$obj->log( OPTS, REASON, MESSAGE )

Other dispatchers translate the message here, and make it leave the program. However, messages in a "try" block are only captured in an intermediate layer: they may never be presented to an end-users. And for sure, we do not know the language yet.

The MESSAGE is either a STRING or a Log::Report::Message.

$obj->reportAll( OPTIONS )

Re-cast the messages in all collect exceptions into the defined dispatchers, which were disabled during the try block. The OPTIONS will end-up as HASH-of-OPTIONS to Log::Report::report(); see Log::Report::Exception::throw() which does the job.

$obj->reportFatal

Re-cast only the fatal message to the defined dispatchers. If the block was left without problems, then nothing will be done. The OPTIONS will end-up as HASH-of-OPTIONS to Log::Report::report(); see Log::Report::Exception::throw() which does the job.

$obj->stackTraceLine( OPTIONS )
$class->stackTraceLine( OPTIONS )
See stackTraceLine in Log::Report::Dispatcher.
$obj->translate( HASH-of-OPTIONS, REASON, MESSAGE )
See translate in Log::Report::Dispatcher.

Status

$obj->failed

Returns true if the block was left with an fatal message.

$obj->showStatus

If this object is kept in $@, and someone uses this as string, we want to show the fatal error message.

The message is not very informative for the good cause: we do not want people to simply print the $@, but wish for a re-cast of the message using reportAll() or reportFatal().

$obj->success

Returns true if the block exited normally.

$obj->wasFatal( OPTIONS )

Returns the Log::Report::Exception which caused the "try" block to die, otherwise an empty LIST (undef).

Option Default

class

undef

class => CLASS|REGEX
Only return the exception if it was fatal, and in the same time in the specified CLASS (as string) or matches the REGEX. See Log::Report::Message::inClass()