‪TYPO3CMS  10.4
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore Class Reference

Public Member Functions

 __construct (string $userType=self::USER_BACKEND, int $userId=null, int $originalUserId=null, int $tstamp=null, int $workspaceId=0)
 
string addRecord (string $table, int $uid, array $payload, CorrelationId $correlationId=null)
 
string modifyRecord (string $table, int $uid, array $payload, CorrelationId $correlationId=null)
 
string deleteRecord (string $table, int $uid, CorrelationId $correlationId=null)
 
string undeleteRecord (string $table, int $uid, CorrelationId $correlationId=null)
 
string moveRecord (string $table, int $uid, array $payload, CorrelationId $correlationId=null)
 

Public Attributes

const ACTION_ADD = 1
 
const ACTION_MODIFY = 2
 
const ACTION_MOVE = 3
 
const ACTION_DELETE = 4
 
const ACTION_UNDELETE = 5
 
const USER_BACKEND = 'BE'
 
const USER_FRONTEND = 'FE'
 
const USER_ANONYMOUS = ''
 

Protected Member Functions

 createCorrelationId (string $tableName, int $uid, ?CorrelationId $correlationId)
 
Connection getDatabaseConnection ()
 

Protected Attributes

int null $userId
 
string $userType
 
int null $originalUserId
 
int null $tstamp
 
int $workspaceId
 

Detailed Description

Used to save any history to a record

should only be used by the TYPO3 Core

Definition at line 30 of file RecordHistoryStore.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore::__construct ( string  $userType = self::USER_BACKEND,
int  $userId = null,
int  $originalUserId = null,
int  $tstamp = null,
int  $workspaceId = 0 
)
Parameters
string$userType
int | null$userId
int$originalUserId
int$tstamp
int$workspaceId

Definition at line 69 of file RecordHistoryStore.php.

References $GLOBALS, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$originalUserId, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$tstamp, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$userId, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$userType, and TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$workspaceId.

Member Function Documentation

◆ addRecord()

string TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore::addRecord ( string  $table,
int  $uid,
array  $payload,
CorrelationId  $correlationId = null 
)
Parameters
string$table
int$uid
array$payload
CorrelationId | null$correlationId
Returns
‪string

Definition at line 85 of file RecordHistoryStore.php.

References TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$originalUserId, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$tstamp, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$userId, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$userType, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$workspaceId, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\ACTION_ADD, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\createCorrelationId(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\getDatabaseConnection(), TYPO3\CMS\Core\Database\Connection\insert(), and TYPO3\CMS\Core\Database\Connection\lastInsertId().

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\insertDB().

◆ createCorrelationId()

TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore::createCorrelationId ( string  $tableName,
int  $uid,
?CorrelationId  $correlationId 
)
protected

Definition at line 199 of file RecordHistoryStore.php.

References TYPO3\CMS\Core\DataHandling\Model\CorrelationId\forSubject(), TYPO3\CMS\Core\DataHandling\Model\CorrelationId\getSubject(), and TYPO3\CMS\Core\DataHandling\Model\CorrelationId\withSubject().

Referenced by TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\addRecord(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\deleteRecord(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\modifyRecord(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\moveRecord(), and TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\undeleteRecord().

◆ deleteRecord()

string TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore::deleteRecord ( string  $table,
int  $uid,
CorrelationId  $correlationId = null 
)
Parameters
string$table
int$uid
CorrelationId | null$correlationId
Returns
‪string

Definition at line 134 of file RecordHistoryStore.php.

References TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$originalUserId, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$tstamp, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$userId, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$userType, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$workspaceId, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\ACTION_DELETE, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\createCorrelationId(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\getDatabaseConnection(), TYPO3\CMS\Core\Database\Connection\insert(), and TYPO3\CMS\Core\Database\Connection\lastInsertId().

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\deleteRecord(), and TYPO3\CMS\Core\DataHandling\DataHandler\discard().

◆ getDatabaseConnection()

Connection TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore::getDatabaseConnection ( )
protected
Returns
‪Connection

Definition at line 211 of file RecordHistoryStore.php.

Referenced by TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\addRecord(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\deleteRecord(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\modifyRecord(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\moveRecord(), and TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\undeleteRecord().

◆ modifyRecord()

string TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore::modifyRecord ( string  $table,
int  $uid,
array  $payload,
CorrelationId  $correlationId = null 
)
Parameters
string$table
int$uid
array$payload
CorrelationId | null$correlationId
Returns
‪string

Definition at line 110 of file RecordHistoryStore.php.

References TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$originalUserId, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$tstamp, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$userId, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$userType, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$workspaceId, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\ACTION_MODIFY, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\createCorrelationId(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\getDatabaseConnection(), TYPO3\CMS\Core\Database\Connection\insert(), and TYPO3\CMS\Core\Database\Connection\lastInsertId().

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\setHistory(), and TYPO3\CMS\Core\DataHandling\DataHandler\updateDB().

◆ moveRecord()

string TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore::moveRecord ( string  $table,
int  $uid,
array  $payload,
CorrelationId  $correlationId = null 
)
Parameters
string$table
int$uid
array$payload
CorrelationId | null$correlationId
Returns
‪string

Definition at line 181 of file RecordHistoryStore.php.

References TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$originalUserId, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$tstamp, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$userId, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$userType, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$workspaceId, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\ACTION_MOVE, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\createCorrelationId(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\getDatabaseConnection(), TYPO3\CMS\Core\Database\Connection\insert(), and TYPO3\CMS\Core\Database\Connection\lastInsertId().

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\moveRecord_raw().

◆ undeleteRecord()

string TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore::undeleteRecord ( string  $table,
int  $uid,
CorrelationId  $correlationId = null 
)
Parameters
string$table
int$uid
CorrelationId | null$correlationId
Returns
‪string

Definition at line 157 of file RecordHistoryStore.php.

References TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$originalUserId, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$tstamp, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$userId, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$userType, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\$workspaceId, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\ACTION_UNDELETE, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\createCorrelationId(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\getDatabaseConnection(), TYPO3\CMS\Core\Database\Connection\insert(), and TYPO3\CMS\Core\Database\Connection\lastInsertId().

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\deleteRecord().

Member Data Documentation

◆ $originalUserId

int null TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore::$originalUserId
protected

Definition at line 52 of file RecordHistoryStore.php.

Referenced by TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\__construct(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\addRecord(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\deleteRecord(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\modifyRecord(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\moveRecord(), and TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\undeleteRecord().

◆ $tstamp

int null TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore::$tstamp
protected

Definition at line 56 of file RecordHistoryStore.php.

Referenced by TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\__construct(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\addRecord(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\deleteRecord(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\modifyRecord(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\moveRecord(), and TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\undeleteRecord().

◆ $userId

int null TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore::$userId
protected

Definition at line 44 of file RecordHistoryStore.php.

Referenced by TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\__construct(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\addRecord(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\deleteRecord(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\modifyRecord(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\moveRecord(), and TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\undeleteRecord().

◆ $userType

string TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore::$userType
protected

Definition at line 48 of file RecordHistoryStore.php.

Referenced by TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\__construct(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\addRecord(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\deleteRecord(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\modifyRecord(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\moveRecord(), and TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\undeleteRecord().

◆ $workspaceId

int TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore::$workspaceId
protected

Definition at line 60 of file RecordHistoryStore.php.

Referenced by TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\__construct(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\addRecord(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\deleteRecord(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\modifyRecord(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\moveRecord(), and TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\undeleteRecord().

◆ ACTION_ADD

const TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore::ACTION_ADD = 1

Definition at line 32 of file RecordHistoryStore.php.

Referenced by TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\addRecord(), and TYPO3\CMS\Backend\History\RecordHistory\prepareEventDataFromQueryBuilder().

◆ ACTION_DELETE

const TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore::ACTION_DELETE = 4

Definition at line 35 of file RecordHistoryStore.php.

Referenced by TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\deleteRecord(), TYPO3\CMS\Recycler\Controller\DeletedRecordsController\getUserWhoDeleted(), and TYPO3\CMS\Backend\History\RecordHistory\prepareEventDataFromQueryBuilder().

◆ ACTION_MODIFY

const TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore::ACTION_MODIFY = 2

Definition at line 33 of file RecordHistoryStore.php.

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\displayHistory(), TYPO3\CMS\Backend\History\RecordHistory\getDiff(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\modifyRecord(), and TYPO3\CMS\Install\Updates\SeparateSysHistoryFromSysLogUpdate\moveDataFromSysLogToSysHistory().

◆ ACTION_MOVE

const TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore::ACTION_MOVE = 3

Definition at line 34 of file RecordHistoryStore.php.

Referenced by TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\moveRecord().

◆ ACTION_UNDELETE

const TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore::ACTION_UNDELETE = 5

Definition at line 36 of file RecordHistoryStore.php.

Referenced by TYPO3\CMS\Backend\History\RecordHistory\prepareEventDataFromQueryBuilder(), and TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\undeleteRecord().

◆ USER_ANONYMOUS

const TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore::USER_ANONYMOUS = ''

Definition at line 40 of file RecordHistoryStore.php.

◆ USER_BACKEND

const TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore::USER_BACKEND = 'BE'

Definition at line 38 of file RecordHistoryStore.php.

Referenced by TYPO3\CMS\Redirects\Service\SlugService\getRecordHistoryStore(), TYPO3\CMS\Core\DataHandling\DataHandler\getRecordHistoryStore(), and TYPO3\CMS\Install\Updates\SeparateSysHistoryFromSysLogUpdate\keepHistoryForInsertAndDeleteActions().

◆ USER_FRONTEND

const TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore::USER_FRONTEND = 'FE'

Definition at line 39 of file RecordHistoryStore.php.