log::dispatch::file(3pm) [debian man page]

Log::Dispatch::File(3pm)				User Contributed Perl Documentation				  Log::Dispatch::File(3pm)

NAME

       Log::Dispatch::File - Object for logging to files

VERSION

       version 2.32

SYNOPSIS

	 use Log::Dispatch;

	 my $log = Log::Dispatch->new(
	     outputs => [
		 [
		     'File',
		     min_level => 'info',
		     filename  => 'Somefile.log',
		     mode      => '>>',
		     newline   => 1
		 ]
	     ],
	 );

	 $log->emerg("I've fallen and I can't get up");

DESCRIPTION

       This module provides a simple object for logging to files under the Log::Dispatch::* system.

       Note that a newline will not be added automatically at the end of a message by default.	To do that, pass "newline => 1".

CONSTRUCTOR

       The constructor takes the following parameters in addition to the standard parameters documented in Log::Dispatch::Output:

       o   filename ($)

	   The filename to be opened for writing.

       o   mode ($)

	   The mode the file should be opened with.  Valid options are 'write', '>', 'append', '>>', or the relevant constants from Fcntl.  The
	   default is 'write'.

       o   binmode ($)

	   A layer name to be passed to binmode, like ":encoding(UTF-8)" or ":raw".

       o   close_after_write ($)

	   Whether or not the file should be closed after each write.  This defaults to false.

	   If this is true, then the mode will aways be append, so that the file is not re-written for each new message.

       o   autoflush ($)

	   Whether or not the file should be autoflushed.  This defaults to true.

       o   permissions ($)

	   If the file does not already exist, the permissions that it should be created with.	Optional.  The argument passed must be a valid
	   octal value, such as 0600 or the constants available from Fcntl, like S_IRUSR|S_IWUSR.

	   See "chmod" in perlfunc for more on potential traps when passing octal values around.  Most importantly, remember that if you pass a
	   string that looks like an octal value, like this:

	    my $mode = '0644';

	   Then the resulting file will end up with permissions like this:

	    --w----r-T

	   which is probably not what you want.

AUTHOR

       Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE

       This software is Copyright (c) 2011 by Dave Rolsky.

       This is free software, licensed under:

	 The Artistic License 2.0 (GPL Compatible)

perl v5.14.2							    2012-05-25						  Log::Dispatch::File(3pm)

Log::Dispatch::Output(3)				User Contributed Perl Documentation				  Log::Dispatch::Output(3)

NAME

       Log::Dispatch::Output - Base class for all Log::Dispatch::* objects

SYNOPSIS

	 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 %p = @_;

	     my $self = bless {}, $class;

	     $self->_basic_init(%p);

	     # Do more if you like

	     return $self;
	 }

	 sub log_message
	 {
	     my $self = shift;
	     my %p = @_;

	     # Do something with message in $p{message}
	 }

	 1;

DESCRIPTION

       This module is the base class from which all Log::Dispatch::* objects should be derived.

CONSTRUCTOR

       The constructor, "new", must be overridden in a subclass. See Output Classes for a description of the common parameters accepted by this
       constructor.

METHODS

       o   _basic_init(%p)

	   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.

       o   name

	   Returns the object's name.

       o   min_level

	   Returns the object's minimum log level.

       o   max_level

	   Returns the object's maximum log level.

       o   accepted_levels

	   Returns a list of the object's accepted levels (by name) from minimum to maximum.

       o   log( level => $, message => $ )

	   Sends a message if the level is greater than or equal to the object's minimum level.  This method applies any message formatting
	   callbacks that the object may have.

       o   _should_log ($)

	   This method is called from the "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 will not process the
	   message if the return value is false.

       o   _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 croak.

       o   add_callback( $code )

	   Adds a callback (like those given during construction). It is added to the end of the list of callbacks.

   Subclassing
       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_message" method then you should be all set.	Please make sure to use the "_basic_init" method as directed.

       The actual logging implementation should be done in a "log_message" method that you write. Do not override "log"!.

AUTHOR

       Dave Rolsky, <autarch@urth.org>

perl v5.12.1							    2009-09-22						  Log::Dispatch::Output(3)