TYPO3 CMS  TYPO3_6-2
TYPO3\CMS\Backend\Controller\EditDocumentController Class Reference
Inheritance diagram for TYPO3\CMS\Backend\Controller\EditDocumentController:
SC_alt_doc

Public Member Functions

 __construct ()
 
 preInit ()
 
 doProcessData ()
 
 init ()
 
 main ()
 
 printContent ()
 
 langSelector ()
 
 extraFormHeaders ()
 
 compileForm ($editForm)
 
 functionMenus ()
 
 shortCutLink ()
 
 openInNewWindowLink ()
 
 tceformMessages ()
 
 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='alt_doc_nodoc.php')
 

Public Attributes

 $editconf
 
 $columnsOnly
 
 $defVals
 
 $overrideVals
 
 $returnUrl
 
 $closeDoc
 
 $doSave
 
 $data
 
 $mirror
 
 $cacheCmd
 
 $redirect
 
 $returnNewPageId
 
 $vC
 
 $uc
 
 $popViewId
 
 $popViewId_addParams
 
 $viewUrl
 
 $editRegularContentFromId
 
 $recTitle
 
 $disHelp
 
 $noView
 
 $returnEditConf
 
 $localizationMode
 
 $doc
 
 $template
 
 $content
 
 $retUrl
 
 $R_URL_parts
 
 $R_URL_getvars
 
 $R_URI
 
 $storeTitle
 
 $storeArray
 
 $storeUrl
 
 $storeUrlMd5
 
 $docDat
 
 $docHandler
 
 $elementsData
 
 $firstEl
 
 $errorC
 
 $newC
 
 $viewId
 
 $viewId_addParams
 
 $modTSconfig
 
 $tceforms
 
 $generalPathOfForm
 
 $dontStoreDocumentRef
 

Protected Member Functions

 getSignalSlotDispatcher ()
 
 emitFunctionAfterSignal ($signalName)
 
 getButtons ()
 
 getBackendUser ()
 

Protected Attributes

 $workspace
 
 $signalSlotDispatcher
 

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

Author
Kasper Skårhøj kaspe.nosp@m.rYYY.nosp@m.Y@typ.nosp@m.o3.c.nosp@m.om

Definition at line 32 of file EditDocumentController.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor

Definition at line 356 of file EditDocumentController.php.

References $GLOBALS.

Member Function Documentation

◆ closeDocument()

TYPO3\CMS\Backend\Controller\EditDocumentController::closeDocument (   $code = 0)

Handling the closing of a document

Parameters
integer$codeClose code: 0/1 will redirect to $this->retUrl, 3 will clear the docHandler (thus closing all documents) and otehr values will call setDocument with ->retUrl
Returns
void
Todo:
Define visibility

Definition at line 1434 of file EditDocumentController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\EditDocumentController\$storeUrlMd5, 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
Todo:
Define visibility

Definition at line 1067 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

Returns
void
See also
makeDocSel()
Todo:
Define visibility

Definition at line 1407 of file EditDocumentController.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\compileSelectedGetVarsFromArray(), and TYPO3\CMS\Core\Utility\GeneralUtility\implodeArrayForUrl().

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

◆ 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
Todo:
Define visibility

Definition at line 1388 of file EditDocumentController.php.

References $GLOBALS, TYPO3\CMS\Backend\Utility\BackendUtility\deleteClause(), and TYPO3\CMS\Backend\Utility\BackendUtility\versioningPlaceholderClause().

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

◆ emitFunctionAfterSignal()

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

◆ extraFormHeaders()

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

Compiles the extra form headers if the tceforms

Returns
string The HTML
Todo:
Define visibility

Definition at line 1051 of file EditDocumentController.php.

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

◆ fixWSversioningInEditConf()

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

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

Parameters
array$mapArrayMapping between old and new ids if auto-versioning has been performed.
Returns
void
Todo:
Define visibility

Definition at line 1303 of file EditDocumentController.php.

References $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().

◆ functionMenus()

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

Create the checkbox buttons in the bottom of the pages.

Returns
string HTML for function menus.
Todo:
Define visibility

Definition at line 1095 of file EditDocumentController.php.

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

◆ getBackendUser()

TYPO3\CMS\Backend\Controller\EditDocumentController::getBackendUser ( )
protected
Returns

Definition at line 1500 of file EditDocumentController.php.

References $GLOBALS.

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

◆ getButtons()

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

◆ getLanguages()

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

Returns sys_language records available for record translations on given page.

Parameters
integer$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
Todo:
Define visibility

Definition at line 1262 of file EditDocumentController.php.

References $GLOBALS, TYPO3\CMS\Backend\Utility\BackendUtility\deleteClause(), and TYPO3\CMS\Backend\Utility\BackendUtility\getModTSconfig().

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

◆ 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
Todo:
Define visibility

Definition at line 1421 of file EditDocumentController.php.

References $GLOBALS.

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

◆ getRecordForEdit()

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

Get record for editing.

Parameters
string$tableTable name
integer$theUidRecord UID
Returns
array Returns record to edit, FALSE if none
Todo:
Define visibility

Definition at line 1350 of file EditDocumentController.php.

References $GLOBALS, and TYPO3\CMS\Backend\Utility\BackendUtility\getWorkspaceVersionOfRecord().

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

◆ getSignalSlotDispatcher()

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

◆ init()

◆ langSelector()

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

Returns the language switch/selector for editing, show only when a single record is edited

  • multiple records are too confusing
Returns
string The HTML
Todo:
Define visibility

Definition at line 1037 of file EditDocumentController.php.

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

◆ languageSwitch()

TYPO3\CMS\Backend\Controller\EditDocumentController::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$tableTable name
integer$uidUid for which to create a new language
integer$pidPid of the record
Returns
string <select> HTML element (if there were items for the box anyways...)
Todo:
Define visibility

Definition at line 1165 of file EditDocumentController.php.

References TYPO3\CMS\Backend\Controller\EditDocumentController\$content, $GLOBALS, $uid, TYPO3\CMS\Backend\Utility\BackendUtility\deleteClause(), TYPO3\CMS\Backend\Controller\EditDocumentController\getLanguages(), TYPO3\CMS\Backend\Utility\BackendUtility\getLiveVersionOfRecord(), TYPO3\CMS\Backend\Utility\BackendUtility\getUrlToken(), and TYPO3\CMS\Backend\Utility\BackendUtility\versioningPlaceholderClause().

◆ localizationRedirect()

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

◆ main()

◆ openInNewWindowLink()

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

Creates open-in-window link

Returns
string
Todo:
Define visibility

Definition at line 1125 of file EditDocumentController.php.

◆ preInit()

◆ printContent()

◆ setDocument()

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

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
Todo:
Define visibility

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

Create shortcut icon

Returns
string
Todo:
Define visibility

Definition at line 1112 of file EditDocumentController.php.

◆ tceformMessages()

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

Reads comment messages from TCEforms and prints them in a HTML comment in the bottom of the page.

Returns
void
Todo:
Define visibility

Definition at line 1139 of file EditDocumentController.php.

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

Member Data Documentation

◆ $cacheCmd

TYPO3\CMS\Backend\Controller\EditDocumentController::$cacheCmd
Todo:
Define visibility

Definition at line 102 of file EditDocumentController.php.

◆ $closeDoc

TYPO3\CMS\Backend\Controller\EditDocumentController::$closeDoc
Todo:
Define visibility

Definition at line 76 of file EditDocumentController.php.

◆ $columnsOnly

TYPO3\CMS\Backend\Controller\EditDocumentController::$columnsOnly
Todo:
Define visibility

Definition at line 49 of file EditDocumentController.php.

◆ $content

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

◆ $data

TYPO3\CMS\Backend\Controller\EditDocumentController::$data
Todo:
Define visibility

Definition at line 90 of file EditDocumentController.php.

◆ $defVals

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

◆ $disHelp

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

◆ $doc

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

Definition at line 199 of file EditDocumentController.php.

◆ $docDat

TYPO3\CMS\Backend\Controller\EditDocumentController::$docDat
Todo:
Define visibility

Definition at line 272 of file EditDocumentController.php.

◆ $docHandler

TYPO3\CMS\Backend\Controller\EditDocumentController::$docHandler
Todo:
Define visibility

Definition at line 281 of file EditDocumentController.php.

◆ $dontStoreDocumentRef

TYPO3\CMS\Backend\Controller\EditDocumentController::$dontStoreDocumentRef
Todo:
Define visibility

Definition at line 346 of file EditDocumentController.php.

◆ $doSave

TYPO3\CMS\Backend\Controller\EditDocumentController::$doSave
Todo:
Define visibility

Definition at line 84 of file EditDocumentController.php.

◆ $editconf

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

◆ $editRegularContentFromId

TYPO3\CMS\Backend\Controller\EditDocumentController::$editRegularContentFromId
Todo:
Define visibility

Definition at line 152 of file EditDocumentController.php.

◆ $elementsData

TYPO3\CMS\Backend\Controller\EditDocumentController::$elementsData
Todo:
Define visibility

Definition at line 288 of file EditDocumentController.php.

◆ $errorC

TYPO3\CMS\Backend\Controller\EditDocumentController::$errorC
Todo:
Define visibility

Definition at line 300 of file EditDocumentController.php.

◆ $firstEl

TYPO3\CMS\Backend\Controller\EditDocumentController::$firstEl
Todo:
Define visibility

Definition at line 294 of file EditDocumentController.php.

◆ $generalPathOfForm

TYPO3\CMS\Backend\Controller\EditDocumentController::$generalPathOfForm
Todo:
Define visibility

Definition at line 339 of file EditDocumentController.php.

◆ $localizationMode

TYPO3\CMS\Backend\Controller\EditDocumentController::$localizationMode
Todo:
Define visibility

Definition at line 183 of file EditDocumentController.php.

◆ $mirror

TYPO3\CMS\Backend\Controller\EditDocumentController::$mirror
Todo:
Define visibility

Definition at line 96 of file EditDocumentController.php.

◆ $modTSconfig

TYPO3\CMS\Backend\Controller\EditDocumentController::$modTSconfig
Todo:
Define visibility

Definition at line 325 of file EditDocumentController.php.

◆ $newC

TYPO3\CMS\Backend\Controller\EditDocumentController::$newC
Todo:
Define visibility

Definition at line 306 of file EditDocumentController.php.

◆ $noView

TYPO3\CMS\Backend\Controller\EditDocumentController::$noView
Todo:
Define visibility

Definition at line 170 of file EditDocumentController.php.

◆ $overrideVals

TYPO3\CMS\Backend\Controller\EditDocumentController::$overrideVals
Todo:
Define visibility

Definition at line 63 of file EditDocumentController.php.

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

◆ $popViewId

TYPO3\CMS\Backend\Controller\EditDocumentController::$popViewId
Todo:
Define visibility

Definition at line 133 of file EditDocumentController.php.

◆ $popViewId_addParams

TYPO3\CMS\Backend\Controller\EditDocumentController::$popViewId_addParams
Todo:
Define visibility

Definition at line 139 of file EditDocumentController.php.

◆ $R_URI

TYPO3\CMS\Backend\Controller\EditDocumentController::$R_URI
Todo:
Define visibility

Definition at line 240 of file EditDocumentController.php.

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

◆ $R_URL_getvars

TYPO3\CMS\Backend\Controller\EditDocumentController::$R_URL_getvars
Todo:
Define visibility

Definition at line 234 of file EditDocumentController.php.

◆ $R_URL_parts

TYPO3\CMS\Backend\Controller\EditDocumentController::$R_URL_parts
Todo:
Define visibility

Definition at line 227 of file EditDocumentController.php.

◆ $recTitle

TYPO3\CMS\Backend\Controller\EditDocumentController::$recTitle
Todo:
Define visibility

Definition at line 158 of file EditDocumentController.php.

◆ $redirect

TYPO3\CMS\Backend\Controller\EditDocumentController::$redirect
Todo:
Define visibility

Definition at line 108 of file EditDocumentController.php.

◆ $retUrl

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

◆ $returnEditConf

TYPO3\CMS\Backend\Controller\EditDocumentController::$returnEditConf
Todo:
Define visibility

Definition at line 177 of file EditDocumentController.php.

◆ $returnNewPageId

TYPO3\CMS\Backend\Controller\EditDocumentController::$returnNewPageId
Todo:
Define visibility

Definition at line 115 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
Todo:
Define visibility

Definition at line 254 of file EditDocumentController.php.

◆ $storeTitle

TYPO3\CMS\Backend\Controller\EditDocumentController::$storeTitle
Todo:
Define visibility

Definition at line 247 of file EditDocumentController.php.

◆ $storeUrl

TYPO3\CMS\Backend\Controller\EditDocumentController::$storeUrl
Todo:
Define visibility

Definition at line 260 of file EditDocumentController.php.

◆ $storeUrlMd5

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

◆ $tceforms

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

Definition at line 333 of file EditDocumentController.php.

◆ $template

TYPO3\CMS\Backend\Controller\EditDocumentController::$template
Todo:
Define visibility

Definition at line 205 of file EditDocumentController.php.

◆ $uc

TYPO3\CMS\Backend\Controller\EditDocumentController::$uc
Todo:
Define visibility

Definition at line 127 of file EditDocumentController.php.

◆ $vC

TYPO3\CMS\Backend\Controller\EditDocumentController::$vC
Todo:
Define visibility

Definition at line 121 of file EditDocumentController.php.

◆ $viewId

TYPO3\CMS\Backend\Controller\EditDocumentController::$viewId
Todo:
Define visibility

Definition at line 313 of file EditDocumentController.php.

◆ $viewId_addParams

TYPO3\CMS\Backend\Controller\EditDocumentController::$viewId_addParams
Todo:
Define visibility

Definition at line 319 of file EditDocumentController.php.

◆ $viewUrl

TYPO3\CMS\Backend\Controller\EditDocumentController::$viewUrl
Todo:
Define visibility

Definition at line 145 of file EditDocumentController.php.

◆ $workspace

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

Definition at line 190 of file EditDocumentController.php.