Public Member Functions
	__construct ()

ResponseInterface	mainAction (ServerRequestInterface $request)

Protected Member Functions
	setPagePath ($table, $uid)

	getButtons (ServerRequestInterface $request)

array	prepareDisplaySettings (ServerRequestInterface $request)

	displayMultipleDiff (array $diff)

	displayHistory (array $historyEntries)

array	renderDiff ($entry, $table, $rollbackUid=0)

string	buildUrl ($overrideParameters=[])

string	generateTitle ($table, $uid)

array null	getRecord ($table, $uid)

StandaloneView	initializeView ()

TYPO3 CMS Core Localization LanguageService	getLanguageService ()

TYPO3 CMS Core Authentication BackendUserAuthentication	getBackendUser ()

bool	getEditLockFromElement ($tableName, $elementUid)

Protected Attributes
StandaloneView	$view

RecordHistory	$historyObject

int	$showDiff = 1

array	$recordCache = array( )

ModuleTemplate	$moduleTemplate

bool	$editLock = false

Detailed Description

Controller for showing the history module of TYPO3s backend

See also: ‪\TYPO3\CMS\Backend\History\RecordHistory

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

Definition at line 36 of file ElementHistoryController.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor

Definition at line 71 of file ElementHistoryController.php.

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

Member Function Documentation

◆ buildUrl()

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

protected

Generates the URL for a link to the current page

Parameters

array $overrideParameters

Returns: ‪string

Definition at line 423 of file ElementHistoryController.php.

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

Parameters

array $historyEntries

Definition at line 319 of file ElementHistoryController.php.

References $GLOBALS, TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\ACTION_MODIFY, TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\buildUrl(), TYPO3\CMS\Backend\Utility\BackendUtility\calcAge(), TYPO3\CMS\Backend\Utility\BackendUtility\datetime(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\generateTitle(), TYPO3\CMS\Backend\Utility\BackendUtility\getItemLabel(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getUserNames(), 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 278 of file ElementHistoryController.php.

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

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

◆ generateTitle()

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

protected

Generates the title and puts the record title behind

Parameters

string	$table
string	$uid

Returns: ‪string

Definition at line 447 of file ElementHistoryController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\getRecord(), and TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitle().

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

◆ getBackendUser()

TYPO3 CMS Core Authentication BackendUserAuthentication TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::getBackendUser ( )

protected

Gets the current backend user.

Returns: ‪\TYPO3\CMS\Core\Authentication\BackendUserAuthentication

Definition at line 506 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\prepareDisplaySettings(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\setPagePath().

◆ getButtons()

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

protected

Create the panel of buttons for submitting the form or otherwise perform operations.

Parameters

ServerRequestInterface $request

Definition at line 182 of file ElementHistoryController.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_LEFT, TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\getLanguageService(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

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

◆ getEditLockFromElement()

bool 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

Returns: ‪bool

Definition at line 519 of file ElementHistoryController.php.

References TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\getBackendUser(), and TYPO3\CMS\Backend\Utility\BackendUtility\getRecord().

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

◆ getLanguageService()

TYPO3 CMS Core Localization LanguageService TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::getLanguageService ( )

protected

Returns LanguageService

Returns: ‪\TYPO3\CMS\Core\Localization\LanguageService

Definition at line 496 of file ElementHistoryController.php.

References $GLOBALS.

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

◆ 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 464 of file ElementHistoryController.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\getRecord().

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

◆ initializeView()

StandaloneView TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::initializeView ( )

protected

Returns a new standalone view, shorthand function

Returns: ‪StandaloneView

Definition at line 477 of file ElementHistoryController.php.

References TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\$view, TYPO3\CMS\Fluid\View\StandaloneView\getRequest(), TYPO3\CMS\Fluid\View\AbstractTemplateView\setLayoutRootPaths(), TYPO3\CMS\Fluid\View\AbstractTemplateView\setPartialRootPaths(), TYPO3\CMS\Fluid\View\AbstractTemplateView\setTemplatePathAndFilename(), and TYPO3\CMS\Fluid\View\AbstractTemplateView\setTemplateRootPaths().

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

◆ mainAction()

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

Injects the request object for the current request or subrequest 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 84 of file ElementHistoryController.php.

◆ prepareDisplaySettings()

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

protected

Displays settings evaluation

Parameters

ServerRequestInterface $request

Returns: ‪array

Definition at line 211 of file ElementHistoryController.php.

References TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\getBackendUser(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\writeUC().

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

◆ renderDiff()

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

protected

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

Parameters

array	$entry	‪sys_history entry record.
string	$table	‪The table name
int	$rollbackUid	‪If set to UID of record, display rollback links

Returns: ‪array array of records

Definition at line 386 of file ElementHistoryController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\buildUrl(), TYPO3\CMS\Backend\Utility\BackendUtility\getItemLabel(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\getLanguageService(), and TYPO3\CMS\Backend\Utility\BackendUtility\getProcessedValue().

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 160 of file ElementHistoryController.php.

References TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\getBackendUser(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_SHOW, and TYPO3\CMS\Backend\Utility\BackendUtility\readPageAccess().

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

Member Data Documentation

◆ $editLock

bool TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::$editLock = false

protected

Restrict editing by non-Admins (0-no, 1-yes)

Definition at line 66 of file ElementHistoryController.php.

◆ $historyObject

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

protected

Definition at line 44 of file ElementHistoryController.php.

◆ $moduleTemplate

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

protected

ModuleTemplate object

Definition at line 60 of file ElementHistoryController.php.

◆ $recordCache

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

protected

Definition at line 54 of file ElementHistoryController.php.

◆ $showDiff

int TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController::$showDiff = 1

protected

Display diff or not (0-no diff, 1-inline)

Definition at line 50 of file ElementHistoryController.php.

◆ $view

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

protected

Definition at line 40 of file ElementHistoryController.php.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildUrl()

◆ displayHistory()

◆ displayMultipleDiff()

◆ generateTitle()

◆ getBackendUser()

◆ getButtons()

◆ getEditLockFromElement()

◆ getLanguageService()

◆ getRecord()

◆ initializeView()

◆ mainAction()

◆ prepareDisplaySettings()

◆ renderDiff()

◆ setPagePath()

Member Data Documentation

◆ $editLock

◆ $historyObject

◆ $moduleTemplate

◆ $recordCache

◆ $showDiff

◆ $view