Documentation

Horde_Log_Handler_Scribe extends Horde_Log_Handler_Base
in package

Tags
author

Mike Naberezny mike@maintainable.com

author

Chuck Hagenbuch chuck@horde.org

category

Horde

license

http://www.horde.org/licenses/bsd BSD

subpackage

Handlers

Table of Contents

$_filters  : array<string|int, mixed>
List of filter objects.
$_formatter  : Horde_Log_Formatter
Formats the log message before writing.
$_options  : array<string|int, mixed>
Options to be set by setOption().
$_scribe  : Horde_Scribe_Client
Scribe client.
__construct()  : mixed
Constructor.
addFilter()  : mixed
Add a filter specific to this handler.
log()  : mixed
Log a message to this handler.
setOption()  : bool
Sets an option specific to the implementation of the log handler.
write()  : bool
Write a message to the log.

Properties

$_filters

List of filter objects.

protected array<string|int, mixed> $_filters = array()

$_options

Options to be set by setOption().

protected array<string|int, mixed> $_options = array('addNewline' => \false, 'category' => 'default', 'ident' => '')

$_scribe

Scribe client.

protected Horde_Scribe_Client $_scribe

Methods

__construct()

Constructor.

public __construct(Horde_Scribe_Client $scribe[, Horde_Log_Formatter $formatter = null ]) : mixed
Parameters
$scribe : Horde_Scribe_Client

Scribe client.

$formatter : Horde_Log_Formatter = null

Log formatter.

Return values
mixed

log()

Log a message to this handler.

public log(array<string|int, mixed> $event) : mixed
Parameters
$event : array<string|int, mixed>

Log event.

Return values
mixed

setOption()

Sets an option specific to the implementation of the log handler.

public setOption(string $optionKey, mixed $optionValue) : bool
Parameters
$optionKey : string

Key name for the option to be changed. Keys are handler-specific.

$optionValue : mixed

New value to assign to the option

Tags
throws
Horde_Log_Exception
Return values
bool

True.

write()

Write a message to the log.

public write(array<string|int, mixed> $event) : bool
Parameters
$event : array<string|int, mixed>

Log event.

Return values
bool

True.

Search results