Class LoggerLoggingEvent

Description

The internal representation of logging event.

  • author: Marco Vassura
  • version: $Revision: 556801 $

Located in /spi/LoggerLoggingEvent.php (line 33)


	
			
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 ()
float getTimeStamp ()
string toString ()
void __sleep ()
Variables
mixed $categoryName (line 54)

The category (logger) name.

This field will be marked as private in future releases. Please do not access it directly. Use the getLoggerName() method instead.

  • deprecated:
string $fqcn (line 40)
  • var: Fully Qualified Class Name of the calling category class.
LoggerLevel $level (line 64)

Level of logging event.

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

  • deprecated:
  • access: protected
LoggerLocationInfo $locationInfo = null (line 117)
  • var: Location information for the caller.
Logger $logger = null (line 45)
  • var: reference
boolean $mdcCopyLookupRequired = true (line 86)

Have we tried to do an MDC lookup? If we did, there is no need to do it again. Note that its value is always false when serialized. See also the getMDC and getMDCCopy methods.

mixed $message (line 91)
  • var: The application supplied message of logging event.
string $ndc (line 69)
  • var: The nested diagnostic context (NDC) of logging event.
boolean $ndcLookupRequired = true (line 78)

Have we tried to do an NDC lookup? If we did, there is no need to do it again. Note that its value is always false when serialized. Thus, a receiving SocketNode will never use it's own (incorrect) NDC. See also writeObject method.

string $renderedMessage = null (line 98)

The application supplied message rendered through the log4php objet rendering mechanism. At present renderedMessage == message.

mixed $threadName = null (line 105)

The name of thread in which this logging event was generated.

log4php saves here the process id via getmypid()

float $timeStamp (line 112)

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 301)

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 131)

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 208)

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

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

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 218)

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

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

Returns the the context corresponding to the

parameter.

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

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 248)

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 272)

Render message.

  • access: public
string getRenderedMessage ()
getThreadName (line 324)
  • access: public
mixed getThreadName ()
getThrowableInformation (line 334)
  • return: null
  • access: public
mixed getThrowableInformation ()
getTimeStamp (line 316)
  • access: public
float getTimeStamp ()
toString (line 343)

Serialize this object

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

Avoid serialization of the $logger object

  • access: public
void __sleep ()

Documentation generated by phpDocumentor 1.3.2