new()
Description:
The core constructor for the IO::SimpleLog object.
Will instantiate and return the log object, wrapped
around the log files of the appropriate nature
Input:
$core_filepath: The directory location of the log file
which force inputs will be sent to.
This is an optional parameter and can
also be set through the set_filepath()
method.
By default, if this parameter is set
and any others are not, all
STDERR and STDOUT output will also
be piped to this log location
$ex_filepath: An optional input that will direct the
location of either the STDERR or STDOUT
log locations.
This is an optional parameter and can
also be set through the set_exfilepath()
method.
Given this parameter, while the exc_filepath
is empty, both STDERR and STDOUT output will
be piped to this log location and not the
core_filepath.
$exc_filepath Much as the ex_filepath, will pipe the STDERR
output directly to this particular log location.
This is an optional parameter and can also be
set through the set_excfilepath() method.
Given the existance of this, as well as the
ex_filepath, all STDERR will be piped to this
directory while STDOUT will be piped to the
ex_filepath directory.
Output:
$this: The instantiated log wrapper for the file
pipes
set_core_filepath()
Description:
Will set the core log file location to the
object.
Input:
$filepath: The file path location of the log file
set_exfilepath()
Description:
Will set the log file location, relative to STDOUT
to the object.
Without the existance of the excfilepath, STDERR
will also be written to this location.
Input:
$filepath: The file path location of the log file
set_excfilepath()
Description:
Will set the log file location, relative to STDERR
to the object.
Upon a buffer dump, will write STDERR and STDOUT
to this location without the existance of the
exfilepath locale stored.
Input:
$filepath: The file path location of the log file
get_buffer_limit()
Description:
Will return the current buffer limit of the
logging object
Output:
The current log buffer limit; an integer
that represents the number of lines that will
be stored in memory before dumping to a log file
set_buffer_limit()
Description:
Will set the new buffer limit to the log file
Input:
The new log buffer limit; an integer that
represents the number of lines that will
be stored in memory before dumping to a log
file
log_message()
Description:
The standard input for log entries.
By default, the input message will be formatted into
the specified format within the parameters of the
object.
The output of this data will be to the location of
the core_filepath location
Input:
$log_message: A string formatted log message to
be intended to write to the
core_filepath location
AUTHOR
Name: Trevor Hall
E-mail: hallta@gmail.com
URL: http://trevorhall.blucorral.com
NAME
DESCRIPTION