Solutions Open Source

Référence de la classe SC_alt_doc

Liste de tous les membres

Fonctions membres publiques
	preInit ()
	doProcessData ()
	processData ()
	init ()
	main ()
	printContent ()
	makeEditForm ()
	makeButtonPanel ()
	makeDocSel ()
	makeCmenu ()
	compileForm ($panel, $docSel, $cMenu, $editForm, $langSelector='')
	functionMenus ()
	shortCutLink ()
	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')
Attributs publics
	$editconf
	$columnsOnly
	$defVals
	$overrideVals
	$returnUrl
	$closeDoc
	$doSave
	$data
	$mirror
	$cacheCmd
	$redirect
	$disableRTE
	$returnNewPageId
	$vC
	$uc
	$popViewId
	$popViewId_addParams
	$viewUrl
	$editRegularContentFromId
	$recTitle
	$disHelp
	$noView
	$returnEditConf
	$localizationMode
	$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

---

Documentation des fonctions membres

SC_alt_doc::preInit

(

)

First initialization.

Renvoie:

void

SC_alt_doc::doProcessData

(

)

Detects, if a save command has been triggered.

Renvoie:

boolean True, then save the document (data submitted)

SC_alt_doc::processData

(

)

Do processing of data, submitting it to TCEmain.

Renvoie:

void

SC_alt_doc::init

(

)

Initialize the normal module operation

Renvoie:

void

SC_alt_doc::main

(

)

Main module operation

Renvoie:

void

SC_alt_doc::printContent

(

)

Outputting the accumulated content to screen

Renvoie:

void

SC_alt_doc::makeEditForm

(

)

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

Renvoie:

string HTML form elements wrapped in tables

SC_alt_doc::makeButtonPanel

(

)

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

Renvoie:

string HTML code, comprised of images linked to various actions.

SC_alt_doc::makeDocSel

(

)

Create the selector box form element which allows to select between open documents. Can be disabled through Page TSconfig.

Renvoie:

string HTML <select> element (if applicable)

SC_alt_doc::makeCmenu

(

)

Create the selector box form element which allows to select a clear-cache operation. Can be disabled through Page TSconfig.

Renvoie:

string HTML <select> element (if applicable)

Voir également:

template::clearCacheMenu()

SC_alt_doc::compileForm	(	$	panel,
		$	docSel,
		$	cMenu,
		$	editForm,
		$	langSelector = ''
	)

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

Paramètres:

	string	The button panel HTML
	string	Document selector HTML
	string	Clear-cache menu HTML
	string	HTML form.
	string	Language selector HTML for localization

Renvoie:

string Composite HTML

SC_alt_doc::functionMenus

(

)

Create the checkbox buttons in the bottom of the pages.

Renvoie:

string HTML for function menus.

SC_alt_doc::shortCutLink

(

)

Create shortcut and open-in-window link in the bottom of the page

Renvoie:

string

SC_alt_doc::tceformMessages

(

)

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

Renvoie:

void

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.

Paramètres:

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

Renvoie:

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

Paramètres:

string

String passed by GET &justLocalized=

Renvoie:

void

SC_alt_doc::getLanguages

(

$

id

)

Returns sys_language records.

Paramètres:

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)

Renvoie:

array Language records including faked record for default language

SC_alt_doc::fixWSversioningInEditConf

(

$

mapArray = FALSE

)

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

Paramètres:

array

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

Renvoie:

void

SC_alt_doc::getRecordForEdit	(	$	table,
		$	theUid
	)

Get record for editing.

Paramètres:

	string	Table name
	integer	Record UID

Renvoie:

array Returns record to edit, false if none

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

Renvoie:

void

SC_alt_doc::compileStoreDat

(

)

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

Renvoie:

void

Voir également:

makeDocSel()

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.

Paramètres:

	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.

Renvoie:

string Return value fetched from USER TSconfig

SC_alt_doc::closeDocument

(

$

code = 0

)

Handling the closing of a document

Paramètres:

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

Renvoie:

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.

Paramètres:

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

Renvoie:

void

---

Documentation des données membres

SC_alt_doc::$editconf

SC_alt_doc::$columnsOnly

SC_alt_doc::$defVals

SC_alt_doc::$overrideVals

SC_alt_doc::$returnUrl

SC_alt_doc::$closeDoc

SC_alt_doc::$doSave

SC_alt_doc::$data

SC_alt_doc::$mirror

SC_alt_doc::$cacheCmd

SC_alt_doc::$redirect

SC_alt_doc::$disableRTE

SC_alt_doc::$returnNewPageId

SC_alt_doc::$vC

SC_alt_doc::$uc

SC_alt_doc::$popViewId

SC_alt_doc::$popViewId_addParams

SC_alt_doc::$viewUrl

SC_alt_doc::$editRegularContentFromId

SC_alt_doc::$recTitle

SC_alt_doc::$disHelp

SC_alt_doc::$noView

SC_alt_doc::$returnEditConf

SC_alt_doc::$localizationMode

SC_alt_doc::$doc

SC_alt_doc::$content

SC_alt_doc::$retUrl

SC_alt_doc::$R_URL_parts

SC_alt_doc::$R_URL_getvars

SC_alt_doc::$R_URI

SC_alt_doc::$storeTitle

SC_alt_doc::$storeArray

SC_alt_doc::$storeUrl

SC_alt_doc::$storeUrlMd5

SC_alt_doc::$docDat

SC_alt_doc::$docHandler

SC_alt_doc::$elementsData

SC_alt_doc::$firstEl

SC_alt_doc::$errorC

SC_alt_doc::$newC

SC_alt_doc::$viewId

SC_alt_doc::$viewId_addParams

SC_alt_doc::$modTSconfig

SC_alt_doc::$tceforms

SC_alt_doc::$generalPathOfForm

SC_alt_doc::$dontStoreDocumentRef

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Z:/doxygen/typo3_src-4.1.2/typo3/alt_doc.php

---