TYPO3 CMS  TYPO3_7-6
Public Member Functions | Protected Attributes | Private Attributes | List of all members
TYPO3\CMS\Core\Log\LogRecord Class Reference
Inheritance diagram for TYPO3\CMS\Core\Log\LogRecord:

Public Member Functions

 __construct ($component='', $level, $message, array $data=[])
 
 setComponent ($component)
 
 getComponent ()
 
 setCreated ($created)
 
 getCreated ()
 
 setLevel ($level)
 
 getLevel ()
 
 setData ($data)
 
 getData ()
 
 addData (array $data)
 
 setMessage ($message)
 
 getMessage ()
 
 setRequestId ($requestId)
 
 getRequestId ()
 
 __toString ()
 
 toArray ()
 
 offsetExists ($offset)
 
 offsetGet ($offset)
 
 offsetSet ($offset, $value)
 
 offsetUnset ($offset)
 

Protected Attributes

 $requestId = ''
 
 $created = 0.0
 
 $component = ''
 
 $level = LogLevel::INFO
 
 $message = ''
 
 $data = []
 

Private Attributes

 $gettableProperties
 
 $settableProperties
 

Detailed Description

Log record

Definition at line 22 of file LogRecord.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Log\LogRecord::__construct (   $component = '',
  $level,
  $message,
array  $data = [] 
)

Constructor.

Parameters
string$componentAffected component
int$levelSeverity level (see )
string$messageLog message
array$dataAdditional data

Definition at line 99 of file LogRecord.php.

References TYPO3\CMS\Core\Log\LogRecord\$component, TYPO3\CMS\Core\Log\LogRecord\$data, TYPO3\CMS\Core\Log\LogRecord\$level, TYPO3\CMS\Core\Log\LogRecord\$message, TYPO3\CMS\Core\Core\Bootstrap\getInstance(), TYPO3\CMS\Core\Log\LogRecord\getRequestId(), and TYPO3\CMS\Core\Log\LogRecord\setRequestId().

Member Function Documentation

◆ __toString()

TYPO3\CMS\Core\Log\LogRecord::__toString ( )

Convert record to string for simple output, like echo(). Contents of data array is appended as JSON-encoded string

Returns
string

Definition at line 263 of file LogRecord.php.

References TYPO3\CMS\Core\Log\LogRecord\$data, and TYPO3\CMS\Core\Log\LogLevel\getName().

◆ addData()

TYPO3\CMS\Core\Log\LogRecord::addData ( array  $data)

Adds additional log data to already existing data and overwrites previously data using the same array keys.

Parameters
array$data
Returns

Definition at line 207 of file LogRecord.php.

Referenced by TYPO3\CMS\Core\Log\Processor\IntrospectionProcessor\processLogRecord().

◆ getComponent()

TYPO3\CMS\Core\Log\LogRecord::getComponent ( )

Returns the component

Returns
string Component key

Definition at line 126 of file LogRecord.php.

References TYPO3\CMS\Core\Log\LogRecord\$component.

Referenced by TYPO3\CMS\Core\Log\Writer\SyslogWriter\getMessageForSyslog(), TYPO3\CMS\Core\Log\Writer\PhpErrorLogWriter\writeLog(), TYPO3\CMS\Core\Log\Writer\DatabaseWriter\writeLog(), and TYPO3\CMS\Core\Log\Writer\FileWriter\writeLog().

◆ getCreated()

TYPO3\CMS\Core\Log\LogRecord::getCreated ( )

Returns the creation time

Returns
float Creation time as float

Definition at line 148 of file LogRecord.php.

References TYPO3\CMS\Core\Log\LogRecord\$created.

Referenced by TYPO3\CMS\Core\Log\Writer\DatabaseWriter\writeLog(), and TYPO3\CMS\Core\Log\Writer\FileWriter\writeLog().

◆ getData()

TYPO3\CMS\Core\Log\LogRecord::getData ( )

Returns the log data

Returns
array

Definition at line 195 of file LogRecord.php.

References TYPO3\CMS\Core\Log\LogRecord\$data.

Referenced by TYPO3\CMS\Core\Log\Writer\SyslogWriter\getMessageForSyslog(), TYPO3\CMS\Core\Log\Writer\PhpErrorLogWriter\writeLog(), TYPO3\CMS\Core\Log\Writer\DatabaseWriter\writeLog(), and TYPO3\CMS\Core\Log\Writer\FileWriter\writeLog().

◆ getLevel()

TYPO3\CMS\Core\Log\LogRecord::getLevel ( )

Returns the severity level

See also
Returns
int Severity level

Definition at line 173 of file LogRecord.php.

References TYPO3\CMS\Core\Log\LogRecord\$level.

Referenced by TYPO3\CMS\Core\Log\Logger\callProcessors(), TYPO3\CMS\Core\Log\Writer\PhpErrorLogWriter\writeLog(), TYPO3\CMS\Core\Log\Writer\DatabaseWriter\writeLog(), TYPO3\CMS\Core\Log\Writer\FileWriter\writeLog(), TYPO3\CMS\Core\Log\Writer\SyslogWriter\writeLog(), and TYPO3\CMS\Core\Log\Logger\writeLog().

◆ getMessage()

TYPO3\CMS\Core\Log\LogRecord::getMessage ( )

Returns the log message

Returns
string Log message

Definition at line 230 of file LogRecord.php.

References TYPO3\CMS\Core\Log\LogRecord\$message.

Referenced by TYPO3\CMS\Core\Log\Writer\SyslogWriter\getMessageForSyslog(), TYPO3\CMS\Core\Log\Writer\PhpErrorLogWriter\writeLog(), TYPO3\CMS\Core\Log\Writer\DatabaseWriter\writeLog(), and TYPO3\CMS\Core\Log\Writer\FileWriter\writeLog().

◆ getRequestId()

TYPO3\CMS\Core\Log\LogRecord::getRequestId ( )

Returns the request ID

Returns
string

Definition at line 252 of file LogRecord.php.

References TYPO3\CMS\Core\Log\LogRecord\$requestId.

Referenced by TYPO3\CMS\Core\Log\LogRecord\__construct(), TYPO3\CMS\Core\Log\Writer\SyslogWriter\getMessageForSyslog(), TYPO3\CMS\Core\Log\Writer\PhpErrorLogWriter\writeLog(), TYPO3\CMS\Core\Log\Writer\DatabaseWriter\writeLog(), and TYPO3\CMS\Core\Log\Writer\FileWriter\writeLog().

◆ offsetExists()

TYPO3\CMS\Core\Log\LogRecord::offsetExists (   $offset)

Checks whether an offset exists, required by ArrayAccess interface

Parameters
mixed$offset
Returns
bool

Definition at line 311 of file LogRecord.php.

◆ offsetGet()

TYPO3\CMS\Core\Log\LogRecord::offsetGet (   $offset)

Offset to retrieve, required by ArrayAccess interface

Parameters
mixed$offset
Returns
mixed

Definition at line 326 of file LogRecord.php.

◆ offsetSet()

TYPO3\CMS\Core\Log\LogRecord::offsetSet (   $offset,
  $value 
)

Offset to set, required by ArrayAccess interface

Parameters
mixed$offset
mixed$value
Returns
void

Definition at line 341 of file LogRecord.php.

◆ offsetUnset()

TYPO3\CMS\Core\Log\LogRecord::offsetUnset (   $offset)

Offset to unset, required by ArrayAccess interface

Parameters
mixed$offset
Returns
void

Definition at line 354 of file LogRecord.php.

◆ setComponent()

TYPO3\CMS\Core\Log\LogRecord::setComponent (   $component)

Sets the affected component

Parameters
string$componentComponent key
Returns

Definition at line 115 of file LogRecord.php.

References TYPO3\CMS\Core\Log\LogRecord\$component.

◆ setCreated()

TYPO3\CMS\Core\Log\LogRecord::setCreated (   $created)

Sets the the creation time

Parameters
float$createdCreation time as float
Returns

Definition at line 137 of file LogRecord.php.

References TYPO3\CMS\Core\Log\LogRecord\$created.

◆ setData()

TYPO3\CMS\Core\Log\LogRecord::setData (   $data)

Sets log data array

Parameters
array$data
Returns

Definition at line 184 of file LogRecord.php.

References TYPO3\CMS\Core\Log\LogRecord\$data.

◆ setLevel()

TYPO3\CMS\Core\Log\LogRecord::setLevel (   $level)

Sets the severity level

Parameters
int$levelSeverity level
Returns
See also

Definition at line 160 of file LogRecord.php.

References TYPO3\CMS\Core\Log\LogRecord\$level, and TYPO3\CMS\Core\Log\LogLevel\validateLevel().

◆ setMessage()

TYPO3\CMS\Core\Log\LogRecord::setMessage (   $message)

Sets the log message

Parameters
string | object$messageLog message. Usually a string, or an object that can be casted to string (implements __toString())
Returns

Definition at line 219 of file LogRecord.php.

References TYPO3\CMS\Core\Log\LogRecord\$message.

◆ setRequestId()

TYPO3\CMS\Core\Log\LogRecord::setRequestId (   $requestId)

Sets the request ID

Parameters
string$requestId
Returns

Definition at line 241 of file LogRecord.php.

References TYPO3\CMS\Core\Log\LogRecord\$requestId.

Referenced by TYPO3\CMS\Core\Log\LogRecord\__construct().

◆ toArray()

TYPO3\CMS\Core\Log\LogRecord::toArray ( )

Convert record to array

Returns
array

Definition at line 293 of file LogRecord.php.

References TYPO3\CMS\Core\Log\LogRecord\$component, TYPO3\CMS\Core\Log\LogRecord\$created, TYPO3\CMS\Core\Log\LogRecord\$data, TYPO3\CMS\Core\Log\LogRecord\$level, TYPO3\CMS\Core\Log\LogRecord\$message, and TYPO3\CMS\Core\Log\LogRecord\$requestId.

Member Data Documentation

◆ $component

TYPO3\CMS\Core\Log\LogRecord::$component = ''
protected

Definition at line 43 of file LogRecord.php.

Referenced by TYPO3\CMS\Core\Log\LogRecord\__construct(), TYPO3\CMS\Core\Log\LogRecord\getComponent(), TYPO3\CMS\Core\Log\LogRecord\setComponent(), and TYPO3\CMS\Core\Log\LogRecord\toArray().

◆ $created

TYPO3\CMS\Core\Log\LogRecord::$created = 0.0
protected

Definition at line 36 of file LogRecord.php.

Referenced by TYPO3\CMS\Core\Log\LogRecord\getCreated(), TYPO3\CMS\Core\Log\LogRecord\setCreated(), and TYPO3\CMS\Core\Log\LogRecord\toArray().

◆ $data

TYPO3\CMS\Core\Log\LogRecord::$data = []
protected

Definition at line 64 of file LogRecord.php.

Referenced by TYPO3\CMS\Core\Log\LogRecord\__construct(), TYPO3\CMS\Core\Log\LogRecord\__toString(), TYPO3\CMS\Core\Log\LogRecord\getData(), TYPO3\CMS\Core\Log\LogRecord\setData(), and TYPO3\CMS\Core\Log\LogRecord\toArray().

◆ $gettableProperties

TYPO3\CMS\Core\Log\LogRecord::$gettableProperties
private
Initial value:
= [
'requestId',
'created',
'component',
'level',
'message',
'data'
]

Definition at line 71 of file LogRecord.php.

◆ $level

TYPO3\CMS\Core\Log\LogRecord::$level = LogLevel::INFO
protected

Definition at line 50 of file LogRecord.php.

Referenced by TYPO3\CMS\Core\Log\LogRecord\__construct(), TYPO3\CMS\Core\Log\LogRecord\getLevel(), TYPO3\CMS\Core\Log\LogRecord\setLevel(), and TYPO3\CMS\Core\Log\LogRecord\toArray().

◆ $message

TYPO3\CMS\Core\Log\LogRecord::$message = ''
protected

Definition at line 57 of file LogRecord.php.

Referenced by TYPO3\CMS\Core\Log\LogRecord\__construct(), TYPO3\CMS\Core\Log\LogRecord\getMessage(), TYPO3\CMS\Core\Log\LogRecord\setMessage(), and TYPO3\CMS\Core\Log\LogRecord\toArray().

◆ $requestId

TYPO3\CMS\Core\Log\LogRecord::$requestId = ''
protected

Definition at line 29 of file LogRecord.php.

Referenced by TYPO3\CMS\Core\Log\LogRecord\getRequestId(), TYPO3\CMS\Core\Log\LogRecord\setRequestId(), and TYPO3\CMS\Core\Log\LogRecord\toArray().

◆ $settableProperties

TYPO3\CMS\Core\Log\LogRecord::$settableProperties
private
Initial value:
= [
'level',
'message',
'data'
]

Definition at line 85 of file LogRecord.php.