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

Public Member Functions

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

Protected Attributes

string $requestId = ''
 
float $created = 0.0
 
string $component = ''
 
int $level = LogLevel::INFO
 
string $message = ''
 
array $data = array( )
 

Private Attributes

array $gettableProperties
 
array $settableProperties
 

Detailed Description

Log record

Definition at line 20 of file LogRecord.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters
string$component‪Affected component
int$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 90 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()

string 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 254 of file LogRecord.php.

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

◆ addData()

TYPO3 CMS Core Log LogRecord 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
‪\TYPO3\CMS\Core\Log\LogRecord

Definition at line 198 of file LogRecord.php.

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

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

◆ getComponent()

◆ getCreated()

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

Returns the creation time

Returns
‪float Creation time as float

Definition at line 139 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()

◆ getLevel()

◆ getMessage()

◆ getRequestId()

◆ offsetExists()

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

Checks whether an offset exists, required by ArrayAccess interface

Parameters
mixed$offset
Returns
‪bool

Definition at line 302 of file LogRecord.php.

◆ offsetGet()

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

Offset to retrieve, required by ArrayAccess interface

Parameters
mixed$offset
Returns
‪mixed

Definition at line 317 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 331 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 343 of file LogRecord.php.

◆ setComponent()

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

Sets the affected component

Parameters
string$component‪Component key
Returns
‪\TYPO3\CMS\Core\Log\LogRecord

Definition at line 106 of file LogRecord.php.

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

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

◆ setCreated()

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

Sets the the creation time

Parameters
float$created‪Creation time as float
Returns
‪\TYPO3\CMS\Core\Log\LogRecord

Definition at line 128 of file LogRecord.php.

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

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

◆ setData()

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

Sets log data array

Parameters
array$data
Returns
‪\TYPO3\CMS\Core\Log\LogRecord

Definition at line 175 of file LogRecord.php.

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

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

◆ setLevel()

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

Sets the severity level

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

Definition at line 151 of file LogRecord.php.

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

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

◆ setMessage()

TYPO3 CMS Core Log 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
‪\TYPO3\CMS\Core\Log\LogRecord

Definition at line 210 of file LogRecord.php.

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

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

◆ setRequestId()

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

Sets the request ID

Parameters
string$requestId
Returns
‪\TYPO3\CMS\Core\Log\LogRecord

Definition at line 232 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 32 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:
= array(
'requestId',
'created',
'component',
'level',
'message',
'data'
)

Gettable properties for ArrayAccess

Definition at line 62 of file LogRecord.php.

◆ $level

int TYPO3\CMS\Core\Log\LogRecord::$level = 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:
= array(
'level',
'message',
'data'
)

Settable properties for ArrayAccess

Definition at line 75 of file LogRecord.php.