This class contains the file writer class for the logging mechanism.
__construct(array $options)
arrayArray with options for the writer instance (optional)
factory(string $writerName, array $writerOptions) : \cLogWriter
| inherited_from | \cLogWriter::factory() |
|---|
stringName of the writer
arrayOptions array for the writer instance
\cInvalidArgumentException |
if the writer class with the given name does not exist or is not an instance of clogWriter |
|---|
\cLogWriterLog writer instancegetOption(string $option) : mixed
| inherited_from | \cLogWriter::getOption() |
|---|
stringName of the option
mixedValue of the option entrygetOptions() : array
| inherited_from | \cLogWriter::getOptions() |
|---|
arrayArray with all optionsremoveOption(string $option) : void
| inherited_from | \cLogWriter::removeOption() |
|---|
stringName 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() |
|---|
stringName of the option
mixedValue of the option
booleanFlag to force setting the option value (optional, default: false)
setOptions(array $options) : void
| inherited_from | \cLogWriter::setOptions() |
|---|
arrayArray with options
write(string $message, int $priority) : boolean
This method must be implemented in the specific writer.
stringMessage to write
intPriority of the log entry
booleanState of the write process_createHandle() : void
\cException |
if not destination is specified |
|---|---|
\cFileNotFoundException |
if the destination file could not be read |
$_handle : resource