Class LoggerLoggingEvent

Description

The internal representation of logging event.

  • version: $Revision: 832662 $

Located in /LoggerLoggingEvent.php (line 27)


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

Level of logging event.

This field should not be accessed directly. You shoud use the getLevel() method instead.

  • deprecated:
  • access: protected
float $timeStamp (line 106)

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

  • access: public
Methods
static getStartTime (line 286)

Returns the time when the application started, in seconds elapsed since 01.01.1970 plus microseconds if available.

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

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 $priority, mixed $message, [integer $timeStamp = null])
  • string $fqcn: name of the caller class.
  • mixed $logger: The Logger category of this event or the logger name.
  • LoggerLevel $priority: The level of this event.
  • mixed $message: The message of this event.
  • integer $timeStamp: the timestamp of this logging event.
getLevel (line 204)

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

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

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 ()
getLoggerName (line 213)

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

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

Returns the the context corresponding to the

parameter.

  • access: public
string getMDC ( $key)
  • $key
getMessage (line 226)

Return the message for this logging event.

Before serialization, the returned object is the message passed by the user to generate the logging event. After serialization, the returned value equals the String form of the message possibly after object rendering.

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

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 ()
getRenderedMessage (line 262)

Render message.

  • access: public
string getRenderedMessage ()
getThreadName (line 318)
  • access: public
mixed getThreadName ()
getThrowableInformation (line 328)
  • return: null
  • access: public
mixed getThrowableInformation ()
getTime (line 309)

Calculates the time of this event.

  • return: time after event starttime when this event has occured
  • access: public
the getTime ()
getTimeStamp (line 301)
  • access: public
float getTimeStamp ()
toString (line 336)

Serialize this object

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

Avoid serialization of the $logger object

  • access: public
void __sleep ()

Documentation generated on Fri, 27 Nov 2009 07:44:51 +0100 by phpDocumentor 1.4.3