SC_alt_doc Class Reference

List of all members.

Public Member Functions
	preInit ()
	doProcessData ()
	processData ()
	init ()
	main ()
	printContent ()
	makeEditForm ()
	makeButtonPanel ()
	makeDocSel ()
	makeCmenu ()
	compileForm ($panel, $docSel, $cMenu, $editForm)
	functionMenus ()
	shortCutLink ()
	tceformMessages ()
	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
	$disableRTE
	$returnNewPageId
	$vC
	$popViewId
	$popViewId_addParams
	$viewUrl
	$editRegularContentFromId
	$recTitle
	$disHelp
	$noView
	$returnEditConf
	$doc
	$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

---

Detailed Description

Definition at line 94 of file alt_doc.php.

---

Member Function Documentation

SC_alt_doc::closeDocument (  $  code = 0  )

Handling the closing of a document Parameters: integer  Close 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 Definition at line 1080 of file alt_doc.php. References exit, and t3lib_div::locationHeaderUrl(). Referenced by preInit(), and processData().

SC_alt_doc::compileForm (  $  panel, $  docSel, $  cMenu, $  editForm )

Put together the various elements (buttons, selectors, form) into a table Parameters: string  The button panel HTML string  Document selector HTML string  Clear-cache menu HTML string  HTML form. Returns: string Composite HTML Definition at line 865 of file alt_doc.php. References $LANG, colspan, height, img, input, nowrap, table, td, and value.

SC_alt_doc::compileStoreDat (   )

Populates the variables $this->storeArray, $this->storeUrl, $this->storeUrlMd5 Returns: void See also: makeDocSel() Definition at line 1054 of file alt_doc.php. References t3lib_div::compileSelectedGetVarsFromArray(), and t3lib_div::implodeArrayForUrl(). Referenced by preInit(), and processData().

SC_alt_doc::doProcessData (   )

Detects, if a save command has been triggered. Returns: boolean True, then save the document (data submitted) Definition at line 219 of file alt_doc.php.

SC_alt_doc::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 Definition at line 1027 of file alt_doc.php. References $GLOBALS, $res, t3lib_BEfunc::deleteClause(), and t3lib_extMgm::isLoaded(). Referenced by init().

SC_alt_doc::functionMenus (   )

Create the checkbox buttons in the bottom of the pages. Returns: string HTML for function menus. Definition at line 927 of file alt_doc.php. References $LANG, and t3lib_div::implodeArrayForUrl().

SC_alt_doc::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  The table for which the configuration may be specific string  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 1067 of file alt_doc.php. References table, and value.

SC_alt_doc::init (   )

Initialize the normal module operation Returns: void Definition at line 346 of file alt_doc.php. References $BACK_PATH, $LANG, t3lib_div::_GP(), editRegularContentFromId(), enctype, t3lib_BEfunc::getModuleData(), t3lib_div::implodeArrayForUrl(), t3lib_div::makeInstance(), and onsubmit.

SC_alt_doc::main (   )

Main module operation Returns: void Definition at line 438 of file alt_doc.php. References $LANG, t3lib_BEfunc::cshItem(), t3lib_BEfunc::getModTSconfig(), t3lib_div::makeInstance(), and margin.

SC_alt_doc::makeButtonPanel (   )

Create the panel of buttons for submitting the form or otherwise perform operations. Returns: string HTML code, comprised of images linked to various actions. Definition at line 723 of file alt_doc.php. References $GLOBALS, $LANG, $TCA, a, height, img, input, t3lib_extMgm::isLoaded(), onclick, table, and t3lib_div::testInt().

SC_alt_doc::makeCmenu (   )

Create the selector box form element which allows to select a clear-cache operation. Can be disabled through Page TSconfig. Returns: string HTML <select> element (if applicable) See also: template::clearCacheMenu() Definition at line 844 of file alt_doc.php. References t3lib_BEfunc::cshItem().

SC_alt_doc::makeDocSel (   )

Create the selector box form element which allows to select between open documents. Can be disabled through Page TSconfig. Returns: string HTML <select> element (if applicable) Definition at line 802 of file alt_doc.php. References $LANG, t3lib_BEfunc::cshItem(), t3lib_div::htmlspecialchars_decode(), select, selected, and value.

SC_alt_doc::makeEditForm (   )

Creates the editing form with TCEforms, based on the input from GPvars. Returns: string HTML form elements wrapped in tables Definition at line 541 of file alt_doc.php. References $LANG, $table, $TCA, t3lib_BEfunc::fixVersioningPid(), t3lib_BEfunc::getRecord(), t3lib_BEfunc::getRecordTitle(), height, img, input, t3lib_BEfunc::isRecordLocked(), t3lib_div::makeInstance(), pages, table, td, t3lib_div::trimExplode(), and value.

SC_alt_doc::preInit (   )

First initialization. Returns: void Definition at line 167 of file alt_doc.php. References t3lib_div::_GET(), t3lib_div::_GP(), closeDocument(), compileStoreDat(), t3lib_div::getIndpEnv(), and setDocument().

SC_alt_doc::printContent (   )

Outputting the accumulated content to screen Returns: void Definition at line 506 of file alt_doc.php.

SC_alt_doc::processData (   )

Do processing of data, submitting it to TCEmain. Returns: void Definition at line 229 of file alt_doc.php. References $TYPO3_CONF_VARS, t3lib_div::_GP(), closeDocument(), compileStoreDat(), debug(), t3lib_div::getIndpEnv(), t3lib_BEfunc::getRecord(), t3lib_BEfunc::getSetUpdateSignal(), t3lib_div::implodeArrayForUrl(), t3lib_div::makeInstance(), and pages.

SC_alt_doc::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  Pointer to the document in the docHandler array string  Alternative/Default retUrl Returns: void Definition at line 1112 of file alt_doc.php. References exit, t3lib_div::getIndpEnv(), t3lib_extMgm::isLoaded(), and t3lib_div::locationHeaderUrl(). Referenced by preInit().

SC_alt_doc::shortCutLink (   )

Create shortcut and open-in-window link in the bottom of the page Returns: string Definition at line 958 of file alt_doc.php. References $content, $LANG, a, height, img, t3lib_div::linkThisScript(), and onclick.

SC_alt_doc::tceformMessages (   )

Reads comment messages from TCEforms and prints them in a HTML comment in the buttom of the page. Returns: void Definition at line 989 of file alt_doc.php.

---

Member Data Documentation

SC_alt_doc::$cacheCmd

Definition at line 107 of file alt_doc.php.

SC_alt_doc::$closeDoc

Definition at line 102 of file alt_doc.php.

SC_alt_doc::$columnsOnly

Definition at line 98 of file alt_doc.php.

SC_alt_doc::$content

Definition at line 125 of file alt_doc.php.

SC_alt_doc::$data

Definition at line 105 of file alt_doc.php.

SC_alt_doc::$defVals

Definition at line 99 of file alt_doc.php.

SC_alt_doc::$disableRTE

Definition at line 109 of file alt_doc.php.

SC_alt_doc::$disHelp

Definition at line 118 of file alt_doc.php.

SC_alt_doc::$doc

Definition at line 124 of file alt_doc.php.

SC_alt_doc::$docDat

Definition at line 137 of file alt_doc.php.

SC_alt_doc::$docHandler

Definition at line 138 of file alt_doc.php.

SC_alt_doc::$dontStoreDocumentRef

Definition at line 154 of file alt_doc.php.

SC_alt_doc::$doSave

Definition at line 103 of file alt_doc.php.

SC_alt_doc::$editconf

Definition at line 97 of file alt_doc.php.

SC_alt_doc::$editRegularContentFromId

Definition at line 116 of file alt_doc.php.

SC_alt_doc::$elementsData

Definition at line 142 of file alt_doc.php.

SC_alt_doc::$errorC

Definition at line 144 of file alt_doc.php.

SC_alt_doc::$firstEl

Definition at line 143 of file alt_doc.php.

SC_alt_doc::$generalPathOfForm

Definition at line 150 of file alt_doc.php.

SC_alt_doc::$mirror

Definition at line 106 of file alt_doc.php.

SC_alt_doc::$modTSconfig

Definition at line 148 of file alt_doc.php.

SC_alt_doc::$newC

Definition at line 145 of file alt_doc.php.

SC_alt_doc::$noView

Definition at line 119 of file alt_doc.php.

SC_alt_doc::$overrideVals

Definition at line 100 of file alt_doc.php.

SC_alt_doc::$popViewId

Definition at line 113 of file alt_doc.php.

SC_alt_doc::$popViewId_addParams

Definition at line 114 of file alt_doc.php.

SC_alt_doc::$R_URI

Definition at line 130 of file alt_doc.php.

SC_alt_doc::$R_URL_getvars

Definition at line 129 of file alt_doc.php.

SC_alt_doc::$R_URL_parts

Definition at line 128 of file alt_doc.php.

SC_alt_doc::$recTitle

Definition at line 117 of file alt_doc.php.

SC_alt_doc::$redirect

Definition at line 108 of file alt_doc.php.

SC_alt_doc::$retUrl

Definition at line 127 of file alt_doc.php.

SC_alt_doc::$returnEditConf

Definition at line 120 of file alt_doc.php.

SC_alt_doc::$returnNewPageId

Definition at line 110 of file alt_doc.php.

SC_alt_doc::$returnUrl

Definition at line 101 of file alt_doc.php.

SC_alt_doc::$storeArray

Definition at line 133 of file alt_doc.php.

SC_alt_doc::$storeTitle

Definition at line 132 of file alt_doc.php.

SC_alt_doc::$storeUrl

Definition at line 134 of file alt_doc.php.

SC_alt_doc::$storeUrlMd5

Definition at line 135 of file alt_doc.php.

SC_alt_doc::$tceforms

Definition at line 149 of file alt_doc.php.

SC_alt_doc::$vC

Definition at line 111 of file alt_doc.php.

SC_alt_doc::$viewId

Definition at line 146 of file alt_doc.php.

SC_alt_doc::$viewId_addParams

Definition at line 147 of file alt_doc.php.

SC_alt_doc::$viewUrl

Definition at line 115 of file alt_doc.php.

---

The documentation for this class was generated from the following file:

• typo3/alt_doc.php

---