Class LoggerLoggingEvent

Description

The internal representation of logging event.

  • version: $Revision: 1382273 $

Located in /log4php/LoggerLoggingEvent.php (line 27)


	
			
Variable Summary
Method Summary
static float getStartTime ()
LoggerLoggingEvent __construct (string $fqcn, mixed $logger, LoggerLevel $level, mixed $message, [integer $timeStamp = null], [Exception $throwable = null])
string getLoggerName ()
string getMDC ( $key)
array getMDCMap ()
mixed getMessage ()
string getNDC ()
float getRelativeTime ()
string getRenderedMessage ()
mixed getThreadName ()
integer getTime ()
float getTimeStamp ()
string toString ()
void __sleep ()
Variables
LoggerLevel $level (line 54)

Level of the logging event.

  • access: protected
float $timeStamp (line 95)

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

  • access: public
Methods
static method getStartTime (line 284)

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

  • access: public
static float getStartTime ()
Constructor __construct (line 120)

Instantiate a LoggingEvent from the supplied parameters.

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

  • access: public
LoggerLoggingEvent __construct (string $fqcn, mixed $logger, LoggerLevel $level, mixed $message, [integer $timeStamp = null], [Exception $throwable = null])
  • string $fqcn: name of the caller class.
  • mixed $logger: The Logger category of this event or the logger name.
  • LoggerLevel $level: The level of this event.
  • mixed $message: The message of this event.
  • integer $timeStamp: the timestamp of this logging event.
  • Exception $throwable: The throwable associated with logging event
getFullQualifiedClassname (line 145)

Returns the full qualified classname.

TODO: PHP does contain namespaces in 5.3. Those should be returned too,

  • access: public
void getFullQualifiedClassname ()
getLevel (line 202)

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

  • access: public
LoggerLevel getLevel ()
getLocationInformation (line 158)

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

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

It only recognize informations generated by Logger and its subclasses.

  • access: public
LoggerLocationInfo getLocationInformation ()
getLogger (line 210)

Returns the logger which created the event.

  • access: public
Logger getLogger ()
getLoggerName (line 219)

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

  • access: public
string getLoggerName ()
getMDC (line 251)

Returns the the context corresponding to the

parameter.

  • access: public
string getMDC ( $key)
  • $key
getMDCMap (line 259)

Returns the entire MDC context.

  • access: public
array getMDCMap ()
getMessage (line 227)

Return the message for this logging event.

  • access: public
mixed getMessage ()
getNDC (line 238)

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.

  • access: public
string getNDC ()
getRelativeTime (line 304)

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

  • return: Seconds with microseconds in decimals.
  • access: public
float getRelativeTime ()
getRenderedMessage (line 267)

Render message.

  • access: public
string getRenderedMessage ()
getThreadName (line 326)
  • access: public
mixed getThreadName ()
getThrowableInformation (line 336)
  • return: LoggerThrowableInformation
  • access: public
mixed getThrowableInformation ()
getTime (line 317)

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

  • deprecated: This method has been replaced by getRelativeTime which does not perform unneccesary multiplication and formatting.
  • access: public
integer getTime ()
getTimeStamp (line 294)
  • access: public
float getTimeStamp ()
toString (line 344)

Serialize this object

  • access: public
string toString ()
__sleep (line 351)

Avoid serialization of the $logger object

  • access: public
void __sleep ()

Documentation generated on Thu, 16 Feb 2017 18:02:52 +0900 by phpDocumentor 1.4.4