Overview

Packages

  • log4php
    • appenders
    • configurators
    • filters
    • helpers
    • layouts
    • pattern
    • renderers

Classes

  • Logger
  • LoggerAppender
  • LoggerAppenderPool
  • LoggerAutoloader
  • LoggerConfigurable
  • LoggerConfiguratorDefault
  • LoggerFilter
  • LoggerHierarchy
  • LoggerLayout
  • LoggerLevel
  • LoggerLocationInfo
  • LoggerLoggingEvent
  • LoggerMDC
  • LoggerNDC
  • LoggerReflectionUtils
  • LoggerRoot
  • LoggerThrowableInformation

Interfaces

  • LoggerConfigurator

Exceptions

  • LoggerException
  • Overview
  • Package
  • Class
  • Tree

Class LoggerLoggingEvent

The internal representation of logging event.

Package: log4php
Version: $Revision: 1382273 $
Located at LoggerLoggingEvent.php
Methods summary
public
# __construct( string $fqcn, mixed $logger, LoggerLevel $level, mixed $message, integer $timeStamp = null, Exception $throwable = null )

Instantiate a LoggingEvent from the supplied parameters.

Instantiate a LoggingEvent from the supplied parameters.

Except LoggerLoggingEvent::$timeStamp all the other fields of LoggerLoggingEvent are filled when actually needed.

Parameters

$fqcn
string
$fqcn name of the caller class.
$logger
mixed
$logger The Logger category of this event or the logger name.
$level
LoggerLevel
$level The level of this event.
$message
mixed
$message The message of this event.
$timeStamp
integer
$timeStamp the timestamp of this logging event.
$throwable
Exception
$throwable The throwable associated with logging event
public
# getFullQualifiedClassname( )

Returns the full qualified classname. TODO: PHP does contain namespaces in 5.3. Those should be returned too,

Returns the full qualified classname. TODO: PHP does contain namespaces in 5.3. Those should be returned too,

public LoggerLocationInfo
# getLocationInformation( )

Set the location information for this logging event. The collected information is cached for future use.

Set the location information for this logging event. The collected information is cached for future use.

This method uses PHP_MANUAL#debug_backtrace debug_backtrace() function (if exists) to collect informations about caller.

It only recognize informations generated by Logger and its subclasses.

Returns

LoggerLocationInfo
public LoggerLevel
# getLevel( )

Return the level of this event. Use this form instead of directly accessing the LoggerLoggingEvent::$level field.

Return the level of this event. Use this form instead of directly accessing the LoggerLoggingEvent::$level field.

Returns

LoggerLevel
public Logger
# getLogger( )

Returns the logger which created the event.

Returns the logger which created the event.

Returns

Logger
public string
# getLoggerName( )

Return the name of the logger. Use this form instead of directly accessing the $categoryName field.

Return the name of the logger. Use this form instead of directly accessing the $categoryName field.

Returns

string
public mixed
# getMessage( )

Return the message for this logging event.

Return the message for this logging event.

Returns

mixed
public string
# getNDC( )

This method returns the NDC for this event. It will return the correct content even if the event was generated in a different thread or even on a different machine. The LoggerNDC::get() method should never be called directly.

This method returns the NDC for this event. It will return the correct content even if the event was generated in a different thread or even on a different machine. The LoggerNDC::get() method should never be called directly.

Returns

string
public string
# getMDC( mixed $key )

Returns the the context corresponding to the <span class="php-keyword2">key</span> parameter.

Returns the the context corresponding to the <span class="php-keyword2">key</span> parameter.

Returns

string
public array
# getMDCMap( )

Returns the entire MDC context.

Returns the entire MDC context.

Returns

array
public string
# getRenderedMessage( )

Render message.

Render message.

Returns

string
public static float
# getStartTime( )

Returns the time when the application started, as a UNIX timestamp with microseconds.

Returns the time when the application started, as a UNIX timestamp with microseconds.

Returns

float
public float
# getTimeStamp( )

Returns

float
public float
# getRelativeTime( )

Returns the time in seconds passed from the beginning of execution to the time the event was constructed.

Returns the time in seconds passed from the beginning of execution to the time the event was constructed.

Returns

float
Seconds with microseconds in decimals.
public mixed
# getThreadName( )

Returns

mixed
public mixed
# getThrowableInformation( )

Returns

mixed
LoggerThrowableInformation
public string
# toString( )

Serialize this object

Serialize this object

Returns

string
public
# __sleep( )

Avoid serialization of the $logger object

Avoid serialization of the $logger object

Properties summary
protected LoggerLevel $level
#

Level of the logging event.

Level of the logging event.

public float $timeStamp
#

The number of seconds elapsed from 1/1/1970 until logging event was created plus microseconds if available.

The number of seconds elapsed from 1/1/1970 until logging event was created plus microseconds if available.

Apache log4php API documentation generated by ApiGen 2.8.0