22

✏️ Editing: Log::LogLite.3pm

.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "LogLite 3"
.TH LogLite 3 "2002-09-24" "perl v5.26.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Log::LogLite \- The "Log::LogLite" class helps us create simple logs for our application.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&  use Log::LogLite;
\&  my $LOG_DIRECTORY = "/where/ever/our/log/file/should/be"; 
\&  my $ERROR_LOG_LEVEL = 6; 
\&               
\&  # create new Log::LogLite object
\&  my $log = new Log::LogLite($LOG_DIRECTORY."/error.log", $ERROR_LOG_LEVEL);
\&
\&  ...
\&
\&  # we had an error
\&  $log\->write("Could not open the file ".$file_name.": $!", 4);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
In order to have a log we have first to create a \f(CW\*(C`Log::LogLite\*(C'\fR object. 
The c<Log::LogLite> object is created with a logging level. The default 
logging level is 5. After the \f(CW\*(C`Log::LogLite\*(C'\fR object is created, each call 
to the \f(CW\*(C`write\*(C'\fR method may write a new line in the log file. If the level
of the message is lower or equal to the logging level, the message will 
be written to the log file. The format of the logging messages can be 
controled by changing the template, and by defining a default message.
The class uses the IO::LockedFile class.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.IP "new ( \s-1FILEPATH\s0 [,LEVEL [,DEFAULT_MESSAGE ]] )" 4
.IX Item "new ( FILEPATH [,LEVEL [,DEFAULT_MESSAGE ]] )"
The constructor. \s-1FILEPATH\s0 is the path of the log file. \s-1LEVEL\s0 is the defined
logging level \- the \s-1LEVEL\s0 data member. \s-1DEFAULT_MESSAGE\s0 will define the 
\&\s-1DEFAULT_MESSAGE\s0 data member \- a message that will be added to the message 
of each entry in the log (according to the \s-1TEMPLATE\s0 data member, see below).
.Sp
The levels can be any levels that the user chooses to use. There are, 
though, recommended levels:
      0  the application is unusable
      1  the application is going to be unusable
      2  critical conditions
      3  error conditions 
      4  warning conditions
      5  normal but significant condition
      6  informational
      7+ debug-level messages
.Sp
The default value of \s-1LEVEL\s0 is 5.
The default value of \s-1DEFAULT_MESSAGE\s0 is "".
Returns the new object.
.SH "METHODS"
.IX Header "METHODS"
.IP "write( \s-1MESSAGE\s0 [, \s-1LEVEL\s0 ] )" 4
.IX Item "write( MESSAGE [, LEVEL ] )"
If \s-1LEVEL\s0 is less or equal to the \s-1LEVEL\s0 data member, or if \s-1LEVEL\s0 is undefined, 
the string in \s-1MESSAGE\s0 will be written to the log file.
Does not return anything.
.IP "level( [ \s-1LEVEL\s0 ] )" 4
.IX Item "level( [ LEVEL ] )"
Access method to the \s-1LEVEL\s0 data member. If \s-1LEVEL\s0 is defined, the \s-1LEVEL\s0 data 
member will get its value. 
Returns the value of the \s-1LEVEL\s0 data member.
.IP "default_message( [ \s-1MESSAGE\s0 ] )" 4
.IX Item "default_message( [ MESSAGE ] )"
Access method to the \s-1DEFAULT_MESSAGE\s0 data member. If \s-1MESSAGE\s0 is defined, the
\&\s-1DEFAULT_MESSAGE\s0 data member will get its value. 
Returns the value of the \s-1DEFAULT_MESSAGE\s0 data member.
.IP "log_line_numbers( [ \s-1BOOLEAN\s0 ] )" 4
.IX Item "log_line_numbers( [ BOOLEAN ] )"
If this flag is set to true, the <called_by> string will hold the file 
that calls the subroutine and the line where the call is issued. The default
value is zero.
.IP "template( [ \s-1TEMPLATE\s0 ] )" 4
.IX Item "template( [ TEMPLATE ] )"
Access method to the \s-1TEMPLATE\s0 data member. The \s-1TEMPLATE\s0 data member is a string
that defines how the log entries will look like. The default \s-1TEMPLATE\s0 is:
.Sp
\&'[<date>] <<level>> <called_by><default_message><message>'
.Sp
Where:
.Sp
.Vb 10
\&      <date>           will be replaced by a string that represent 
\&                        the date. For example: 09/01/2000 17:00:13
\&      <level>          will be replaced by the level of the entry.
\&      <called_by>       will be replaced by a call trace string. For 
\&                        example:
\&                        CGIDaemon::listen > MyCGIDaemon::accepted 
\&      <default_message> will be replaced by the value of the 
\&                        DEFAULT_MESSAGE data member.
\&      <message>         will be replaced by the message string that 
\&                        is sent to the C<write> method.
.Ve
.Sp
Returns the value of the \s-1TEMPLATE\s0 data member.
.SH "AUTHOR"
.IX Header "AUTHOR"
Rani Pinchuk, rani@cpan.org
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2001\-2002 Ockham Technology N.V. & Rani Pinchuk. 
All rights reserved.  
This package is free software; you can redistribute it and/or modify 
it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBIO::LockedFile\fR\|(3)
.SH "POD ERRORS"
.IX Header "POD ERRORS"
Hey! \fBThe above document had some coding errors, which are explained below:\fR
.IP "Around line 282:" 4
.IX Item "Around line 282:"
You forgot a '=back' before '=head1'

MR SKB