API Documentation
\

\Horde_Log_Handler_Cli

Logs to the command line interface using Horde_Cli.

Summary

Methods
Properties
Constants
__construct()
__wakeup()
write()
addFilter()
log()
setOption()
No public properties found
No constants found
No protected methods found
$_formatter
$_stream
$_mode
$_streamOrUrl
$_options
$_filters
$_cli
N/A
No private methods found
No private properties found
N/A

Properties

$_formatter

$_formatter : \Horde_Log_Formatter

Formats the log message before writing.

Type

\Horde_Log_Formatter

$_stream

$_stream : null|\stream

Holds the PHP stream to log to.

Type

null|\stream

$_mode

$_mode : string

The open mode.

Type

string

$_streamOrUrl

$_streamOrUrl : string

The stream to open.

Type

string

$_options

$_options : array

Options.

Type

array

$_filters

$_filters : array

List of filter objects.

Type

array

$_cli

$_cli : \Horde_Cli

A CLI handler.

Type

\Horde_Cli

Methods

__construct()

__construct(\Horde_Log_Formatter  $formatter = null)

Class Constructor

Parameters

\Horde_Log_Formatter $formatter

Log formatter.

__wakeup()

__wakeup()

Wakup function - reattaches stream.

Throws

\Horde_Log_Exception

write()

write(array  $event) : boolean

Write a message to the log.

Parameters

array $event

Log event.

Throws

\Horde_Log_Exception

Returns

boolean —

True.

addFilter()

addFilter(\Horde_Log_Filter  $filter)

Add a filter specific to this handler.

Parameters

\Horde_Log_Filter $filter

Filter to add.

log()

log(array  $event)

Log a message to this handler.

Parameters

array $event

Log event.

setOption()

setOption(string  $optionKey, mixed  $optionValue) : boolean

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

Parameters

string $optionKey

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

New value to assign to the option

Throws

\Horde_Log_Exception

Returns

boolean —

True.