This class contains the file writer class for the logging mechanism.
__construct(array $options)
array
Array with options for the writer instance (optional)
factory(string $writerName, array $writerOptions) : \cLogWriter
inherited_from | \cLogWriter::factory() |
---|
string
Name of the writer
array
Options array for the writer instance
\cInvalidArgumentException |
if the writer class with the given name does not exist or is not an instance of clogWriter |
---|
\cLogWriter
Log writer instancegetOption(string $option) : mixed
inherited_from | \cLogWriter::getOption() |
---|
string
Name of the option
mixed
Value of the option entrygetOptions() : array
inherited_from | \cLogWriter::getOptions() |
---|
array
Array with all optionsremoveOption(string $option) : void
inherited_from | \cLogWriter::removeOption() |
---|
string
Name of the option
setOption(string $option, mixed $value, boolean $force) : void
If option was set previously, it must be forced to overwrite the value.
inherited_from | \cLogWriter::setOption() |
---|
string
Name of the option
mixed
Value of the option
boolean
Flag to force setting the option value (optional, default: false)
setOptions(array $options) : void
inherited_from | \cLogWriter::setOptions() |
---|
array
Array with options
write(string $message, int $priority) : boolean
This method must be implemented in the specific writer.
string
Message to write
int
Priority of the log entry
boolean
State of the write process_createHandle() : void
\cException |
if not destination is specified |
---|---|
\cFileNotFoundException |
if the destination file could not be read |
$_handle : resource