‪TYPO3CMS  10.4
TYPO3\CMS\Backend\Controller\EditDocumentController Class Reference

Public Member Functions

 __construct (EventDispatcherInterface $eventDispatcher)
 
ResponseInterface mainAction (ServerRequestInterface $request)
 

Public Attributes

 $data
 
 $elementsData
 

Protected Member Functions

ResponseInterface preInit (ServerRequestInterface $request)
 
 addSlugFieldsToColumnsOnly (array $queryParams)
 
ResponseInterface null processData (ServerRequestInterface $request)
 
 init (ServerRequestInterface $request)
 
string generatePreviewCode ()
 
string getPreviewUrlParameters (int $previewPageId)
 
int resolvePreviewRecordId (string $table, array $recordArray, array $previewConfiguration)
 
string getPreviewUrlAnchorSection ()
 
int getPreviewPageId ()
 
bool canViewDoktype (array $currentPage)
 
 parseAdditionalGetParameters (array &$parameters, array $typoScript)
 
 main (ServerRequestInterface $request)
 
string makeEditForm ()
 
string getInfobox (string $message, ?string $title=null)
 
 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 ()
 
bool isRecordCurrentBackendUser ()
 
string getCloseUrl ()
 
 languageSwitch (string $table, int $uid, $pid=null)
 
ResponseInterface null localizationRedirect (ServerRequestInterface $request)
 
array getLanguages (int $id, string $table)
 
 fixWSversioningInEditConf ($mapArray=false)
 
array false getRecordForEdit (string $table, int $theUid)
 
 compileStoreData ()
 
string getTsConfigOption (string $table, string $key)
 
ResponseInterface null closeDocument ($mode, ServerRequestInterface $request)
 
TYPO3 CMS Core Authentication BackendUserAuthentication getBackendUser ()
 
TYPO3 CMS Core Localization LanguageService getLanguageService ()
 

Protected 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
 
array< string, 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
 
bool $returnNewPageId = false
 
array null $uc
 
int $popViewId
 
string $viewUrl
 
string $recTitle
 
bool $noView
 
string $perms_clause
 
bool $returnEditConf
 
array $R_URL_parts
 
array $R_URL_getvars
 
string $R_URI
 
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
 
FormResultCompiler $formResultCompiler
 
int $dontStoreDocumentRef = 0
 
array $previewData = array( )
 
ModuleTemplate $moduleTemplate
 
bool $isSavedRecord
 
bool $isPageInFreeTranslationMode = false
 
EventDispatcherInterface $eventDispatcher
 
UriBuilder $uriBuilder
 

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 66 of file EditDocumentController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\Controller\EditDocumentController::__construct ( EventDispatcherInterface  $eventDispatcher)

Member Function Documentation

◆ addSlugFieldsToColumnsOnly()

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

◆ canViewDoktype()

bool TYPO3\CMS\Backend\Controller\EditDocumentController::canViewDoktype ( array  $currentPage)
protected

◆ closeDocument()

ResponseInterface null TYPO3\CMS\Backend\Controller\EditDocumentController::closeDocument (   $mode,
ServerRequestInterface  $request 
)
protected

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 2421 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Controller\EditDocumentController\$retUrl, TYPO3\CMS\Backend\Controller\EditDocumentController\$storeUrlMd5, TYPO3\CMS\Backend\Controller\EditDocumentController\getBackendUser(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getModuleData(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\pushModuleData(), 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 1911 of file EditDocumentController.php.

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

◆ 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 2382 of file EditDocumentController.php.

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

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

◆ 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 2293 of file EditDocumentController.php.

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

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

◆ generatePreviewCode()

◆ getBackendUser()

◆ 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 1233 of file EditDocumentController.php.

References $GLOBALS, TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_LEFT, TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_RIGHT, TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), TYPO3\CMS\Backend\Controller\EditDocumentController\registerCloseButtonToButtonBar(), TYPO3\CMS\Backend\Controller\EditDocumentController\registerColumnsOnlyButtonToButtonBar(), TYPO3\CMS\Backend\Controller\EditDocumentController\registerCshButtonToButtonBar(), TYPO3\CMS\Backend\Controller\EditDocumentController\registerDeleteButtonToButtonBar(), TYPO3\CMS\Backend\Controller\EditDocumentController\registerDuplicationButtonToButtonBar(), TYPO3\CMS\Backend\Controller\EditDocumentController\registerHistoryButtonToButtonBar(), TYPO3\CMS\Backend\Controller\EditDocumentController\registerNewButtonToButtonBar(), TYPO3\CMS\Backend\Controller\EditDocumentController\registerOpenInNewWindowButtonToButtonBar(), TYPO3\CMS\Backend\Controller\EditDocumentController\registerSaveButtonToButtonBar(), TYPO3\CMS\Backend\Controller\EditDocumentController\registerShortcutButtonToButtonBar(), TYPO3\CMS\Backend\Controller\EditDocumentController\registerViewButtonToButtonBar(), TYPO3\CMS\Backend\Controller\EditDocumentController\setIsPageInFreeTranslationMode(), and TYPO3\CMS\Backend\Controller\EditDocumentController\setIsSavedRecord().

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 1978 of file EditDocumentController.php.

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

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

◆ 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 1828 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 1944 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

◆ getInfobox()

string TYPO3\CMS\Backend\Controller\EditDocumentController::getInfobox ( string  $message,
?string  $title = null 
)
protected

Helper function for rendering an Infobox

Parameters
string$message
string | null$title
Returns
‪string

Definition at line 1210 of file EditDocumentController.php.

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

◆ getLanguages()

array TYPO3\CMS\Backend\Controller\EditDocumentController::getLanguages ( int  $id,
string  $table 
)
protected

Returns languages available for record translations on given page.

Parameters
int$idPage 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
‪array Array with languages (uid, title, ISOcode, flagIcon)

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

◆ getPreviewPageId()

◆ getPreviewUrlAnchorSection()

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

◆ getPreviewUrlParameters()

◆ getQueryBuilderForTranslationMode()

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

◆ getRecordForEdit()

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

◆ 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 1851 of file EditDocumentController.php.

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

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

◆ getTsConfigOption()

◆ init()

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

◆ isInconsistentLanguageHandlingAllowed()

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

◆ isRecordCurrentBackendUser()

bool TYPO3\CMS\Backend\Controller\EditDocumentController::isRecordCurrentBackendUser ( )
protected

Return true in case the current record is the current backend user

Returns
‪bool

Definition at line 1964 of file EditDocumentController.php.

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

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

◆ languageSwitch()

◆ localizationRedirect()

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

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 2166 of file EditDocumentController.php.

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

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

◆ main()

◆ 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 360 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()

◆ 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 962 of file EditDocumentController.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\getPreviewUrlParameters(), and TYPO3\CMS\Backend\Tests\Unit\Controller\EditDocumentControllerTest\parseAdditionalGetParametersCreatesCorrectParameterArray().

◆ preInit()

◆ processData()

◆ registerCloseButtonToButtonBar()

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

◆ registerColumnsOnlyButtonToButtonBar()

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

◆ registerCshButtonToButtonBar()

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

◆ registerDeleteButtonToButtonBar()

◆ registerDuplicationButtonToButtonBar()

◆ registerHistoryButtonToButtonBar()

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

◆ registerNewButtonToButtonBar()

◆ registerOpenInNewWindowButtonToButtonBar()

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

◆ registerSaveButtonToButtonBar()

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

◆ 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 1788 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

◆ 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 853 of file EditDocumentController.php.

References $GLOBALS.

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

◆ 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 1326 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 1296 of file EditDocumentController.php.

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

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

Member Data Documentation

◆ $closeDoc

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

Close document command. One of the DOCUMENT_CLOSE_MODE_* constants above

Definition at line 118 of file EditDocumentController.php.

◆ $cmd

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

Main DataHandler cmdmap array

Definition at line 141 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 85 of file EditDocumentController.php.

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

◆ $data

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

◆ $defVals

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

Default values for fields

[table][field]

Definition at line 91 of file EditDocumentController.php.

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

◆ $docDat

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

Backend user session data of this module

Definition at line 250 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 259 of file EditDocumentController.php.

◆ $dontStoreDocumentRef

int TYPO3\CMS\Backend\Controller\EditDocumentController::$dontStoreDocumentRef = 0
protected

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

Definition at line 309 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 126 of file EditDocumentController.php.

◆ $editconf

array<string,array> TYPO3\CMS\Backend\Controller\EditDocumentController::$editconf = array( )
protected

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

Definition at line 78 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 268 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 280 of file EditDocumentController.php.

◆ $eventDispatcher

EventDispatcherInterface TYPO3\CMS\Backend\Controller\EditDocumentController::$eventDispatcher
protected

◆ $firstEl

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

Pointer to the first element in $elementsData

Definition at line 274 of file EditDocumentController.php.

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

◆ $formResultCompiler

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

Definition at line 303 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 333 of file EditDocumentController.php.

◆ $isSavedRecord

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

Check if a record has been saved

Definition at line 327 of file EditDocumentController.php.

◆ $mirror

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

DataHandler 'mirror' input

Definition at line 147 of file EditDocumentController.php.

◆ $moduleTemplate

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

ModuleTemplate object

Definition at line 321 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 286 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 185 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 97 of file EditDocumentController.php.

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

◆ $pageinfo

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

Definition at line 218 of file EditDocumentController.php.

◆ $perms_clause

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

Definition at line 189 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 167 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 315 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 214 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 208 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 201 of file EditDocumentController.php.

◆ $recTitle

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

Alternative title for the document handler.

Definition at line 179 of file EditDocumentController.php.

◆ $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 112 of file EditDocumentController.php.

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

◆ $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 195 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 154 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 104 of file EditDocumentController.php.

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

◆ $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 232 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 225 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 238 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 244 of file EditDocumentController.php.

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

◆ $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 161 of file EditDocumentController.php.

◆ $uriBuilder

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

Definition at line 341 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 293 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 299 of file EditDocumentController.php.

◆ $viewUrl

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

Alternative URL for viewing the frontend pages.

Definition at line 173 of file EditDocumentController.php.

◆ DOCUMENT_CLOSE_MODE_CLEAR_ALL

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

Definition at line 71 of file EditDocumentController.php.

◆ DOCUMENT_CLOSE_MODE_DEFAULT

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

Definition at line 68 of file EditDocumentController.php.

◆ DOCUMENT_CLOSE_MODE_NO_REDIRECT

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

Definition at line 72 of file EditDocumentController.php.

◆ DOCUMENT_CLOSE_MODE_REDIRECT

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

Definition at line 70 of file EditDocumentController.php.