TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController Class Reference

Public Member Functions
	__construct (protected readonly IconFactory $iconFactory, protected readonly UriBuilder $uriBuilder, protected readonly ModuleTemplateFactory $moduleTemplateFactory,)
ResponseInterface	mainAction (ServerRequestInterface $request)

Protected Member Functions
	setPagePath ($table, $uid)
	getButtons ()
	processSettings (ServerRequestInterface $request)
	displayMultipleDiff (array $diff)
	displayHistory (array $historyEntries)
array	renderDiff ($entry, $table, $rollbackUid=0, bool $showRollbackLink=false)
	buildUrl ($overrideParameters=[])
	generateTitle ($table, $uid)
array null	getRecord ($table, $uid)
	getLanguageService ()
	getBackendUser ()
	getEditLockFromElement ($tableName, $elementUid)

Protected Attributes
RecordHistory	$historyObject
bool	$showDiff = true
array	$recordCache = array( )
ModuleTemplate	$view
string	$returnUrl = ''

Detailed Description

Controller for showing the history module of TYPO3s backend.

This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.

Definition at line 47 of file ElementHistoryController.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::__construct	(	protected readonly IconFactory	$iconFactory,
		protected readonly UriBuilder	$uriBuilder,
		protected readonly ModuleTemplateFactory	$moduleTemplateFactory
	)

Definition at line 67 of file ElementHistoryController.php.

Member Function Documentation

buildUrl()

TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::buildUrl (   $overrideParameters = [] )

protected

Generates the URL for a link to the current page

Parameters

array

$overrideParameters

Definition at line 411 of file ElementHistoryController.php.

References TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\$returnUrl.

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\displayHistory(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\displayMultipleDiff(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\mainAction(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\renderDiff().

displayHistory()

TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::displayHistory ( array  $historyEntries )

protected

Shows the full change log

Definition at line 292 of file ElementHistoryController.php.

References TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\ACTION_MODIFY, TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\buildUrl(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\generateTitle(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\getLanguageService(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\renderDiff().

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\mainAction().

displayMultipleDiff()

TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::displayMultipleDiff ( array  $diff )

protected

Displays a diff over multiple fields including rollback links

Parameters

array

$diff

‪Difference array

Definition at line 227 of file ElementHistoryController.php.

References TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\buildUrl(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\generateTitle(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\getLanguageService(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\renderDiff().

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\mainAction().

generateTitle()

TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::generateTitle (   $table,   $uid  )

protected

Generates the title and puts the record title behind

Parameters

string	$table
string	$uid

Definition at line 439 of file ElementHistoryController.php.

References $GLOBALS, TYPO3\CMS\Webhooks\Message\$record, TYPO3\CMS\Webhooks\Message\$uid, and TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\getRecord().

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\displayHistory(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\displayMultipleDiff(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\setPagePath().

getBackendUser()

TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::getBackendUser ( )

protected

Definition at line 469 of file ElementHistoryController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\getEditLockFromElement(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\mainAction(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\processSettings(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\setPagePath().

getButtons()

TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::getButtons ( )

protected

Definition at line 193 of file ElementHistoryController.php.

References TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\getLanguageService().

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\mainAction().

getEditLockFromElement()

TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::getEditLockFromElement (   $tableName,   $elementUid  )

protected

Get the editlock value from page of a history element

Parameters

string	$tableName
int	$elementUid

Definition at line 480 of file ElementHistoryController.php.

References $GLOBALS, TYPO3\CMS\Webhooks\Message\$record, and TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\getBackendUser().

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\mainAction().

getLanguageService()

TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::getLanguageService ( )

protected

Definition at line 464 of file ElementHistoryController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\displayHistory(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\displayMultipleDiff(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\getButtons(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\mainAction(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\renderDiff(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\setPagePath().

getRecord()

array null TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::getRecord (   $table,   $uid  )

protected

Gets a database record (cached).

Parameters

string	$table
int	$uid

Returns

‪array|null

Definition at line 456 of file ElementHistoryController.php.

References TYPO3\CMS\Webhooks\Message\$uid.

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\generateTitle().

mainAction()

ResponseInterface TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::mainAction

(

ServerRequestInterface

$request

)

Injects the request object for the current request or sub request As this controller goes only through the main() method, it is rather simple for now

Parameters

ServerRequestInterface

$request

‪the current request

Returns

‪ResponseInterface the response with the content

Definition at line 80 of file ElementHistoryController.php.

References TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\buildUrl(), TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_LEFT, TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\displayHistory(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\displayMultipleDiff(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\getBackendUser(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\getButtons(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\getEditLockFromElement(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\getLanguageService(), TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_SHOW, TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\processSettings(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\setPagePath().

processSettings()

TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::processSettings ( ServerRequestInterface  $request )

protected

Definition at line 207 of file ElementHistoryController.php.

References TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\getBackendUser().

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\mainAction().

renderDiff()

array TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::renderDiff (   $entry,   $table,   $rollbackUid = 0, bool  $showRollbackLink = false  )

protected

Renders HTML table-rows with the comparison information of a sys_history entry record

Parameters

array	$entry	‪sys_history entry record.
string	$table	‪The table name
int	$rollbackUid	‪The UID of the record
bool	$showRollbackLink	‪Whether a rollback link should be shown for each changed field

Returns

‪array array of records

Definition at line 369 of file ElementHistoryController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\buildUrl(), TYPO3\CMS\Core\Utility\CHARACTER, and TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\getLanguageService().

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\displayHistory(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\displayMultipleDiff().

setPagePath()

TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::setPagePath (   $table,   $uid  )

protected

Creates the correct path to the current record

Parameters

string	$table
int	$uid

Definition at line 169 of file ElementHistoryController.php.

References $GLOBALS, TYPO3\CMS\Webhooks\Message\$record, TYPO3\CMS\Webhooks\Message\$uid, TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\generateTitle(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\getBackendUser(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\getLanguageService(), and TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_SHOW.

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\mainAction().

Member Data Documentation

$historyObject

RecordHistory TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::$historyObject

protected

Definition at line 51 of file ElementHistoryController.php.

$recordCache

array TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::$recordCache = array( )

protected

Definition at line 61 of file ElementHistoryController.php.

$returnUrl

string TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::$returnUrl = ''

protected

Definition at line 65 of file ElementHistoryController.php.

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\buildUrl().

$showDiff

bool TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::$showDiff = true

protected

Display inline differences or not

Definition at line 57 of file ElementHistoryController.php.

$view

ModuleTemplate TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::$view

protected

Definition at line 63 of file ElementHistoryController.php.