Class LoggerLoggingEvent

Description

The internal representation of logging event.

The internal representation of logging event.

Located in Program_Root/log4php/spi/LoggerLoggingEvent.php (line 40)


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

The category (logger) name.

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 45)
  • var: Fully Qualified Class Name of the calling category class.
LoggerLevel $level (line 69)

Level of logging event.

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

  • deprecated:
LoggerLocationInfo $locationInfo = null (line 122)
  • var: Location information for the caller.
Logger $logger = null (line 50)
  • var: reference
boolean $mdcCopyLookupRequired = true (line 91)

Have we tried to do an MDC lookup? If we did, there is no need to do it again. serialized.

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 96)
  • var: The application supplied message of logging event.
string $ndc (line 74)
  • var: The nested diagnostic context (NDC) of logging event.
boolean $ndcLookupRequired = true (line 83)

Have we tried to do an NDC lookup? If we did, there is no need to do it again. serialized. (incorrect) NDC.

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 (line 103)

The application supplied message rendered through the log4php objet rendering mechanism.

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

mixed $threadName = null (line 110)

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

The name of thread in which this logging event was generated. log4php saves here the process id via http://www.php.net/getmypid

float $timeStamp (line 117)

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.

Methods
Constructor LoggerLoggingEvent (line 145)

Instantiate a LoggingEvent from the supplied parameters.

Instantiate a LoggingEvent from the supplied parameters. Except $timeStamp all the other fields of LoggerLoggingEvent are filled when actually needed.

LoggerLoggingEvent LoggerLoggingEvent (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 221)

Return the level of this event. accessing the $level field.

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

LoggerLevel getLevel ()
getLocationInformation (line 177)

Set the location information for this logging event. 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 http://www.php.net/debug_backtrace function (if exists) to collect informations about caller.

It only recognize informations generated by Logger and its subclasses.

LoggerLocationInfo getLocationInformation ()
getLoggerName (line 231)

Return the name of the logger. accessing the $categoryName field.

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

string getLoggerName ()
getMDC (line 276)

Returns the the context corresponding to the


1 key
parameter.

Returns the the context corresponding to the


1 key
parameter.

string getMDC (mixed $key)
getMessage (line 245)

Return the message for this logging event.

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.

mixed getMessage ()
getNDC (line 261)

This method returns the NDC for this event. correct content even if the event was generated in a different thread or even on a different machine. 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.

string getNDC ()
getRenderedMessage (line 285)

Render message.

Render message.

string getRenderedMessage ()
getStartTime (line 314)

Returns the time when the application started, in seconds elapsed since 01.

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

  • static:
float getStartTime ()
getThreadName (line 340)
mixed getThreadName ()
getThrowableInformation (line 350)
  • return: null
mixed getThrowableInformation ()
getTimeStamp (line 332)
float getTimeStamp ()
toString (line 359)

Serialize this object

Serialize this object

string toString ()
__sleep (line 367)

Avoid serialization of the $logger object

Avoid serialization of the $logger object

void __sleep ()

Documentation generated on Mon, 1 Dec 2003 22:10:04 +0100 by phpDocumentor 1.2.2