‪TYPO3CMS  ‪main
TYPO3\CMS\Core\Log\LogRecord Class Reference
Inheritance diagram for TYPO3\CMS\Core\Log\LogRecord:

Public Member Functions

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

Protected Attributes

string $requestId = ''
 
float $created = 0.0
 
string $component = ''
 
string $level = \Psr\Log\LogLevel::INFO
 
string $message = ''
 
array $data = []
 

Private Attributes

array $gettableProperties
 
array $settableProperties
 

Detailed Description

Log record

Todo:
‪: Consider declaring this DTO final

Definition at line 23 of file LogRecord.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters
string$component‪Affected component
string$level‪Severity level (see \TYPO3\CMS\Core\Log\Level)
string$messageLog message
array$data‪Additional data
string$requestId‪Unique ID of the request

Definition at line 85 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\Log\LogRecord\setComponent(), TYPO3\CMS\Core\Log\LogRecord\setCreated(), TYPO3\CMS\Core\Log\LogRecord\setData(), TYPO3\CMS\Core\Log\LogRecord\setLevel(), TYPO3\CMS\Core\Log\LogRecord\setMessage(), 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

Definition at line 246 of file LogRecord.php.

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

◆ addData()

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

◆ getComponent()

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

Returns the component

Returns
‪string Component key

Definition at line 112 of file LogRecord.php.

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

◆ getCreated()

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

Returns the creation time

Returns
‪float Creation time as float

Definition at line 134 of file LogRecord.php.

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

◆ getData()

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

Returns the log data

Returns
‪array

Definition at line 181 of file LogRecord.php.

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

◆ getLevel()

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

Returns the severity level

See also
‪\TYPO3\CMS\Core\Log\Level
Returns
‪string Severity level

Definition at line 159 of file LogRecord.php.

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

Referenced by TYPO3\CMS\Adminpanel\Modules\DebugModule\getShortInfo().

◆ getMessage()

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

Returns the log message

Returns
‪string Log message

Definition at line 215 of file LogRecord.php.

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

Referenced by TYPO3\CMS\Adminpanel\Log\InMemoryLogWriter\writeLog().

◆ getRequestId()

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

Returns the request ID

Returns
‪string

Definition at line 237 of file LogRecord.php.

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

◆ offsetExists()

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

Checks whether an offset exists, required by ArrayAccess interface

Parameters
mixed$offset

Definition at line 293 of file LogRecord.php.

◆ offsetGet()

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

Offset to retrieve, required by ArrayAccess interface

Parameters
mixed$offset

Definition at line 307 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

Definition at line 321 of file LogRecord.php.

◆ offsetUnset()

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

Offset to unset, required by ArrayAccess interface

Parameters
mixed$offset

Definition at line 333 of file LogRecord.php.

◆ setComponent()

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

Sets the affected component

Parameters
string$component‪Component key
Returns
LogRecord

Definition at line 101 of file LogRecord.php.

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

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

◆ setCreated()

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

Sets the the creation time

Parameters
float$created‪Creation time as float
Returns
LogRecord

Definition at line 123 of file LogRecord.php.

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

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

◆ setData()

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

Sets log data array

Parameters
array$data
Returns
LogRecord

Definition at line 170 of file LogRecord.php.

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

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

◆ setLevel()

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

Sets the severity level

Parameters
string$level‪Severity level
Returns
LogRecord
See also
‪\TYPO3\CMS\Core\Log\Level

Definition at line 146 of file LogRecord.php.

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

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

◆ setMessage()

LogRecord 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
LogRecord

Definition at line 204 of file LogRecord.php.

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

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

◆ setRequestId()

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

Sets the request ID

Parameters
string$requestId
Returns
LogRecord

Definition at line 226 of file LogRecord.php.

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

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

◆ toArray()

Member Data Documentation

◆ $component

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

◆ $created

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

Creation timestamp with microseconds

Definition at line 33 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

◆ $gettableProperties

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

Gettable properties for ArrayAccess

Definition at line 58 of file LogRecord.php.

◆ $level

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

◆ $message

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

◆ $requestId

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

◆ $settableProperties

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

Settable properties for ArrayAccess

Definition at line 70 of file LogRecord.php.