Docs For Class LoggerAppenderConsole

Description

ConsoleAppender appends log events to STDOUT or STDERR using a layout specified by the user.

ConsoleAppender appends log events to STDOUT or STDERR using a layout specified by the user. Optional parameter is $target. The default target is Stdout.

Note: Use this Appender with command-line php scripts. On web scripts this appender has no effects.

This appender requires a layout.

version: $Revision: 1.8 $
author: VxR <mailto:vxr@vxr.it>

Located in Program_Root/log4php/appenders/LoggerAppenderConsole.php (line 47)

LoggerAppender
   |
   --LoggerAppenderSkeleton
      |
      --LoggerAppenderConsole

Variable Summary

mixed $requiresLayout

string $target

Method Summary

LoggerAppenderConsole LoggerAppenderConsole (string $name)

void activateOptions ()

void append (mixed $event)

void close ()

void getTarget ()

void setTarget (mixed $value)

Variables

mixed $requiresLayout = true (line 56)

Redefinition of:

LoggerAppenderSkeleton::$requiresLayout

string $target = 'php://stdout' (line 54)

Can be 'php://stdout' or 'php://stderr'.

Can be 'php://stdout' or 'php://stderr'. But it's better to use keywords STDOUT and STDERR (case insensitive). Default is STDOUT

Inherited Variables

Inherited from LoggerAppenderSkeleton

LoggerAppenderSkeleton::$closed
LoggerAppenderSkeleton::$errorHandler
LoggerAppenderSkeleton::$headFilter
LoggerAppenderSkeleton::$layout
LoggerAppenderSkeleton::$name
LoggerAppenderSkeleton::$tailFilter
LoggerAppenderSkeleton::$threshold

Methods

Constructor LoggerAppenderConsole (line 69)

Constructor.

LoggerAppenderConsole LoggerAppenderConsole (string $name)

string $name: appender name

activateOptions (line 96)

void activateOptions ()

Redefinition of:

LoggerAppenderSkeleton::activateOptions(): Called after the appender paramters are set with setter methods.

append (line 109)

void append (mixed $event)

Redefinition of:

LoggerAppenderSkeleton::append(): Subclasses of LoggerAppenderSkeleton should implement this method to perform actual logging.

close (line 103)

void close ()

Redefinition of:

LoggerAppenderSkeleton::close(): Release any resources allocated.

getTarget (line 91)

void getTarget ()

setTarget (line 78)

Set console target.

void setTarget (mixed $value)

mixed $value: a constant or a string

Inherited Methods

Inherited From LoggerAppenderSkeleton

LoggerAppenderSkeleton::LoggerAppenderSkeleton()
LoggerAppenderSkeleton::activateOptions()
LoggerAppenderSkeleton::addFilter()
LoggerAppenderSkeleton::append()
LoggerAppenderSkeleton::clearFilters()
LoggerAppenderSkeleton::close()
LoggerAppenderSkeleton::doAppend()
LoggerAppenderSkeleton::finalize()
LoggerAppenderSkeleton::getErrorHandler()
LoggerAppenderSkeleton::getFilter()
LoggerAppenderSkeleton::getFirstFilter()
LoggerAppenderSkeleton::getLayout()
LoggerAppenderSkeleton::getName()
LoggerAppenderSkeleton::getThreshold()
LoggerAppenderSkeleton::isAsSevereAsThreshold()
LoggerAppenderSkeleton::requiresLayout()
LoggerAppenderSkeleton::setErrorHandler()
LoggerAppenderSkeleton::setLayout()
LoggerAppenderSkeleton::setName()
LoggerAppenderSkeleton::setThreshold()

Inherited From LoggerAppender

LoggerAppender::factory()
LoggerAppender::singleton()