Inheritance diagram for EditDocumentController:

Public Member Functions
	__construct ()

	preInit ()

	doProcessData ()

	init ()

	printContent ()

	compileForm ($editForm)

	shortCutLink ()

	openInNewWindowLink ()

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

	localizationRedirect ($justLocalized)

	getLanguages ($id)

	fixWSversioningInEditConf ($mapArray=false)

	getRecordForEdit ($table, $theUid)

	editRegularContentFromId ()

	compileStoreDat ()

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

	closeDocument ($code=0)

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

	mainAction (ServerRequestInterface $request, ResponseInterface $response)

Public Member Functions inherited from AbstractModule
	__construct ()

	processRequest (ServerRequestInterface $request, ResponseInterface $response)

Public Attributes
	$editconf

	$columnsOnly

	$defVals

	$overrideVals

	$returnUrl

	$closeDoc

	$doSave

	$data

	$cmd

	$mirror

	$cacheCmd

	$redirect

	$returnNewPageId

	$vC

	$uc

	$popViewId

	$popViewId_addParams

	$viewUrl

	$editRegularContentFromId

	$recTitle

	$noView

	$perms_clause

	$returnEditConf

	$doc

	$template

	$content

	$retUrl

	$R_URL_parts

	$R_URL_getvars

	$R_URI

	$MCONF

	$pageinfo

	$storeTitle = ''

	$storeArray

	$storeUrl

	$storeUrlMd5

	$docDat

	$docHandler

	$elementsData

	$firstEl

	$errorC

	$newC

	$viewId

	$viewId_addParams

	$modTSconfig

	$dontStoreDocumentRef = 0

Protected Member Functions
	getSignalSlotDispatcher ()

	emitFunctionAfterSignal ($signalName)

	generatePreviewCode ()

	parseAdditionalGetParameters (array &$parameters, array $typoScript)

	getButtons ()

	getBackendUser ()

	getLanguageService ()

	getDatabaseConnection ()

Protected Attributes
	$workspace

	$formResultCompiler

	$signalSlotDispatcher

	$previewData = []

Protected Attributes inherited from AbstractModule
	$moduleTemplate

	$request

Detailed Description

Script Class: Drawing the editing form for editing records in TYPO3. Notice: It does NOT use tce_db.php to submit data to, rather it handles submissions itself

Definition at line 46 of file EditDocumentController.php.

Constructor & Destructor Documentation

__construct ( )

Constructor

Definition at line 409 of file EditDocumentController.php.

References $GLOBALS, and EditDocumentController\getLanguageService().

Member Function Documentation

closeDocument ( $code = 0 )

Handling the closing of a document

Parameters

int $code Close code: 0/1 will redirect to $this->retUrl, 3 will clear the docHandler (thus closing all documents) and other values will call setDocument with ->retUrl

Returns: void

Definition at line 1892 of file EditDocumentController.php.

References EditDocumentController\$storeUrlMd5, EditDocumentController\getBackendUser(), HttpUtility\redirect(), EditDocumentController\setDocument(), and BackendUtility\setUpdateSignal().

Referenced by EditDocumentController\preInit().

compileForm ( $editForm )

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

Parameters

string $editForm HTML form.

Returns: string Composite HTML

Definition at line 1440 of file EditDocumentController.php.

compileStoreDat ( )

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

Returns: void

See Also: makeDocSel()

Definition at line 1860 of file EditDocumentController.php.

References GeneralUtility\compileSelectedGetVarsFromArray(), and GeneralUtility\implodeArrayForUrl().

Referenced by EditDocumentController\preInit().

doProcessData ( )

Detects, if a save command has been triggered.

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

Definition at line 502 of file EditDocumentController.php.

Referenced by EditDocumentController\mainAction().

editRegularContentFromId ( )

Function, which populates the internal editconf array with editing commands for all tt_content elements from the normal column in normal language from the page pointed to by $this->editRegularContentFromId

Returns: void

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8

Definition at line 1832 of file EditDocumentController.php.

References BackendUtility\deleteClause(), EditDocumentController\getDatabaseConnection(), GeneralUtility\logDeprecatedFunction(), and BackendUtility\versioningPlaceholderClause().

Referenced by EditDocumentController\init().

emitFunctionAfterSignal ( $signalName )

protected

Emits a signal after a function was executed

Parameters

string $signalName

Definition at line 434 of file EditDocumentController.php.

References EditDocumentController\getSignalSlotDispatcher().

Referenced by EditDocumentController\init(), and EditDocumentController\preInit().

fixWSversioningInEditConf ( $mapArray = false )

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.

Returns: void

Definition at line 1737 of file EditDocumentController.php.

References EditDocumentController\$cmd, $GLOBALS, EditDocumentController\getRecordForEdit(), and GeneralUtility\trimExplode().

Referenced by EditDocumentController\preInit().

generatePreviewCode ( )

protected

Returns: string

Definition at line 819 of file EditDocumentController.php.

References $GLOBALS, BackendUtility\BEgetRootLine(), MathUtility\convertToPositiveInteger(), PageRepository\DOKTYPE_DEFAULT, BackendUtility\getPagesTSconfig(), BackendUtility\getRecord(), GeneralUtility\implodeArrayForUrl(), EditDocumentController\parseAdditionalGetParameters(), and BackendUtility\viewOnClick().

Referenced by EditDocumentController\init().

getBackendUser ( )

protected

Returns

Definition at line 1990 of file EditDocumentController.php.

References $GLOBALS.

Referenced by EditDocumentController\closeDocument(), EditDocumentController\getLanguages(), EditDocumentController\getNewIconMode(), EditDocumentController\getRecordForEdit(), EditDocumentController\init(), EditDocumentController\languageSwitch(), and EditDocumentController\preInit().

getButtons ( )

protected

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

Returns: array All available buttons as an assoc. array

Definition at line 1212 of file EditDocumentController.php.

References $GLOBALS, $lang, ButtonBar\BUTTON_POSITION_LEFT, BackendUtility\calcAge(), MathUtility\canBeInterpretedAsInteger(), PageRepository\DOKTYPE_RECYCLER, PageRepository\DOKTYPE_SPACER, PageRepository\DOKTYPE_SYSFOLDER, EditDocumentController\getDatabaseConnection(), EditDocumentController\getLanguageService(), EditDocumentController\getNewIconMode(), BackendUtility\getPagesTSconfig(), GeneralUtility\intExplode(), EditDocumentController\openInNewWindowLink(), GeneralUtility\quoteJSvalue(), EditDocumentController\shortCutLink(), and Icon\SIZE_SMALL.

getDatabaseConnection ( )

protected

Returns the database connection

Returns

Definition at line 2010 of file EditDocumentController.php.

References $GLOBALS.

Referenced by EditDocumentController\editRegularContentFromId(), EditDocumentController\getButtons(), EditDocumentController\getLanguages(), EditDocumentController\languageSwitch(), and EditDocumentController\localizationRedirect().

getLanguages ( $id )

Returns sys_language records 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 pages_language_overlay record on that page (and is not hidden, unless you are admin user)

Returns: array Language records including faked record for default language

Definition at line 1668 of file EditDocumentController.php.

References BackendUtility\deleteClause(), EditDocumentController\getBackendUser(), EditDocumentController\getDatabaseConnection(), EditDocumentController\getLanguageService(), and BackendUtility\getModTSconfig().

Referenced by EditDocumentController\languageSwitch().

getLanguageService ( )

protected

Returns LanguageService

Returns

Definition at line 2000 of file EditDocumentController.php.

References $GLOBALS.

Referenced by EditDocumentController\__construct(), EditDocumentController\getButtons(), EditDocumentController\getLanguages(), EditDocumentController\init(), EditDocumentController\languageSwitch(), and EditDocumentController\openInNewWindowLink().

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

Definition at line 1878 of file EditDocumentController.php.

References EditDocumentController\getBackendUser().

Referenced by EditDocumentController\getButtons().

getRecordForEdit	(	$table,
		$theUid
	)

Get record for editing.

Parameters

string	$table	Table name
int	$theUid	Record UID

Returns: array Returns record to edit, FALSE if none

Definition at line 1784 of file EditDocumentController.php.

References $GLOBALS, EditDocumentController\getBackendUser(), BackendUtility\getRecord(), and BackendUtility\getWorkspaceVersionOfRecord().

Referenced by EditDocumentController\fixWSversioningInEditConf().

getSignalSlotDispatcher ( )

protected

Get the SignalSlot dispatcher

Returns

Definition at line 421 of file EditDocumentController.php.

References EditDocumentController\$signalSlotDispatcher, and GeneralUtility\makeInstance().

Referenced by EditDocumentController\emitFunctionAfterSignal().

init ( )

Initialize the normal module operation

Returns: void

Definition at line 690 of file EditDocumentController.php.

References $GLOBALS, $lang, EditDocumentController\$retUrl, GeneralUtility\_GP(), EditDocumentController\editRegularContentFromId(), EditDocumentController\emitFunctionAfterSignal(), EditDocumentController\generatePreviewCode(), EditDocumentController\getBackendUser(), EditDocumentController\getLanguageService(), GeneralUtility\implodeArrayForUrl(), GeneralUtility\intExplode(), ExtensionManagementUtility\isLoaded(), GeneralUtility\makeInstance(), GeneralUtility\quoteJSvalue(), GeneralUtility\trimExplode(), and GeneralUtility\writeFileToTypo3tempDir().

Referenced by EditDocumentController\mainAction().

languageSwitch	(	$table,
		$uid,
		$pid = `null`
	)

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	Pid of the record

Definition at line 1533 of file EditDocumentController.php.

References $GLOBALS, $lang, BackendUtility\deleteClause(), EditDocumentController\getBackendUser(), EditDocumentController\getDatabaseConnection(), EditDocumentController\getLanguages(), EditDocumentController\getLanguageService(), BackendUtility\getLinkToDataHandlerAction(), BackendUtility\getLiveVersionOfRecord(), BackendUtility\getRecord(), and BackendUtility\versioningPlaceholderClause().

localizationRedirect ( $justLocalized )

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

Parameters

string $justLocalized String passed by GET &justLocalized=

Returns: void

Definition at line 1635 of file EditDocumentController.php.

References $GLOBALS, GeneralUtility\_GP(), BackendUtility\deleteClause(), EditDocumentController\getDatabaseConnection(), HttpUtility\redirect(), GeneralUtility\sanitizeLocalUrl(), and BackendUtility\versioningPlaceholderClause().

Referenced by EditDocumentController\preInit().

mainAction	(	ServerRequestInterface	$request,
		ResponseInterface	$response
	)

Injects the request object for the current request or subrequest

Parameters

ServerRequestInterface	$request	the current request
ResponseInterface	$response

Returns: ResponseInterface the response with the content

Definition at line 1968 of file EditDocumentController.php.

References $response, EditDocumentController\doProcessData(), MessageInterface\getBody(), EditDocumentController\init(), BackendUtility\lockRecords(), and EditDocumentController\preInit().

openInNewWindowLink ( )

Creates open-in-window link

Definition at line 1494 of file EditDocumentController.php.

References ButtonBar\BUTTON_POSITION_RIGHT, EditDocumentController\getLanguageService(), GeneralUtility\linkThisScript(), GeneralUtility\quoteJSvalue(), and Icon\SIZE_SMALL.

Referenced by EditDocumentController\getButtons().

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

Referenced by EditDocumentController\generatePreviewCode().

preInit ( )

First initialization.

Returns: void

Definition at line 444 of file EditDocumentController.php.

Referenced by EditDocumentController\mainAction().

printContent ( )

Outputting the accumulated content to screen

Returns: void

Deprecated:: since TYPO3 CMS 7, will be removed in TYPO3 CMS 8

Definition at line 1018 of file EditDocumentController.php.

References EditDocumentController\$content, and GeneralUtility\logDeprecatedFunction().

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

Redirects to the document pointed to by $currentDocFromHandlerMD5 OR $retUrl (depending on some internal calculations). Most likely you will get a header-location redirect from this function.

Parameters