SC_alt_doc Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	preInit ()
	doProcessData ()
	processData ()
	init ()
	main ()
	printContent ()
	makeEditForm ()
	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')
Öffentliche Attribute
	$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
Geschützte Methoden
	getButtons ()

---

Dokumentation der Elementfunktionen

SC_alt_doc::closeDocument

(

$

code = 0

)

Handling the closing of a document

Parameter:

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

Rückgabe:

void

SC_alt_doc::compileForm

(

$

editForm

)

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

Parameter:

string

HTML form.

Rückgabe:

string Composite HTML

SC_alt_doc::compileStoreDat

(

)

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

Rückgabe:

void

Siehe auch:

makeDocSel()

SC_alt_doc::doProcessData

(

)

Detects, if a save command has been triggered.

Rückgabe:

boolean True, then save the document (data submitted)

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

Rückgabe:

void

SC_alt_doc::extraFormHeaders

(

)

Compiles the extra form headers if the tceforms

Rückgabe:

string the HTML

SC_alt_doc::fixWSversioningInEditConf

(

$

mapArray = FALSE

)

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

Parameter:

array

Mapping between old and new ids if auto-versioning has been performed.

Rückgabe:

void

SC_alt_doc::functionMenus

(

)

Create the checkbox buttons in the bottom of the pages.

Rückgabe:

string HTML for function menus.

SC_alt_doc::getButtons

(

)

[protected]

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

Rückgabe:

array all available buttons as an assoc. array

SC_alt_doc::getLanguages

(

$

id

)

Returns sys_language records.

Parameter:

integer

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)

Rückgabe:

array Language records including faked record for default language

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.

Parameter:

	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.

Rückgabe:

string Return value fetched from USER TSconfig

SC_alt_doc::getRecordForEdit	(	$	table,
		$	theUid
	)

Get record for editing.

Parameter:

	string	Table name
	integer	Record UID

Rückgabe:

array Returns record to edit, false if none

SC_alt_doc::init

(

)

Initialize the normal module operation

Rückgabe:

void

SC_alt_doc::langSelector

(

)

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

• multiple records are too confusing

  Rückgabe:

  string the HTML

SC_alt_doc::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.

Parameter:

	string	Table name
	integer	uid for which to create a new language
	integer	pid of the record

Rückgabe:

string <select> HTML element (if there were items for the box anyways...)

SC_alt_doc::localizationRedirect

(

$

justLocalized

)

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

Parameter:

string

String passed by GET &justLocalized=

Rückgabe:

void

SC_alt_doc::main

(

)

Main module operation

Rückgabe:

void

SC_alt_doc::makeEditForm

(

)

Creates the editing form with TCEforms, based on the input from GPvars.

Rückgabe:

string HTML form elements wrapped in tables

SC_alt_doc::openInNewWindowLink

(

)

Creates open-in-window link

Rückgabe:

string

SC_alt_doc::preInit

(

)

First initialization.

Rückgabe:

void

SC_alt_doc::printContent

(

)

Outputting the accumulated content to screen

Rückgabe:

void

SC_alt_doc::processData

(

)

Do processing of data, submitting it to TCEmain.

Rückgabe:

void

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.

Parameter:

	string	Pointer to the document in the docHandler array
	string	Alternative/Default retUrl

Rückgabe:

void

SC_alt_doc::shortCutLink

(

)

Create shortcut icon

Rückgabe:

string

SC_alt_doc::tceformMessages

(

)

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

Rückgabe:

void

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• /srv/www/vhosts/typo3.local/typo3_src-4.2.10/typo3/alt_doc.php