Log::Dispatch::Output - Base class for all Log::Dispatch::* object
package Log::Dispatch::MySubclass; use Log::Dispatch::Output; use base qw( Log::Dispatch::Output ); sub new { my $proto = shift; my $class = ref $proto || $proto; my %params = @_; my $self; { no strict 'refs'; $self = bless [ \%{"${class}::FIELDS"} ], $class; } $self->_basic_init(%params); # Do more if you like } sub log { my Log::Dispatch::MySubclass $self = shift; my %params = @_; return unless $self->_should_log($params{level}); # Do something with message in $params{message} }
This module is the base class from which all Log::Dispatch::* objects should be derived.
new(%PARAMS)
This must be overridden in a subclass.
_basic_init(%PARAMS)
This should be called from a subclass's constructor. Make sure to pass the arguments in @_ to it. It sets the object's name and minimum level. It also sets up two other attributes which are used by other Log::Dispatch::Output methods, level_names and level_numbers.
name
Returns the object's name.
min_level
Returns the object's minimum log level.
max_level
Returns the object's maximum log level.
log( level => $, message => $ )
Sends a message if the level is greater than or equal to the object's minimum level. This method must be overridden in the subclass.
_should_log ($)
This method should be called from the subclass's log() method with the log level of the message to be logged as an argument. It returns a boolean value indicating whether or not the message should be logged by this particular object. The log() method should not process the message if the return value is not true.
log()
_level_as_number ($)
This method will take a log level as a string (or a number) and return the number of that log level. If not given an argument, it returns the calling object's log level instead. If it cannot determine the level then it will issue a warning and return undef.
This class should be used as the base class for all logging objects you create that you would like to work under the Log::Dispatch architecture. Subclassing is fairly trivial. For most subclasses, if you simply copy the code in the SYNOPSIS and then put some functionality into the log method then you should be all set. Please make sure to use the _basic_init method as directed.
log
_basic_init
Dave Rolsky, <autarch@urth.org>
Log::Dispatch, Log::Dispatch::Email, Log::Dispatch::Email::MailSend, Log::Dispatch::Email::MailSendmail, Log::Dispatch::Email::MIMELite, Log::Dispatch::File, Log::Dispatch::Handle, Log::Dispatch::Screen, Log::Dispatch::Syslog
To install Log::Dispatch, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Log::Dispatch
CPAN shell
perl -MCPAN -e shell install Log::Dispatch
For more information on module installation, please visit the detailed CPAN module installation guide.