Inheritance diagram for TYPO3\CMS\Backend\Controller\EditDocumentController:

Public Member Functions
	__construct ()

ResponseInterface	mainAction (ServerRequestInterface $request)

ResponseInterface null	preInit (ServerRequestInterface $request=null)

bool	doProcessData ()

ResponseInterface null	processData (ServerRequestInterface $request=null)

	init (ServerRequestInterface $request=null)

	main (ServerRequestInterface $request=null)

	shortCutLink ()

	openInNewWindowLink ()

ResponseInterface null	localizationRedirect (ServerRequestInterface $request=null)

	compileStoreDat ()

string	getNewIconMode ($table, $key='saveDocNew')

ResponseInterface null	closeDocument ($mode=self::DOCUMENT_CLOSE_MODE_DEFAULT, ServerRequestInterface $request=null)

	setDocument ($currentDocFromHandlerMD5='', $retUrl='')

‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Compatibility\PublicMethodDeprecationTrait
mixed	__call (string $methodName, array $arguments)

‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Compatibility\PublicPropertyDeprecationTrait
bool	__isset (string $propertyName)

mixed	__get (string $propertyName)

	__set (string $propertyName, $propertyValue)

	__unset (string $propertyName)

Public Attributes
const	DOCUMENT_CLOSE_MODE_DEFAULT = 0

const	DOCUMENT_CLOSE_MODE_REDIRECT = 1

const	DOCUMENT_CLOSE_MODE_CLEAR_ALL = 3

const	DOCUMENT_CLOSE_MODE_NO_REDIRECT = 4

	$data

	$elementsData

Protected Member Functions
	addSlugFieldsToColumnsOnly (array $queryParams)

string	generatePreviewCode ()

string	getPreviewUrlParameters (int $previewPageId)

int	resolvePreviewRecordId (string $table, array $recordArray, array $previewConfiguration)

string	getPreviewUrlAnchorSection ()

int	getPreviewPageId ()

	parseAdditionalGetParameters (array &$parameters, array $typoScript)

string	makeEditForm ()

	getButtons (ServerRequestInterface $request)

	setIsSavedRecord ()

bool	isInconsistentLanguageHandlingAllowed ()

	setIsPageInFreeTranslationMode ($record, int $sysLanguageUid)

bool	getFreeTranslationMode (int $page, int $column, int $language)

	registerCloseButtonToButtonBar (ButtonBar $buttonBar, string $position, int $group)

	registerSaveButtonToButtonBar (ButtonBar $buttonBar, string $position, int $group)

	registerViewButtonToButtonBar (ButtonBar $buttonBar, string $position, int $group)

	registerNewButtonToButtonBar (ButtonBar $buttonBar, string $position, int $group, int $sysLanguageUid, int $l18nParent)

	registerDuplicationButtonToButtonBar (ButtonBar $buttonBar, string $position, int $group, int $sysLanguageUid, int $l18nParent)

	registerDeleteButtonToButtonBar (ButtonBar $buttonBar, string $position, int $group)

	registerHistoryButtonToButtonBar (ButtonBar $buttonBar, string $position, int $group)

	registerColumnsOnlyButtonToButtonBar (ButtonBar $buttonBar, string $position, int $group)

	registerOpenInNewWindowButtonToButtonBar (ButtonBar $buttonBar, string $position, int $group)

	registerShortcutButtonToButtonBar (ButtonBar $buttonBar, string $position, int $group)

	registerCshButtonToButtonBar (ButtonBar $buttonBar, string $position, int $group)

int	getConnectedContentElementTranslationsCount (int $page, int $column, int $language)

int	getStandAloneContentElementTranslationsCount (int $page, int $column, int $language)

QueryBuilder	getQueryBuilderForTranslationMode (int $page, int $column, int $language)

string	compileForm (string $editForm)

bool	getDisableDelete ()

string	getCloseUrl ()

	languageSwitch (string $table, int $uid, $pid=null)

SiteLanguage[]	getLanguages (int $id, string $table)

	fixWSversioningInEditConf ($mapArray=false)

array false	getRecordForEdit (string $table, int $theUid)

	compileStoreData ()

string	getTsConfigOption (string $table, string $key)

	emitFunctionAfterSignal ($signalName, ServerRequestInterface $request)

TYPO3 CMS Extbase SignalSlot Dispatcher	getSignalSlotDispatcher ()

TYPO3 CMS Core Authentication BackendUserAuthentication	getBackendUser ()

TYPO3 CMS Core Localization LanguageService	getLanguageService ()

Protected Attributes
array	$editconf = array( )

string null	$columnsOnly

array null	$defVals

array null	$overrideVals

string null	$returnUrl

string	$retUrl

int	$closeDoc

bool	$doSave

array	$cmd

array	$mirror

string	$cacheCmd

string	$redirect

bool	$returnNewPageId = false

array null	$uc

int	$popViewId

string	$popViewId_addParams

string	$viewUrl

string	$recTitle

bool	$noView

string	$perms_clause

bool	$returnEditConf

string null	$workspace

TYPO3 CMS Backend Template DocumentTemplate	$doc

	$template

	$content

array	$R_URL_parts

array	$R_URL_getvars

string	$R_URI

array	$MCONF

array	$pageinfo

string	$storeTitle = ''

array	$storeArray

string	$storeUrl

string	$storeUrlMd5

array	$docDat

array	$docHandler

array	$firstEl

int	$errorC

int	$newC

int	$viewId

string	$viewId_addParams

	$modTSconfig = array( )

FormResultCompiler	$formResultCompiler

bool	$dontStoreDocumentRef = 0

TYPO3 CMS Extbase SignalSlot Dispatcher	$signalSlotDispatcher

array	$previewData = array( )

ModuleTemplate	$moduleTemplate

bool	$isSavedRecord

bool	$isPageInFreeTranslationMode = false

UriBuilder	$uriBuilder

Private Attributes
array	$deprecatedPublicMethods

array	$deprecatedPublicProperties

Detailed Description

Main backend controller almost always used if some database record is edited in the backend.

Main job of this controller is to evaluate and sanitize $request parameters, call the DataHandler if records should be created or updated and execute FormEngine for record rendering.

Definition at line 63 of file EditDocumentController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\Controller\EditDocumentController::__construct ( )

Constructor

Definition at line 453 of file EditDocumentController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\EditDocumentController\getLanguageService(), and TYPO3\CMS\Core\Localization\LanguageService\includeLLFile().

Member Function Documentation

◆ addSlugFieldsToColumnsOnly()

TYPO3\CMS\Backend\Controller\EditDocumentController::addSlugFieldsToColumnsOnly ( array $queryParams )

protected

Always add required fields of slug field

Parameters

array $queryParams

Definition at line 597 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Controller\EditDocumentController\$data, $fields, and $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\preInit().

◆ closeDocument()

ResponseInterface null TYPO3\CMS\Backend\Controller\EditDocumentController::closeDocument	(		$mode = `self::DOCUMENT_CLOSE_MODE_DEFAULT`,
		ServerRequestInterface	$request = `null`
	)

Handling the closing of a document The argument $mode can be one of this values:

‪0/1 will redirect to $this->retUrl [self::DOCUMENT_CLOSE_MODE_DEFAULT || self::DOCUMENT_CLOSE_MODE_REDIRECT]
‪3 will clear the docHandler (thus closing all documents) [self::DOCUMENT_CLOSE_MODE_CLEAR_ALL]
‪4 will do no redirect [self::DOCUMENT_CLOSE_MODE_NO_REDIRECT]
‪other values will call setDocument with ->retUrl

Parameters

int	$mode	‪the close mode: one of self::DOCUMENT_CLOSE_MODE_*
ServerRequestInterface	$request	‪Incoming request

Returns: ‪ResponseInterface|null Redirect response if needed

Definition at line 2634 of file EditDocumentController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\EditDocumentController\$retUrl, TYPO3\CMS\Backend\Controller\EditDocumentController\$returnUrl, TYPO3\CMS\Backend\Controller\EditDocumentController\$storeUrlMd5, TYPO3\CMS\Backend\Controller\EditDocumentController\getBackendUser(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getModuleData(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\pushModuleData(), TYPO3\CMS\Core\Utility\HttpUtility\redirect(), and TYPO3\CMS\Backend\Utility\BackendUtility\setUpdateSignal().

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\preInit(), and TYPO3\CMS\Backend\Controller\EditDocumentController\processData().

◆ compileForm()

string TYPO3\CMS\Backend\Controller\EditDocumentController::compileForm ( string $editForm )

protected

Put together the various elements (buttons, selectors, form) into a table

Parameters

string $editForm ‪HTML form.

Returns: ‪string Composite HTML

Definition at line 2061 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\main().

◆ compileStoreDat()

TYPO3\CMS\Backend\Controller\EditDocumentController::compileStoreDat ( )

Populates the variables $this->storeArray, $this->storeUrl, $this->storeUrlMd5

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 2570 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Controller\EditDocumentController\compileStoreData().

◆ compileStoreData()

TYPO3\CMS\Backend\Controller\EditDocumentController::compileStoreData ( )

protected

Populates the variables $this->storeArray, $this->storeUrl, $this->storeUrlMd5 to prepare 'open documents' urls

Definition at line 2580 of file EditDocumentController.php.

References TYPO3\CMS\Core\Utility\HttpUtility\buildQueryString().

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\compileStoreDat(), TYPO3\CMS\Backend\Controller\EditDocumentController\preInit(), and TYPO3\CMS\Backend\Controller\EditDocumentController\processData().

◆ doProcessData()

bool TYPO3\CMS\Backend\Controller\EditDocumentController::doProcessData ( )

Detects, if a save command has been triggered.

Returns: ‪bool TRUE, then save the document (data submitted)

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 579 of file EditDocumentController.php.

◆ emitFunctionAfterSignal()

TYPO3\CMS\Backend\Controller\EditDocumentController::emitFunctionAfterSignal	(		$signalName,
		ServerRequestInterface	$request
	)

protected

Emits a signal after a function was executed

Parameters

string	$signalName
ServerRequestInterface	$request

Definition at line 2736 of file EditDocumentController.php.

References TYPO3\CMS\Extbase\SignalSlot\Dispatcher\dispatch(), and TYPO3\CMS\Backend\Controller\EditDocumentController\getSignalSlotDispatcher().

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\init(), and TYPO3\CMS\Backend\Controller\EditDocumentController\preInit().

◆ fixWSversioningInEditConf()

TYPO3\CMS\Backend\Controller\EditDocumentController::fixWSversioningInEditConf ( $mapArray = false )

protected

Fix $this->editconf if versioning applies to any of the records

Parameters

array | bool $mapArray ‪Mapping between old and new ids if auto-versioning has been performed.

Definition at line 2481 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Controller\EditDocumentController\$cmd, $GLOBALS, and TYPO3\CMS\Backend\Controller\EditDocumentController\getRecordForEdit().

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\preInit(), and TYPO3\CMS\Backend\Controller\EditDocumentController\processData().

◆ generatePreviewCode()

string TYPO3\CMS\Backend\Controller\EditDocumentController::generatePreviewCode ( )

protected

Generate the Javascript for opening the preview window

Returns: ‪string

Definition at line 942 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\BEgetRootLine(), TYPO3\CMS\Backend\Controller\EditDocumentController\getPreviewPageId(), TYPO3\CMS\Backend\Controller\EditDocumentController\getPreviewUrlAnchorSection(), TYPO3\CMS\Backend\Controller\EditDocumentController\getPreviewUrlParameters(), and TYPO3\CMS\Backend\Utility\BackendUtility\viewOnClick().

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\init().

◆ getBackendUser()

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

protected

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

Definition at line 2757 of file EditDocumentController.php.

References $GLOBALS.

◆ getButtons()

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

protected

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

Parameters

ServerRequestInterface $request

Definition at line 1389 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\main().

◆ getCloseUrl()

string TYPO3\CMS\Backend\Controller\EditDocumentController::getCloseUrl ( )

protected

Returns the URL (usually for the "returnUrl") which closes the current window. Used when editing a record in a popup.

Returns: ‪string

Definition at line 2170 of file EditDocumentController.php.

References TYPO3\CMS\Core\Utility\PathUtility\getAbsoluteWebPath().

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\openInNewWindowLink(), TYPO3\CMS\Backend\Controller\EditDocumentController\registerOpenInNewWindowButtonToButtonBar(), TYPO3\CMS\Backend\Controller\EditDocumentController\registerShortcutButtonToButtonBar(), and TYPO3\CMS\Backend\Controller\EditDocumentController\shortCutLink().

◆ getConnectedContentElementTranslationsCount()

int TYPO3\CMS\Backend\Controller\EditDocumentController::getConnectedContentElementTranslationsCount	(	int	$page,
		int	$column,
		int	$language
	)

protected

Get the count of connected translated content elements

Parameters

int	$page
int	$column
int	$language

Returns: ‪int

Definition at line 1978 of file EditDocumentController.php.

References $GLOBALS, and TYPO3\CMS\Backend\Controller\EditDocumentController\getQueryBuilderForTranslationMode().

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\getFreeTranslationMode().

◆ getDisableDelete()

bool TYPO3\CMS\Backend\Controller\EditDocumentController::getDisableDelete ( )

protected

Returns if delete for the current table is disabled by configuration. For sys_file_metadata in default language delete is always disabled.

Returns: ‪bool

Definition at line 2149 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), and TYPO3\CMS\Backend\Controller\EditDocumentController\getTsConfigOption().

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\registerDeleteButtonToButtonBar().

◆ getFreeTranslationMode()

bool TYPO3\CMS\Backend\Controller\EditDocumentController::getFreeTranslationMode	(	int	$page,
		int	$column,
		int	$language
	)

protected

Check if the page is in free translation mode

Parameters

int	$page
int	$column
int	$language

Returns: ‪bool

Definition at line 1509 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Controller\EditDocumentController\getConnectedContentElementTranslationsCount(), and TYPO3\CMS\Backend\Controller\EditDocumentController\getStandAloneContentElementTranslationsCount().

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\setIsPageInFreeTranslationMode().

◆ getLanguages()

SiteLanguage [] TYPO3\CMS\Backend\Controller\EditDocumentController::getLanguages	(	int	$id,
		string	$table
	)

protected

Returns languages available for record translations on given page.

Parameters

int	$id	‪Page id: If zero, the query will select all sys_language records from root level which are NOT hidden. If set to another value, the query will select all sys_language records that has a translation record on that page (and is not hidden, unless you are admin user)
string	$table	‪For pages we want all languages, for other records the languages of the page translations

Returns: ‪SiteLanguage[] Language

Definition at line 2420 of file EditDocumentController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\EditDocumentController\getBackendUser(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), and TYPO3\CMS\Backend\Utility\BackendUtility\getRecordWSOL().

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\languageSwitch().

◆ getLanguageService()

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

protected

Returns LanguageService

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

Definition at line 2767 of file EditDocumentController.php.

References $GLOBALS.

◆ getNewIconMode()

string TYPO3\CMS\Backend\Controller\EditDocumentController::getNewIconMode	(	$table,
		$key = `'saveDocNew'`
	)

Function used to look for configuration of buttons in the form: Fx. disabling buttons or showing them at various positions.

Parameters

string	$table	‪The table for which the configuration may be specific
string	$key	‪The option for look for. Default is checking if the saveDocNew button should be displayed.

Returns: ‪string Return value fetched from USER TSconfig

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 2600 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Controller\EditDocumentController\getTsConfigOption().

◆ getPreviewPageId()

int TYPO3\CMS\Backend\Controller\EditDocumentController::getPreviewPageId ( )

protected

Returns the preview page id

Returns: ‪int

Definition at line 1080 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Controller\EditDocumentController\$viewId, TYPO3\CMS\Backend\Utility\BackendUtility\BEgetRootLine(), TYPO3\CMS\Core\Utility\MathUtility\convertToPositiveInteger(), TYPO3\CMS\Frontend\Page\PageRepository\DOKTYPE_SPACER, and TYPO3\CMS\Backend\Utility\BackendUtility\getPagesTSconfig().

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\generatePreviewCode(), and TYPO3\CMS\Backend\Controller\EditDocumentController\registerViewButtonToButtonBar().

◆ getPreviewUrlAnchorSection()

string TYPO3\CMS\Backend\Controller\EditDocumentController::getPreviewUrlAnchorSection ( )

protected

Returns the anchor section for the preview url

Returns: ‪string

Definition at line 1067 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\generatePreviewCode(), and TYPO3\CMS\Backend\Controller\EditDocumentController\registerViewButtonToButtonBar().

◆ getPreviewUrlParameters()

string TYPO3\CMS\Backend\Controller\EditDocumentController::getPreviewUrlParameters ( int $previewPageId )

protected

Returns the parameters for the preview URL

Parameters

int $previewPageId

Returns: ‪string

Definition at line 982 of file EditDocumentController.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\HttpUtility\buildQueryString(), TYPO3\CMS\Backend\Utility\BackendUtility\getPagesTSconfig(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), TYPO3\CMS\Backend\Utility\BackendUtility\isTableWorkspaceEnabled(), TYPO3\CMS\Backend\Controller\EditDocumentController\parseAdditionalGetParameters(), and TYPO3\CMS\Backend\Controller\EditDocumentController\resolvePreviewRecordId().

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\generatePreviewCode(), and TYPO3\CMS\Backend\Controller\EditDocumentController\registerViewButtonToButtonBar().

◆ getQueryBuilderForTranslationMode()

QueryBuilder TYPO3\CMS\Backend\Controller\EditDocumentController::getQueryBuilderForTranslationMode	(	int	$page,
		int	$column,
		int	$language
	)

protected

Get the query builder for the translation mode

Parameters

int	$page
int	$column
int	$language

Returns: ‪QueryBuilder

Definition at line 2024 of file EditDocumentController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\getConnectedContentElementTranslationsCount(), and TYPO3\CMS\Backend\Controller\EditDocumentController\getStandAloneContentElementTranslationsCount().

◆ getRecordForEdit()

array false TYPO3\CMS\Backend\Controller\EditDocumentController::getRecordForEdit	(	string	$table,
		int	$theUid
	)

protected

Get record for editing.

Parameters

string	$table	‪Table name
int	$theUid	‪Record UID

Returns: ‪array|false Returns record to edit, false if none

Definition at line 2528 of file EditDocumentController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\EditDocumentController\getBackendUser(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), and TYPO3\CMS\Backend\Utility\BackendUtility\getWorkspaceVersionOfRecord().

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\fixWSversioningInEditConf().

◆ getSignalSlotDispatcher()

TYPO3 CMS Extbase SignalSlot Dispatcher TYPO3\CMS\Backend\Controller\EditDocumentController::getSignalSlotDispatcher ( )

protected

Get the SignalSlot dispatcher

Returns: ‪\TYPO3\CMS\Extbase\SignalSlot\Dispatcher

Definition at line 2746 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Controller\EditDocumentController\$signalSlotDispatcher.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\emitFunctionAfterSignal().

◆ getStandAloneContentElementTranslationsCount()

int TYPO3\CMS\Backend\Controller\EditDocumentController::getStandAloneContentElementTranslationsCount	(	int	$page,
		int	$column,
		int	$language
	)

protected

Get the count of standalone translated content elements

Parameters

int	$page
int	$column
int	$language

Returns: ‪int

Definition at line 2001 of file EditDocumentController.php.

References $GLOBALS, and TYPO3\CMS\Backend\Controller\EditDocumentController\getQueryBuilderForTranslationMode().

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\getFreeTranslationMode().

◆ getTsConfigOption()

string TYPO3\CMS\Backend\Controller\EditDocumentController::getTsConfigOption	(	string	$table,
		string	$key
	)

protected

Get a TSConfig 'option.' array, possibly for a specific table.

Parameters

string	$table	‪Table name
string	$key	‪Options key

Returns: ‪string

Definition at line 2613 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Controller\EditDocumentController\getBackendUser().

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\getDisableDelete(), TYPO3\CMS\Backend\Controller\EditDocumentController\getNewIconMode(), TYPO3\CMS\Backend\Controller\EditDocumentController\processData(), TYPO3\CMS\Backend\Controller\EditDocumentController\registerDuplicationButtonToButtonBar(), TYPO3\CMS\Backend\Controller\EditDocumentController\registerHistoryButtonToButtonBar(), TYPO3\CMS\Backend\Controller\EditDocumentController\registerNewButtonToButtonBar(), and TYPO3\CMS\Backend\Controller\EditDocumentController\registerViewButtonToButtonBar().

◆ init()

TYPO3\CMS\Backend\Controller\EditDocumentController::init ( ServerRequestInterface $request = null )

Initialize the view part of the controller logic.

Parameters

ServerRequestInterface $request

Definition at line 874 of file EditDocumentController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\EditDocumentController\$retUrl, TYPO3\CMS\Core\Utility\HttpUtility\buildQueryString(), TYPO3\CMS\Backend\Controller\EditDocumentController\emitFunctionAfterSignal(), TYPO3\CMS\Backend\Controller\EditDocumentController\generatePreviewCode(), TYPO3\CMS\Backend\Controller\EditDocumentController\getBackendUser(), and TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_SHOW.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\mainAction().

◆ isInconsistentLanguageHandlingAllowed()

bool TYPO3\CMS\Backend\Controller\EditDocumentController::isInconsistentLanguageHandlingAllowed ( )

protected

Returns if inconsistent language handling is allowed

Returns: ‪bool

Definition at line 1467 of file EditDocumentController.php.

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

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\registerDuplicationButtonToButtonBar(), and TYPO3\CMS\Backend\Controller\EditDocumentController\registerNewButtonToButtonBar().

◆ languageSwitch()

TYPO3\CMS\Backend\Controller\EditDocumentController::languageSwitch	(	string	$table,
		int	$uid,
			$pid = `null`
	)

protected

Make selector box for creating new translation for a record or switching to edit the record in an existing language. Displays only languages which are available for the current page.

Parameters

string	$table	‪Table name
int	$uid	‪Uid for which to create a new language
int	$pid,\|null	‪Pid of the record

Definition at line 2190 of file EditDocumentController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\EditDocumentController\$retUrl, TYPO3\CMS\Backend\Controller\EditDocumentController\getBackendUser(), TYPO3\CMS\Backend\Controller\EditDocumentController\getLanguages(), TYPO3\CMS\Backend\Controller\EditDocumentController\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getLinkToDataHandlerAction(), TYPO3\CMS\Backend\Utility\BackendUtility\getLiveVersionOfRecord(), and TYPO3\CMS\Backend\Utility\BackendUtility\getRecord().

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\main().

◆ localizationRedirect()

ResponseInterface null TYPO3\CMS\Backend\Controller\EditDocumentController::localizationRedirect ( ServerRequestInterface $request = null )

Redirects to FormEngine with new parameters to edit a just created localized record

Parameters

ServerRequestInterface $request ‪Incoming request object

Returns: ‪ResponseInterface|null Possible redirect response

Definition at line 2339 of file EditDocumentController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\EditDocumentController\$returnUrl, and TYPO3\CMS\Core\Utility\HttpUtility\redirect().

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\preInit().

◆ main()

TYPO3\CMS\Backend\Controller\EditDocumentController::main ( ServerRequestInterface $request = null )

Main module operation

Parameters

ServerRequestInterface $request

Definition at line 1154 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\mainAction().

◆ mainAction()

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

Main dispatcher entry method registered as "record_edit" end point

Parameters

ServerRequestInterface $request ‪the current request

Returns: ‪ResponseInterface the response with the content

Definition at line 469 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Controller\EditDocumentController\init(), TYPO3\CMS\Backend\Utility\BackendUtility\lockRecords(), TYPO3\CMS\Backend\Controller\EditDocumentController\main(), TYPO3\CMS\Backend\Controller\EditDocumentController\preInit(), and TYPO3\CMS\Backend\Controller\EditDocumentController\processData().

◆ makeEditForm()

string TYPO3\CMS\Backend\Controller\EditDocumentController::makeEditForm ( )

protected

Creates the editing form with FormEngine, based on the input from GPvars.

Returns: ‪string HTML form elements wrapped in tables

Definition at line 1211 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Controller\EditDocumentController\$columnsOnly, TYPO3\CMS\Backend\Controller\EditDocumentController\$defVals, $GLOBALS, TYPO3\CMS\Core\Type\Bitmask\Permission\CONTENT_EDIT, TYPO3\CMS\Backend\Form\Utility\FormEngineUtility\databaseRowCompatibility(), TYPO3\CMS\Backend\Controller\EditDocumentController\getBackendUser(), TYPO3\CMS\Backend\Controller\EditDocumentController\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitle(), TYPO3\CMS\Backend\Utility\BackendUtility\isRecordLocked(), TYPO3\CMS\Backend\Utility\BackendUtility\lockRecords(), TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_DELETE, and TYPO3\CMS\Core\Messaging\AbstractMessage\WARNING.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\main().

◆ openInNewWindowLink()

TYPO3\CMS\Backend\Controller\EditDocumentController::openInNewWindowLink ( )

Creates open-in-window link

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 2118 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_RIGHT, TYPO3\CMS\Backend\Controller\EditDocumentController\getCloseUrl(), TYPO3\CMS\Backend\Controller\EditDocumentController\getLanguageService(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

◆ parseAdditionalGetParameters()

TYPO3\CMS\Backend\Controller\EditDocumentController::parseAdditionalGetParameters	(	array &	$parameters,
		array	$typoScript
	)

protected

Migrates a set of (possibly nested) GET parameters in TypoScript syntax to a plain array

This basically removes the trailing dots of sub-array keys in TypoScript. The result can be used to create a query string with GeneralUtility::implodeArrayForUrl().

Parameters

array	$parameters	‪Should be an empty array by default
array	$typoScript	‪The TypoScript configuration

Definition at line 1136 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\getPreviewUrlParameters().

◆ preInit()

ResponseInterface null TYPO3\CMS\Backend\Controller\EditDocumentController::preInit ( ServerRequestInterface $request = null )

First initialization, always called, even before processData() executes DataHandler processing.

Parameters

ServerRequestInterface $request

Returns: ‪ResponseInterface|null Possible redirect response

Definition at line 503 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Controller\EditDocumentController\$editconf, $GLOBALS, TYPO3\CMS\Backend\Controller\EditDocumentController\$overrideVals, TYPO3\CMS\Backend\Controller\EditDocumentController\addSlugFieldsToColumnsOnly(), TYPO3\CMS\Backend\Controller\EditDocumentController\closeDocument(), TYPO3\CMS\Backend\Controller\EditDocumentController\compileStoreData(), TYPO3\CMS\Backend\Controller\EditDocumentController\emitFunctionAfterSignal(), TYPO3\CMS\Backend\Controller\EditDocumentController\fixWSversioningInEditConf(), TYPO3\CMS\Backend\Controller\EditDocumentController\getBackendUser(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getModuleData(), TYPO3\CMS\Backend\Controller\EditDocumentController\localizationRedirect(), and TYPO3\CMS\Core\Authentication\BackendUserAuthentication\setTemporaryWorkspace().

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\mainAction().

◆ processData()

ResponseInterface null TYPO3\CMS\Backend\Controller\EditDocumentController::processData ( ServerRequestInterface $request = null )

Do processing of data, submitting it to DataHandler. May return a RedirectResponse

Parameters

ServerRequestInterface $request

Returns: ‪ResponseInterface|null

Definition at line 620 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\mainAction().

◆ registerCloseButtonToButtonBar()

TYPO3\CMS\Backend\Controller\EditDocumentController::registerCloseButtonToButtonBar	(	ButtonBar	$buttonBar,
		string	$position,
		int	$group
	)

protected

Register the close button to the button bar

Parameters

ButtonBar	$buttonBar
string	$position
int	$group

Definition at line 1530 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\addButton(), TYPO3\CMS\Backend\Controller\EditDocumentController\getLanguageService(), TYPO3\CMS\Backend\Template\Components\ButtonBar\makeLinkButton(), TYPO3\CMS\Backend\Template\Components\AbstractControl\setClasses(), TYPO3\CMS\Backend\Template\Components\Buttons\LinkButton\setHref(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\getButtons().

◆ registerColumnsOnlyButtonToButtonBar()

TYPO3\CMS\Backend\Controller\EditDocumentController::registerColumnsOnlyButtonToButtonBar	(	ButtonBar	$buttonBar,
		string	$position,
		int	$group
	)

protected

Register the columns only button to the button bar

Parameters

ButtonBar	$buttonBar
string	$position
int	$group

Definition at line 1883 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\addButton(), TYPO3\CMS\Backend\Controller\EditDocumentController\getLanguageService(), TYPO3\CMS\Backend\Template\Components\ButtonBar\makeLinkButton(), TYPO3\CMS\Backend\Template\Components\Buttons\LinkButton\setHref(), TYPO3\CMS\Backend\Template\Components\AbstractControl\setTitle(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\getButtons().

◆ registerCshButtonToButtonBar()

TYPO3\CMS\Backend\Controller\EditDocumentController::registerCshButtonToButtonBar	(	ButtonBar	$buttonBar,
		string	$position,
		int	$group
	)

protected

Register the CSH button to the button bar

Parameters

ButtonBar	$buttonBar
string	$position
int	$group

Definition at line 1963 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\addButton(), TYPO3\CMS\Backend\Template\Components\ButtonBar\makeHelpButton(), TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton\setFieldName(), and TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton\setModuleName().

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\getButtons().

◆ registerDeleteButtonToButtonBar()

TYPO3\CMS\Backend\Controller\EditDocumentController::registerDeleteButtonToButtonBar	(	ButtonBar	$buttonBar,
		string	$position,
		int	$group
	)

protected

Register the delete button to the button bar

Parameters

ButtonBar	$buttonBar
string	$position
int	$group

Definition at line 1770 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Controller\EditDocumentController\$retUrl, TYPO3\CMS\Backend\Controller\EditDocumentController\$returnUrl, TYPO3\CMS\Backend\Template\Components\ButtonBar\addButton(), TYPO3\CMS\Backend\Controller\EditDocumentController\getDisableDelete(), TYPO3\CMS\Backend\Controller\EditDocumentController\getLanguageService(), TYPO3\CMS\Backend\Template\Components\ButtonBar\makeLinkButton(), TYPO3\CMS\Backend\Utility\BackendUtility\referenceCount(), TYPO3\CMS\Backend\Template\Components\AbstractControl\setClasses(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, and TYPO3\CMS\Backend\Utility\BackendUtility\translationCount().

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\getButtons().

◆ registerDuplicationButtonToButtonBar()

TYPO3\CMS\Backend\Controller\EditDocumentController::registerDuplicationButtonToButtonBar	(	ButtonBar	$buttonBar,
		string	$position,
		int	$group,
		int	$sysLanguageUid,
		int	$l18nParent
	)

protected

Register the duplication button to the button bar

Parameters

ButtonBar	$buttonBar
string	$position
int	$group
int	$sysLanguageUid
int	$l18nParent

Definition at line 1712 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\addButton(), TYPO3\CMS\Backend\Controller\EditDocumentController\getLanguageService(), TYPO3\CMS\Backend\Controller\EditDocumentController\getTsConfigOption(), TYPO3\CMS\Backend\Controller\EditDocumentController\isInconsistentLanguageHandlingAllowed(), TYPO3\CMS\Backend\Template\Components\ButtonBar\makeLinkButton(), TYPO3\CMS\Backend\Template\Components\Buttons\LinkButton\setHref(), TYPO3\CMS\Backend\Template\Components\Buttons\AbstractButton\setShowLabelText(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\getButtons().

◆ registerHistoryButtonToButtonBar()

TYPO3\CMS\Backend\Controller\EditDocumentController::registerHistoryButtonToButtonBar	(	ButtonBar	$buttonBar,
		string	$position,
		int	$group
	)

protected

Register the history button to the button bar

Parameters

ButtonBar	$buttonBar
string	$position
int	$group

Definition at line 1844 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\addButton(), TYPO3\CMS\Backend\Controller\EditDocumentController\getTsConfigOption(), TYPO3\CMS\Backend\Template\Components\ButtonBar\makeLinkButton(), TYPO3\CMS\Backend\Template\Components\Buttons\LinkButton\setHref(), TYPO3\CMS\Backend\Template\Components\Buttons\AbstractButton\setIcon(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\getButtons().

◆ registerNewButtonToButtonBar()

TYPO3\CMS\Backend\Controller\EditDocumentController::registerNewButtonToButtonBar	(	ButtonBar	$buttonBar,
		string	$position,
		int	$group,
		int	$sysLanguageUid,
		int	$l18nParent
	)

protected

Register the new button to the button bar

Parameters

ButtonBar	$buttonBar
string	$position
int	$group
int	$sysLanguageUid
int	$l18nParent

Definition at line 1652 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\addButton(), TYPO3\CMS\Backend\Controller\EditDocumentController\getLanguageService(), TYPO3\CMS\Backend\Controller\EditDocumentController\getTsConfigOption(), TYPO3\CMS\Backend\Controller\EditDocumentController\isInconsistentLanguageHandlingAllowed(), TYPO3\CMS\Backend\Template\Components\ButtonBar\makeLinkButton(), TYPO3\CMS\Backend\Template\Components\Buttons\LinkButton\setHref(), TYPO3\CMS\Backend\Template\Components\Buttons\AbstractButton\setIcon(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\getButtons().

◆ registerOpenInNewWindowButtonToButtonBar()

TYPO3\CMS\Backend\Controller\EditDocumentController::registerOpenInNewWindowButtonToButtonBar	(	ButtonBar	$buttonBar,
		string	$position,
		int	$group
	)

protected

Register the open in new window button to the button bar

Parameters

ButtonBar	$buttonBar
string	$position
int	$group

Definition at line 1908 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\addButton(), TYPO3\CMS\Backend\Controller\EditDocumentController\getCloseUrl(), TYPO3\CMS\Backend\Controller\EditDocumentController\getLanguageService(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\getButtons().

◆ registerSaveButtonToButtonBar()

TYPO3\CMS\Backend\Controller\EditDocumentController::registerSaveButtonToButtonBar	(	ButtonBar	$buttonBar,
		string	$position,
		int	$group
	)

protected

Register the save button to the button bar

Parameters

ButtonBar	$buttonBar
string	$position
int	$group

Definition at line 1554 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\addButton(), TYPO3\CMS\Backend\Controller\EditDocumentController\getLanguageService(), TYPO3\CMS\Backend\Template\Components\ButtonBar\makeInputButton(), TYPO3\CMS\Backend\Template\Components\Buttons\InputButton\setForm(), TYPO3\CMS\Backend\Template\Components\Buttons\AbstractButton\setIcon(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\getButtons().

◆ registerShortcutButtonToButtonBar()

TYPO3\CMS\Backend\Controller\EditDocumentController::registerShortcutButtonToButtonBar	(	ButtonBar	$buttonBar,
		string	$position,
		int	$group
	)

protected

Register the shortcut button to the button bar

Parameters

ButtonBar	$buttonBar
string	$position
int	$group

Definition at line 1938 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\addButton(), and TYPO3\CMS\Backend\Controller\EditDocumentController\getCloseUrl().

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\getButtons().

◆ registerViewButtonToButtonBar()

TYPO3\CMS\Backend\Controller\EditDocumentController::registerViewButtonToButtonBar	(	ButtonBar	$buttonBar,
		string	$position,
		int	$group
	)

protected

Register the view button to the button bar

Parameters

ButtonBar	$buttonBar
string	$position
int	$group

Definition at line 1576 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\getButtons().

◆ resolvePreviewRecordId()

int TYPO3\CMS\Backend\Controller\EditDocumentController::resolvePreviewRecordId	(	string	$table,
		array	$recordArray,
		array	$previewConfiguration
	)

protected

Parameters

string	$table
array	$recordArray
array	$previewConfiguration

Returns: ‪int

Definition at line 1045 of file EditDocumentController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\getPreviewUrlParameters().

◆ setDocument()

TYPO3\CMS\Backend\Controller\EditDocumentController::setDocument	(	$currentDocFromHandlerMD5 = `''`,
		$retUrl = `''`
	)

Redirects to the document pointed to by $currentDocFromHandlerMD5 OR $retUrl, depending on some internal calculations.

Parameters

string	$currentDocFromHandlerMD5	‪Pointer to the document in the docHandler array
string	$retUrl	‪Alternative/Default retUrl

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 2710 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Controller\EditDocumentController\$retUrl, and TYPO3\CMS\Core\Utility\HttpUtility\redirect().

◆ setIsPageInFreeTranslationMode()

TYPO3\CMS\Backend\Controller\EditDocumentController::setIsPageInFreeTranslationMode	(		$record,
		int	$sysLanguageUid
	)

protected

Set the boolean to check if the page is in free translation mode

Parameters

array \| null	$record
int	$sysLanguageUid

Definition at line 1482 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Controller\EditDocumentController\getFreeTranslationMode().

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\getButtons().

◆ setIsSavedRecord()

TYPO3\CMS\Backend\Controller\EditDocumentController::setIsSavedRecord ( )

protected

Set the boolean to check if the record is saved

Definition at line 1452 of file EditDocumentController.php.

References TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger().

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\getButtons().

◆ shortCutLink()

TYPO3\CMS\Backend\Controller\EditDocumentController::shortCutLink ( )

Create shortcut icon

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 2094 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Controller\EditDocumentController\getCloseUrl().

Member Data Documentation

◆ $cacheCmd

string TYPO3\CMS\Backend\Controller\EditDocumentController::$cacheCmd

protected

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0, unused

Definition at line 213 of file EditDocumentController.php.

◆ $closeDoc

int TYPO3\CMS\Backend\Controller\EditDocumentController::$closeDoc

protected

Close document command. One of the DOCUMENT_CLOSE_MODE_* constants above

Definition at line 179 of file EditDocumentController.php.

◆ $cmd

array TYPO3\CMS\Backend\Controller\EditDocumentController::$cmd

protected

Main DataHandler cmdmap array

Definition at line 202 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\fixWSversioningInEditConf().

◆ $columnsOnly

string null TYPO3\CMS\Backend\Controller\EditDocumentController::$columnsOnly

protected

Comma list of field names to edit. If specified, only those fields will be rendered. Otherwise all (available) fields in the record are shown according to the TCA type.

Definition at line 146 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\makeEditForm().

◆ $content

TYPO3\CMS\Backend\Controller\EditDocumentController::$content

protected

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0, unused

Definition at line 292 of file EditDocumentController.php.

◆ $data

TYPO3\CMS\Backend\Controller\EditDocumentController::$data

Definition at line 196 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\addSlugFieldsToColumnsOnly().

◆ $defVals

array null TYPO3\CMS\Backend\Controller\EditDocumentController::$defVals

protected

Default values for fields

[table][field]

Definition at line 152 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\makeEditForm().

◆ $deprecatedPublicMethods

array TYPO3\CMS\Backend\Controller\EditDocumentController::$deprecatedPublicMethods

private

Initial value:

= array( 
        'makeEditForm' => 'Using EditDocumentController::makeEditForm() is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'compileForm' => 'Using EditDocumentController::compileForm() is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'languageSwitch' => 'Using EditDocumentController::languageSwitch() is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'getLanguages' => 'Using EditDocumentController::getLanguages() is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'fixWSversioningInEditConf' => 'Using EditDocumentController::fixWSversioningInEditConf() is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'getRecordForEdit' => 'Using EditDocumentController::getRecordForEdit() is deprecated and will not be possible anymore in TYPO3 v10.0.',
     )

Definition at line 76 of file EditDocumentController.php.

◆ $deprecatedPublicProperties

array TYPO3\CMS\Backend\Controller\EditDocumentController::$deprecatedPublicProperties

private

Properties which have been moved to protected status from public

Definition at line 89 of file EditDocumentController.php.

◆ $doc

TYPO3 CMS Backend Template DocumentTemplate TYPO3\CMS\Backend\Controller\EditDocumentController::$doc

protected

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0, unused

Definition at line 282 of file EditDocumentController.php.

◆ $docDat

array TYPO3\CMS\Backend\Controller\EditDocumentController::$docDat

protected

Backend user session data of this module

Definition at line 352 of file EditDocumentController.php.

◆ $docHandler

array TYPO3\CMS\Backend\Controller\EditDocumentController::$docHandler

protected

An array of the "open documents" - keys are md5 hashes (see $storeUrlMd5) identifying the various documents on the GET parameter list needed to open it. The values are arrays with 0,1,2 keys with information about the document (see compileStoreData()). The docHandler variable is stored in the $docDat session data, key "0".

Definition at line 361 of file EditDocumentController.php.

◆ $dontStoreDocumentRef

bool TYPO3\CMS\Backend\Controller\EditDocumentController::$dontStoreDocumentRef = 0

protected

Used internally to disable the storage of the document reference (eg. new records)

Definition at line 416 of file EditDocumentController.php.

◆ $doSave

bool TYPO3\CMS\Backend\Controller\EditDocumentController::$doSave

protected

If true, the processing of incoming data will be performed as if a save-button is pressed. Used in the forms as a hidden field which can be set through JavaScript if the form is somehow submitted by JavaScript.

Definition at line 187 of file EditDocumentController.php.

◆ $editconf

array TYPO3\CMS\Backend\Controller\EditDocumentController::$editconf = array( )

protected

An array looking approx like [tablename][list-of-ids]=command, eg. "&edit[pages][123]=edit".

See also: ‪\TYPO3\CMS\Backend\Utility\BackendUtility::editOnClick()

Definition at line 139 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\preInit(), and TYPO3\CMS\Backend\Controller\EditDocumentController\processData().

◆ $elementsData

TYPO3\CMS\Backend\Controller\EditDocumentController::$elementsData

Definition at line 370 of file EditDocumentController.php.

◆ $errorC

int TYPO3\CMS\Backend\Controller\EditDocumentController::$errorC

protected

Counter, used to count the number of errors (when users do not have edit permissions)

Definition at line 382 of file EditDocumentController.php.

◆ $firstEl

array TYPO3\CMS\Backend\Controller\EditDocumentController::$firstEl

protected

Pointer to the first element in $elementsData

Definition at line 376 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\main().

◆ $formResultCompiler

FormResultCompiler TYPO3\CMS\Backend\Controller\EditDocumentController::$formResultCompiler

protected

Definition at line 410 of file EditDocumentController.php.

◆ $isPageInFreeTranslationMode

bool TYPO3\CMS\Backend\Controller\EditDocumentController::$isPageInFreeTranslationMode = false

protected

Check if a page in free translation mode

Definition at line 444 of file EditDocumentController.php.

◆ $isSavedRecord

bool TYPO3\CMS\Backend\Controller\EditDocumentController::$isSavedRecord

protected

Check if a record has been saved

Definition at line 438 of file EditDocumentController.php.

◆ $MCONF

array TYPO3\CMS\Backend\Controller\EditDocumentController::$MCONF

protected

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0, unused

Definition at line 316 of file EditDocumentController.php.

◆ $mirror

array TYPO3\CMS\Backend\Controller\EditDocumentController::$mirror

protected

DataHandler 'mirror' input

Definition at line 208 of file EditDocumentController.php.

◆ $modTSconfig

TYPO3\CMS\Backend\Controller\EditDocumentController::$modTSconfig = array( )

protected

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0, unused

Definition at line 406 of file EditDocumentController.php.

◆ $moduleTemplate

ModuleTemplate TYPO3\CMS\Backend\Controller\EditDocumentController::$moduleTemplate

protected

ModuleTemplate object

Definition at line 432 of file EditDocumentController.php.

◆ $newC

int TYPO3\CMS\Backend\Controller\EditDocumentController::$newC

protected

Counter, used to count the number of new record forms displayed

Definition at line 388 of file EditDocumentController.php.

◆ $noView

bool TYPO3\CMS\Backend\Controller\EditDocumentController::$noView

protected

If set, then no save & view button is printed

Definition at line 261 of file EditDocumentController.php.

◆ $overrideVals

array null TYPO3\CMS\Backend\Controller\EditDocumentController::$overrideVals

protected

Array of values to force being set as hidden fields in FormEngine

[table][field]

Definition at line 158 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\preInit().

◆ $pageinfo

array TYPO3\CMS\Backend\Controller\EditDocumentController::$pageinfo

protected

Definition at line 320 of file EditDocumentController.php.

◆ $perms_clause

string TYPO3\CMS\Backend\Controller\EditDocumentController::$perms_clause

protected

Definition at line 265 of file EditDocumentController.php.

◆ $popViewId

int TYPO3\CMS\Backend\Controller\EditDocumentController::$popViewId

protected

ID for displaying the page in the frontend, "save and view"

Definition at line 238 of file EditDocumentController.php.

◆ $popViewId_addParams

string TYPO3\CMS\Backend\Controller\EditDocumentController::$popViewId_addParams

protected

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0, unused

Definition at line 243 of file EditDocumentController.php.

◆ $previewData

array TYPO3\CMS\Backend\Controller\EditDocumentController::$previewData = array( )

protected

Stores information needed to preview the currently saved record

Definition at line 426 of file EditDocumentController.php.

◆ $R_URI

string TYPO3\CMS\Backend\Controller\EditDocumentController::$R_URI

protected

Set to the URL of this script including variables which is needed to re-display the form.

Definition at line 311 of file EditDocumentController.php.

◆ $R_URL_getvars

array TYPO3\CMS\Backend\Controller\EditDocumentController::$R_URL_getvars

protected

Contains $request query parameters. This array is the foundation for creating the R_URI internal var which becomes the url to which forms are submitted

Definition at line 305 of file EditDocumentController.php.

◆ $R_URL_parts

array TYPO3\CMS\Backend\Controller\EditDocumentController::$R_URL_parts

protected

parse_url() of current requested URI, contains ['path'] and ['query'] parts.

Definition at line 298 of file EditDocumentController.php.

◆ $recTitle

string TYPO3\CMS\Backend\Controller\EditDocumentController::$recTitle

protected

Alternative title for the document handler.

Definition at line 255 of file EditDocumentController.php.

◆ $redirect

string TYPO3\CMS\Backend\Controller\EditDocumentController::$redirect

protected

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0, unused

Definition at line 218 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\processData().

◆ $retUrl

string TYPO3\CMS\Backend\Controller\EditDocumentController::$retUrl

protected

Prepared return URL. Contains the URL that we should return to from FormEngine if close button is clicked. Usually passed along as 'returnUrl', but falls back to "dummy" controller.

Definition at line 173 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\closeDocument(), TYPO3\CMS\Backend\Controller\EditDocumentController\init(), TYPO3\CMS\Backend\Controller\EditDocumentController\languageSwitch(), TYPO3\CMS\Backend\Controller\EditDocumentController\registerDeleteButtonToButtonBar(), and TYPO3\CMS\Backend\Controller\EditDocumentController\setDocument().

◆ $returnEditConf

bool TYPO3\CMS\Backend\Controller\EditDocumentController::$returnEditConf

protected

If true, $this->editconf array is added a redirect response, used by Wizard/AddController

Definition at line 271 of file EditDocumentController.php.

◆ $returnNewPageId

bool TYPO3\CMS\Backend\Controller\EditDocumentController::$returnNewPageId = false

protected

Boolean: If set, then the GET var "&id=" will be added to the retUrl string so that the NEW id of something is returned to the script calling the form.

Definition at line 225 of file EditDocumentController.php.

◆ $returnUrl

string null TYPO3\CMS\Backend\Controller\EditDocumentController::$returnUrl

protected

If set, this value will be set in $this->retUrl as "returnUrl", if not, $this->retUrl will link to dummy controller

Definition at line 165 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\closeDocument(), TYPO3\CMS\Backend\Controller\EditDocumentController\localizationRedirect(), and TYPO3\CMS\Backend\Controller\EditDocumentController\registerDeleteButtonToButtonBar().

◆ $signalSlotDispatcher

TYPO3 CMS Extbase SignalSlot Dispatcher TYPO3\CMS\Backend\Controller\EditDocumentController::$signalSlotDispatcher

protected

Definition at line 420 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\getSignalSlotDispatcher().

◆ $storeArray

array TYPO3\CMS\Backend\Controller\EditDocumentController::$storeArray

protected

Contains an array with key/value pairs of GET parameters needed to reach the current document displayed - used in the 'open documents' toolbar.

Definition at line 334 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\main().

◆ $storeTitle

string TYPO3\CMS\Backend\Controller\EditDocumentController::$storeTitle = ''

protected

Is loaded with the "title" of the currently "open document" used for the open document toolbar

Definition at line 327 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\main().

◆ $storeUrl

string TYPO3\CMS\Backend\Controller\EditDocumentController::$storeUrl

protected

$this->storeArray imploded to url

Definition at line 340 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\main().

◆ $storeUrlMd5

string TYPO3\CMS\Backend\Controller\EditDocumentController::$storeUrlMd5

protected

md5 hash of storeURL, used to identify a single open document in backend user uc

Definition at line 346 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\closeDocument(), and TYPO3\CMS\Backend\Controller\EditDocumentController\main().

◆ $template

TYPO3\CMS\Backend\Controller\EditDocumentController::$template

protected

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0, unused

Definition at line 287 of file EditDocumentController.php.

◆ $uc

array null TYPO3\CMS\Backend\Controller\EditDocumentController::$uc

protected

Updated values for backendUser->uc. Used for new inline records to mark them as expanded: uc[inlineView][...]

Definition at line 232 of file EditDocumentController.php.

◆ $uriBuilder

UriBuilder TYPO3\CMS\Backend\Controller\EditDocumentController::$uriBuilder

protected

Definition at line 448 of file EditDocumentController.php.

◆ $viewId

int TYPO3\CMS\Backend\Controller\EditDocumentController::$viewId

protected

Is set to the pid value of the last shown record - thus indicating which page to show when clicking the SAVE/VIEW button

Definition at line 395 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\getPreviewPageId().

◆ $viewId_addParams

string TYPO3\CMS\Backend\Controller\EditDocumentController::$viewId_addParams

protected

Is set to additional parameters (like "&L=xxx") if the record supports it.

Definition at line 401 of file EditDocumentController.php.

◆ $viewUrl

string TYPO3\CMS\Backend\Controller\EditDocumentController::$viewUrl

protected

Alternative URL for viewing the frontend pages.

Definition at line 249 of file EditDocumentController.php.

◆ $workspace

string null TYPO3\CMS\Backend\Controller\EditDocumentController::$workspace

protected

Workspace used for the editing action.

Definition at line 277 of file EditDocumentController.php.

◆ DOCUMENT_CLOSE_MODE_CLEAR_ALL

const TYPO3\CMS\Backend\Controller\EditDocumentController::DOCUMENT_CLOSE_MODE_CLEAR_ALL = 3

Definition at line 71 of file EditDocumentController.php.

◆ DOCUMENT_CLOSE_MODE_DEFAULT

const TYPO3\CMS\Backend\Controller\EditDocumentController::DOCUMENT_CLOSE_MODE_DEFAULT = 0

Deprecated:: ‪since TYPO3 v9. These constants will be set to protected in TYPO3 v10.0

Definition at line 69 of file EditDocumentController.php.

◆ DOCUMENT_CLOSE_MODE_NO_REDIRECT

const TYPO3\CMS\Backend\Controller\EditDocumentController::DOCUMENT_CLOSE_MODE_NO_REDIRECT = 4

Definition at line 72 of file EditDocumentController.php.

◆ DOCUMENT_CLOSE_MODE_REDIRECT

const TYPO3\CMS\Backend\Controller\EditDocumentController::DOCUMENT_CLOSE_MODE_REDIRECT = 1

Definition at line 70 of file EditDocumentController.php.

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addSlugFieldsToColumnsOnly()

◆ closeDocument()

◆ compileForm()

◆ compileStoreDat()

◆ compileStoreData()

◆ doProcessData()

◆ emitFunctionAfterSignal()

◆ fixWSversioningInEditConf()

◆ generatePreviewCode()

◆ getBackendUser()

◆ getButtons()

◆ getCloseUrl()

◆ getConnectedContentElementTranslationsCount()

◆ getDisableDelete()

◆ getFreeTranslationMode()

◆ getLanguages()

◆ getLanguageService()

◆ getNewIconMode()

◆ getPreviewPageId()

◆ getPreviewUrlAnchorSection()

◆ getPreviewUrlParameters()

◆ getQueryBuilderForTranslationMode()

◆ getRecordForEdit()

◆ getSignalSlotDispatcher()

◆ getStandAloneContentElementTranslationsCount()

◆ getTsConfigOption()

◆ init()

◆ isInconsistentLanguageHandlingAllowed()

◆ languageSwitch()

◆ localizationRedirect()

◆ main()

◆ mainAction()

◆ makeEditForm()

◆ openInNewWindowLink()

◆ parseAdditionalGetParameters()

◆ preInit()

◆ processData()

◆ registerCloseButtonToButtonBar()

◆ registerColumnsOnlyButtonToButtonBar()

◆ registerCshButtonToButtonBar()

◆ registerDeleteButtonToButtonBar()

◆ registerDuplicationButtonToButtonBar()

◆ registerHistoryButtonToButtonBar()

◆ registerNewButtonToButtonBar()

◆ registerOpenInNewWindowButtonToButtonBar()

◆ registerSaveButtonToButtonBar()

◆ registerShortcutButtonToButtonBar()

◆ registerViewButtonToButtonBar()

◆ resolvePreviewRecordId()

◆ setDocument()

◆ setIsPageInFreeTranslationMode()

◆ setIsSavedRecord()

◆ shortCutLink()

Member Data Documentation

◆ $cacheCmd

◆ $closeDoc

◆ $cmd

◆ $columnsOnly

◆ $content

◆ $data

◆ $defVals

◆ $deprecatedPublicMethods

◆ $deprecatedPublicProperties

◆ $doc

◆ $docDat

◆ $docHandler

◆ $dontStoreDocumentRef

◆ $doSave

◆ $editconf

◆ $elementsData

◆ $errorC