1. class
  2. Neos
  3. \
  4. Flow
  5. \
  6. Log
  7. \
  8. Backend
  9. \
  10. ConsoleBackend

ConsoleBackend

class ConsoleBackend extends AbstractBackend (View source)

A log backend which writes log entries to the console (STDOUT or STDERR)

Properties

protected int $severityThreshold

One of the LOG_* constants. Anything below that will be filtered out.

 from  AbstractBackend
protected bool $logIpAddress

Flag telling if the IP address of the current client (if available) should be logged.

 from  AbstractBackend
protected array $severityLabels

An array of severity labels, indexed by their integer constant
protected string $streamName

Stream name to use (stdout, stderr)
protected resource $streamHandle

Methods

__construct(mixed $options = [])

Constructs this log backend

from  AbstractBackend
void
setSeverityThreshold(int $severityThreshold)

The maximum severity to log, anything less severe will not be logged.

from  AbstractBackend
void
setLogIpAddress(bool $logIpAddress)

Enables or disables logging of IP addresses.

from  AbstractBackend
void
open()

Carries out all actions necessary to prepare the logging backend, such as opening the log file or opening a database connection.

void
append(string $message, int $severity = LOG_INFO, mixed $additionalData = null, string $packageKey = null, string $className = null, string $methodName = null)

Appends the given message along with the additional information into the log.

void
close()

Carries out all actions necessary to cleanly close the logging backend, such as closing the log file or disconnecting from a database.

Details

in AbstractBackend at line 43
__construct(mixed $options = [])

Constructs this log backend

Parameters

mixed $options

Configuration options - depends on the actual backend

in AbstractBackend at line 62
void setSeverityThreshold(int $severityThreshold)

The maximum severity to log, anything less severe will not be logged.

Parameters

int $severityThreshold

One of the LOG_* constants

Return Value

void

in AbstractBackend at line 73
void setLogIpAddress(bool $logIpAddress)

Enables or disables logging of IP addresses.

Parameters

bool $logIpAddress

Set to true to enable logging of IP address, or false to disable

Return Value

void

at line 51
void open()

Carries out all actions necessary to prepare the logging backend, such as opening the log file or opening a database connection.

Return Value

void

Exceptions

CouldNotOpenResourceException

at line 82
void append(string $message, int $severity = LOG_INFO, mixed $additionalData = null, string $packageKey = null, string $className = null, string $methodName = null)

Appends the given message along with the additional information into the log.

Parameters

string $message

The message to log
int $severity

One of the LOG_* constants
mixed $additionalData

A variable containing more information about the event to be logged
string $packageKey

Key of the package triggering the log (determined automatically if not specified)
string $className

Name of the class triggering the log (determined automatically if not specified)
string $methodName

Name of the method triggering the log (determined automatically if not specified)

Return Value

void

at line 109
void close()

Carries out all actions necessary to cleanly close the logging backend, such as closing the log file or disconnecting from a database.

Note: for this backend we do nothing here and rely on PHP to close the stream handle when the request ends. This is to allow full logging until request end.

revise upon resolution of http://forge.typo3.org/issues/9861

Return Value

void