TYPO3 CMS  TYPO3_7-6
TYPO3\CMS\Backend\Controller\EditDocumentController Class Reference
Inheritance diagram for TYPO3\CMS\Backend\Controller\EditDocumentController:
TYPO3\CMS\Backend\Module\AbstractModule

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 ($mode=self::DOCUMENT_CLOSE_MODE_DEFAULT)
 
 setDocument ($currentDocFromHandlerMD5='', $retUrl='')
 
 mainAction (ServerRequestInterface $request, ResponseInterface $response)
 
- Public Member Functions inherited from TYPO3\CMS\Backend\Module\AbstractModule
 __construct ()
 
 processRequest (ServerRequestInterface $request, ResponseInterface $response)
 

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
 
 $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 TYPO3\CMS\Backend\Module\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 47 of file EditDocumentController.php.

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ closeDocument()

TYPO3\CMS\Backend\Controller\EditDocumentController::closeDocument (   $mode = self::DOCUMENT_CLOSE_MODE_DEFAULT)

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$modethe close mode: one of self::DOCUMENT_CLOSE_MODE_*
Returns
void

Definition at line 1932 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Controller\EditDocumentController\$storeUrlMd5, TYPO3\CMS\Backend\Controller\EditDocumentController\getBackendUser(), TYPO3\CMS\Core\Utility\HttpUtility\redirect(), TYPO3\CMS\Backend\Controller\EditDocumentController\setDocument(), and TYPO3\CMS\Backend\Utility\BackendUtility\setUpdateSignal().

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

◆ compileForm()

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

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

Parameters
string$editFormHTML form.
Returns
string Composite HTML

Definition at line 1471 of file EditDocumentController.php.

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

◆ compileStoreDat()

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

◆ doProcessData()

◆ editRegularContentFromId()

TYPO3\CMS\Backend\Controller\EditDocumentController::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 1868 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\deleteClause(), TYPO3\CMS\Backend\Controller\EditDocumentController\getDatabaseConnection(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3\CMS\Backend\Utility\BackendUtility\versioningPlaceholderClause().

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

◆ emitFunctionAfterSignal()

TYPO3\CMS\Backend\Controller\EditDocumentController::emitFunctionAfterSignal (   $signalName)
protected

◆ fixWSversioningInEditConf()

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

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

Parameters
array | bool$mapArrayMapping between old and new ids if auto-versioning has been performed.
Returns
void

Definition at line 1773 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\doProcessData(), and TYPO3\CMS\Backend\Controller\EditDocumentController\preInit().

◆ generatePreviewCode()

◆ getBackendUser()

◆ getButtons()

◆ getDatabaseConnection()

◆ getLanguages()

TYPO3\CMS\Backend\Controller\EditDocumentController::getLanguages (   $id)

Returns sys_language records 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 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 1704 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\deleteClause(), TYPO3\CMS\Backend\Controller\EditDocumentController\getBackendUser(), TYPO3\CMS\Backend\Controller\EditDocumentController\getDatabaseConnection(), TYPO3\CMS\Backend\Controller\EditDocumentController\getLanguageService(), and TYPO3\CMS\Backend\Utility\BackendUtility\getModTSconfig().

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

◆ getLanguageService()

◆ getNewIconMode()

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$tableThe table for which the configuration may be specific
string$keyThe 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 1914 of file EditDocumentController.php.

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

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

◆ getRecordForEdit()

TYPO3\CMS\Backend\Controller\EditDocumentController::getRecordForEdit (   $table,
  $theUid 
)

◆ getSignalSlotDispatcher()

TYPO3\CMS\Backend\Controller\EditDocumentController::getSignalSlotDispatcher ( )
protected

◆ init()

◆ languageSwitch()

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

◆ localizationRedirect()

TYPO3\CMS\Backend\Controller\EditDocumentController::localizationRedirect (   $justLocalized)

◆ mainAction()

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

Injects the request object for the current request or subrequest

Parameters
ServerRequestInterface$requestthe current request
ResponseInterface$response
Returns
ResponseInterface the response with the content

Definition at line 2012 of file EditDocumentController.php.

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

◆ openInNewWindowLink()

◆ parseAdditionalGetParameters()

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

◆ preInit()

◆ printContent()

◆ setDocument()

TYPO3\CMS\Backend\Controller\EditDocumentController::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
string$currentDocFromHandlerMD5Pointer to the document in the docHandler array
string$retUrlAlternative/Default retUrl
Returns
void

Definition at line 1983 of file EditDocumentController.php.

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

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

◆ shortCutLink()

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

Member Data Documentation

◆ $cacheCmd

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

Definition at line 134 of file EditDocumentController.php.

◆ $closeDoc

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

Definition at line 101 of file EditDocumentController.php.

◆ $cmd

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

◆ $columnsOnly

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

◆ $content

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

◆ $data

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

Definition at line 117 of file EditDocumentController.php.

◆ $defVals

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

Definition at line 78 of file EditDocumentController.php.

◆ $doc

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

Definition at line 232 of file EditDocumentController.php.

◆ $docDat

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

Definition at line 326 of file EditDocumentController.php.

◆ $docHandler

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

Definition at line 336 of file EditDocumentController.php.

◆ $dontStoreDocumentRef

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

Definition at line 398 of file EditDocumentController.php.

◆ $doSave

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

Definition at line 110 of file EditDocumentController.php.

◆ $editconf

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

◆ $editRegularContentFromId

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

Definition at line 191 of file EditDocumentController.php.

◆ $elementsData

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

Definition at line 343 of file EditDocumentController.php.

◆ $errorC

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

Definition at line 357 of file EditDocumentController.php.

◆ $firstEl

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

◆ $formResultCompiler

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

Definition at line 391 of file EditDocumentController.php.

◆ $MCONF

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

Definition at line 284 of file EditDocumentController.php.

◆ $mirror

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

Definition at line 127 of file EditDocumentController.php.

◆ $modTSconfig

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

Definition at line 386 of file EditDocumentController.php.

◆ $newC

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

Definition at line 364 of file EditDocumentController.php.

◆ $noView

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

Definition at line 205 of file EditDocumentController.php.

◆ $overrideVals

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

◆ $pageinfo

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

Definition at line 289 of file EditDocumentController.php.

◆ $perms_clause

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

Definition at line 210 of file EditDocumentController.php.

◆ $popViewId

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

Definition at line 168 of file EditDocumentController.php.

◆ $popViewId_addParams

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

Definition at line 175 of file EditDocumentController.php.

◆ $previewData

TYPO3\CMS\Backend\Controller\EditDocumentController::$previewData = []
protected

Definition at line 410 of file EditDocumentController.php.

◆ $R_URI

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

Definition at line 279 of file EditDocumentController.php.

◆ $R_URL_getvars

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

Definition at line 272 of file EditDocumentController.php.

◆ $R_URL_parts

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

Definition at line 264 of file EditDocumentController.php.

◆ $recTitle

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

Definition at line 198 of file EditDocumentController.php.

◆ $redirect

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

Definition at line 141 of file EditDocumentController.php.

◆ $retUrl

◆ $returnEditConf

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

Definition at line 218 of file EditDocumentController.php.

◆ $returnNewPageId

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

Definition at line 149 of file EditDocumentController.php.

◆ $returnUrl

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

◆ $signalSlotDispatcher

TYPO3\CMS\Backend\Controller\EditDocumentController::$signalSlotDispatcher
protected

◆ $storeArray

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

◆ $storeTitle

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

◆ $storeUrl

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

◆ $storeUrlMd5

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

◆ $template

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

Definition at line 239 of file EditDocumentController.php.

◆ $uc

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

Definition at line 161 of file EditDocumentController.php.

◆ $vC

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

Definition at line 154 of file EditDocumentController.php.

◆ $viewId

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

Definition at line 372 of file EditDocumentController.php.

◆ $viewId_addParams

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

Definition at line 379 of file EditDocumentController.php.

◆ $viewUrl

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

Definition at line 182 of file EditDocumentController.php.

◆ $workspace

TYPO3\CMS\Backend\Controller\EditDocumentController::$workspace
protected

Definition at line 225 of file EditDocumentController.php.

◆ DOCUMENT_CLOSE_MODE_CLEAR_ALL

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

Definition at line 51 of file EditDocumentController.php.

◆ DOCUMENT_CLOSE_MODE_DEFAULT

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

Definition at line 49 of file EditDocumentController.php.

◆ DOCUMENT_CLOSE_MODE_NO_REDIRECT

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

Definition at line 52 of file EditDocumentController.php.

◆ DOCUMENT_CLOSE_MODE_REDIRECT

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

Definition at line 50 of file EditDocumentController.php.