Class stream

Writes log data to a defined or provided stream.

Core\Object implements Core\Chainable

Core\Set implements Core\Accessor

Core\Log

Core\Log\Driver\stream

Namespace: Core\Log\Driver
Package: Core\Log
Since: 3.1
Requires: PHP 5.3
Version: 1.0
Located at Log/Driver/stream.inc.php

Methods summary

`protected`	# `__construct( Core\URI $uri )` Use auto-create factory to instantiate a logger instance. Automatically instantiates a stream for the embedded target URI in the URL path, if not empty. Use auto-create factory to instantiate a logger instance. Automatically instantiates a stream for the embedded target URI in the URL path, if not empty. Parameters `$uri` Factory driver URI. Since 3.1 Overrides `Core\Log::__construct`
`protected true\|mixed`	# `_report( string $priority, string $ident, string $component, string $message, array $infoSet = null, array $sourceInfo = null )` Actual logger method implemented by drivers to process a new log entry. Actual logger method implemented by drivers to process a new log entry. Parameters `$priority` See `Core\Log::report()` method. `$ident` Application identifier from configuration. `$component` See `Core\Log::report()` method. `$message` See `Core\Log::report()` method. `$infoSet` See `Core\Log::report()` method. `$sourceInfo` See `Core\Log::report()` method. Returns true\|mixed A log driver must return `true` on success, any other return value is considered an error. Drivers may return additional error information. Since 3.1
`public integer\|boolean`	# `chain( Core\Chainable $object, array $flags = null )` Connects another object to the current object. Usage depends on the actual class implementation; common examples are lazy configuration completion or layer expansions. Allows to associate an existing stream instead of creating a new one. Connects another object to the current object. Usage depends on the actual class implementation; common examples are lazy configuration completion or layer expansions. Allows to associate an existing stream instead of creating a new one. A previously associated stream instance will be removed, this includes streams opened by the driver itself. Parameters `$object` Object to chain to instance. `$flags` Optional array of additional chain flags. Usage depends on the actual chain implementation. Returns integer\|boolean Returns a non-zero value on success, otherwise `false`. Throws Exception\InvalidArgument Class of provided object is not supported. Since 3.1 Overrides `Core\Log::chain`

Constants summary

Constants inherited from Core\Log

AcceptPriorityParameter, Alert, Critical, Debug, Emergency, Error, IdentParameter, Info, Notice, Warning

Constants inherited from Core\Object

AnyParameterType, AutochainParameterType, AutocreateParameterType, BooleanParameterType, CharParameterType, EnumParameterType, IntegerParameterType, RealParameterType, StringParameterType, UserParameterType

Properties summary

`protected Core\Stream`	`$_v_stream` Assigned stream instance textual log entries are written to. Assigned stream instance textual log entries are written to. Since 3.1	#

Properties inherited from Core\Log

$_v_parameters, $_v_successor

Magic properties

`public read-only Core\Stream`	`$stream` Assigned stream instance textual log entries are written to.

Magic properties inherited from Core\Log

$ident, $successor

Magic properties inherited from Core\Object

$hash, $uuid

`protected`	# `__construct( Core\URI $uri )` Use auto-create factory to instantiate a logger instance. Automatically instantiates a stream for the embedded target URI in the URL path, if not empty. Use auto-create factory to instantiate a logger instance. Automatically instantiates a stream for the embedded target URI in the URL path, if not empty. Parameters `$uri` Factory driver URI. Since 3.1 Overrides `Core\Log::__construct`
`protected true\|mixed`	# `_report( string $priority, string $ident, string $component, string $message, array $infoSet = null, array $sourceInfo = null )` Actual logger method implemented by drivers to process a new log entry. Actual logger method implemented by drivers to process a new log entry. Parameters `$priority` See `Core\Log::report()` method. `$ident` Application identifier from configuration. `$component` See `Core\Log::report()` method. `$message` See `Core\Log::report()` method. `$infoSet` See `Core\Log::report()` method. `$sourceInfo` See `Core\Log::report()` method. Returns true\|mixed A log driver must return `true` on success, any other return value is considered an error. Drivers may return additional error information. Since 3.1
`public integer\|boolean`	# `chain( Core\Chainable $object, array $flags = null )` Connects another object to the current object. Usage depends on the actual class implementation; common examples are lazy configuration completion or layer expansions. Allows to associate an existing stream instead of creating a new one. Connects another object to the current object. Usage depends on the actual class implementation; common examples are lazy configuration completion or layer expansions. Allows to associate an existing stream instead of creating a new one. A previously associated stream instance will be removed, this includes streams opened by the driver itself. Parameters `$object` Object to chain to instance. `$flags` Optional array of additional chain flags. Usage depends on the actual chain implementation. Returns integer\|boolean Returns a non-zero value on success, otherwise `false`. Throws Exception\InvalidArgument Class of provided object is not supported. Since 3.1 Overrides `Core\Log::chain`

Namespaces

Classes

Class stream

Methods summary

Parameters

Since

Overrides

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Overrides

Methods inherited from Core\Log

Methods inherited from Core\Set

Methods inherited from Core\Object

Constants summary

Constants inherited from Core\Log

Constants inherited from Core\Object

Properties summary

Since

Properties inherited from Core\Log

Magic properties

Magic properties inherited from Core\Log

Magic properties inherited from Core\Object