NAME

 Document::LogFile - LogFile file manager.

SYNOPSIS

 use Document::LogFile;
 $obj = Document::LogFile->new ($filespecobj);
 $obj = Document::LogFile->new ($filename)
 $okay = $obj->log ($string);

Inheritance

 UNIVERSAL

Description

This Class manages .log files contained within a Document directory. Every time something changes or of interest happens, a message may be written to .log.

Examples

 use Document::LogFile;
 my $baz       = Document::LogFile->new ($filespecobj);
 my $baz       = Document::LogFile->new ($pathname);
 my $waslogged = $baz->log ( Arf! Arf! );

Class Variables

 None.

Instance Variables

 None.

Class Methods

$obj = Document::LogFile->new ($filespecobj)

$obj = Document::LogFile->new ($filename)

Create an object to allow communications with a log file object of a Document directory defined by $filename or $filespecobj. If there is currently no file in it named .log, create one and emit a log creation message to it.

Objects of this Class may be used as inputs to the Fault::Logger class.

All of the path information comes either from a preparsed filename in $filespecobj, a File::Spec::DatedPage object, or a string containing a pathname to the target Document directory.

[Can we get by with a File::Spec::Dated object?]

Instance Methods

$okay = $obj->log ($string)

Write a time-stamped message into the .log file of the form:

       20021207223010 $string\n

and return true if we succeeded in doing so.

Private Class Methods

 None.

Private Instance Methods

 None.

KNOWN BUGS

 See TODO.

SEE ALSO

Fault::ErrorHandler, DMA::ISODate, File::Spec::DatedPage

AUTHOR

Dale Amon <amon@vnl.com>