Horde_Log_Handler_Stream
extends Horde_Log_Handler_Base
in package
Tags
Table of Contents
- $_filters : array<string|int, mixed>
- List of filter objects.
- $_formatter : Horde_Log_Formatter
- Formats the log message before writing.
- $_mode : string
- The open mode.
- $_options : array<string|int, mixed>
- Options.
- $_stream : null|stream
- Holds the PHP stream to log to.
- $_streamOrUrl : string
- The stream to open.
- __construct() : mixed
- Class Constructor
- __wakeup() : mixed
- Wakup function - reattaches stream.
- 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()
$_formatter
Formats the log message before writing.
protected
Horde_Log_Formatter
$_formatter
$_mode
The open mode.
protected
string
$_mode
$_options
Options.
protected
array<string|int, mixed>
$_options
= array('ident' => '')
$_stream
Holds the PHP stream to log to.
protected
null|stream
$_stream
= \null
$_streamOrUrl
The stream to open.
protected
string
$_streamOrUrl
Methods
__construct()
Class Constructor
public
__construct(mixed $streamOrUrl[, string $mode = 'a+' ][, Horde_Log_Formatter $formatter = null ]) : mixed
Parameters
- $streamOrUrl : mixed
-
Stream or URL to open as a stream.
- $mode : string = 'a+'
-
Mode, only applicable if a URL is given.
- $formatter : Horde_Log_Formatter = null
-
Log formatter.
Tags
Return values
mixed —__wakeup()
Wakup function - reattaches stream.
public
__wakeup() : mixed
Tags
Return values
mixed —addFilter()
Add a filter specific to this handler.
public
addFilter(Horde_Log_Filter $filter) : mixed
Parameters
- $filter : Horde_Log_Filter
-
Filter to add.
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
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.
Tags
Return values
bool —True.