Class LoggerAppenderConsole

Description

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.

Located in /appenders/LoggerAppenderConsole.php (line 36)

LoggerAppender
   |
   --LoggerAppenderSkeleton
      |
      --LoggerAppenderConsole
Class Constant Summary
 STDERR = 'php://stderr'
 STDOUT = 'php://stdout'
Variable Summary
mixed $fp
boolean $requiresLayout
string $target
Method Summary
void activateOptions ()
void append ( $event)
void close ()
void getTarget ()
void setTarget (mixed $value)
Variables
mixed $fp = false (line 58)
  • var: the resource used to open stdout/stderr
  • access: protected
boolean $requiresLayout = true (line 52)
  • access: protected

Redefinition of:
LoggerAppenderSkeleton::$requiresLayout
string $target = 'php://stdout' (line 46)

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

Default is STDOUT

  • access: protected

Inherited Variables

Inherited from LoggerAppenderSkeleton

LoggerAppenderSkeleton::$closed
LoggerAppenderSkeleton::$errorHandler
LoggerAppenderSkeleton::$headFilter
LoggerAppenderSkeleton::$layout
LoggerAppenderSkeleton::$name
LoggerAppenderSkeleton::$tailFilter
LoggerAppenderSkeleton::$threshold
Methods
activateOptions (line 79)
  • access: public
void activateOptions ()

Redefinition of:
LoggerAppenderSkeleton::activateOptions()
Derived appenders should override this method if option structure requires it.
append (line 98)
  • access: protected
void append ( $event)
  • $event

Redefinition of:
LoggerAppenderSkeleton::append()
Subclasses of LoggerAppenderSkeleton should implement this method to perform actual logging.
close (line 90)
void close ()

Redefinition of:
LoggerAppender::close()
Release any resources allocated.
getTarget (line 75)
  • access: public
void getTarget ()
setTarget (line 64)

Set console target.

  • access: public
void setTarget (mixed $value)
  • mixed $value: a constant or a string

Inherited Methods

Inherited From LoggerAppenderSkeleton

LoggerAppenderSkeleton::__construct()
LoggerAppenderSkeleton::activateOptions()
LoggerAppenderSkeleton::addFilter()
LoggerAppenderSkeleton::append()
LoggerAppenderSkeleton::clearFilters()
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()
LoggerAppenderSkeleton::__sleep()
LoggerAppenderSkeleton::__wakeup()

Inherited From LoggerAppender

LoggerAppender::addFilter()
LoggerAppender::clearFilters()
LoggerAppender::close()
LoggerAppender::doAppend()
LoggerAppender::factory()
LoggerAppender::getErrorHandler()
LoggerAppender::getFilter()
LoggerAppender::getLayout()
LoggerAppender::getName()
LoggerAppender::requiresLayout()
LoggerAppender::setErrorHandler()
LoggerAppender::setLayout()
LoggerAppender::setName()
LoggerAppender::singleton()
Class Constants
STDERR = 'php://stderr' (line 39)
STDOUT = 'php://stdout' (line 38)

Documentation generated by phpDocumentor 1.3.2