"TYPO3 4.0.1: SC_alt_doc Class Reference", "datetime" => "Sat Dec 2 19:25:27 2006", "date" => "2 Dec 2006", "doxygenversion" => "1.4.6", "projectname" => "TYPO3 4.0.1", "projectnumber" => "4.0.1" ); get_header($doxygen_vars); ?>

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, $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')

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
 $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

Detailed Description

Definition at line 105 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 1416 of file alt_doc.php.

References t3lib_div::locationHeaderUrl().

Referenced by preInit(), and processData().

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

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.
string Language selector HTML for localization
Returns:
string Composite HTML

Definition at line 918 of file alt_doc.php.

SC_alt_doc::compileStoreDat (   ) 
 

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

Returns:
void
See also:
makeDocSel()

Definition at line 1390 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 241 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 1362 of file alt_doc.php.

References t3lib_BEfunc::deleteClause(), t3lib_extMgm::isLoaded(), and t3lib_BEfunc::versioningPlaceholderClause().

Referenced by init().

SC_alt_doc::fixWSversioningInEditConf (  $  mapArray = FALSE  ) 
 

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

Parameters:
array Mapping between old and new ids if auto-versioning has been performed.
Returns:
void

Definition at line 1279 of file alt_doc.php.

References t3lib_div::trimExplode().

Referenced by preInit(), and processData().

SC_alt_doc::functionMenus (   ) 
 

Create the checkbox buttons in the bottom of the pages.

Returns:
string HTML for function menus.

Definition at line 986 of file alt_doc.php.

References t3lib_div::implodeArrayForUrl().

SC_alt_doc::getLanguages (  $  id  ) 
 

Returns sys_language records.

Parameters:
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)
Returns:
array Language records including faked record for default language

Definition at line 1217 of file alt_doc.php.

References t3lib_BEfunc::getModTSconfig().

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 1403 of file alt_doc.php.

Referenced by processData().

SC_alt_doc::getRecordForEdit (  $  table,
$  theUid
) 
 

Get record for editing.

Parameters:
string Table name
integer Record UID
Returns:
array Returns record to edit, false if none

Definition at line 1328 of file alt_doc.php.

References t3lib_BEfunc::getRecord(), and t3lib_BEfunc::getWorkspaceVersionOfRecord().

SC_alt_doc::init (   ) 
 

Initialize the normal module operation

Returns:
void

Definition at line 379 of file alt_doc.php.

References t3lib_div::_GP(), editRegularContentFromId(), t3lib_BEfunc::getModuleData(), t3lib_div::implodeArrayForUrl(), and t3lib_div::makeInstance().

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.

Parameters:
string Table name
integer uid for which to create a new language
integer pid of the record
Returns:
string <select> HTML element (if there were items for the box anyways...)

Definition at line 1087 of file alt_doc.php.

References t3lib_BEfunc::deleteClause(), and t3lib_BEfunc::versioningPlaceholderClause().

SC_alt_doc::localizationRedirect (  $  justLocalized  ) 
 

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

Parameters:
string String passed by GET &justLocalized=
Returns:
void

Definition at line 1183 of file alt_doc.php.

References t3lib_div::_GP(), t3lib_BEfunc::deleteClause(), t3lib_div::locationHeaderUrl(), and t3lib_BEfunc::versioningPlaceholderClause().

Referenced by preInit().

SC_alt_doc::main (   ) 
 

Main module operation

Returns:
void

Definition at line 473 of file alt_doc.php.

References t3lib_BEfunc::cshItem(), t3lib_BEfunc::getModTSconfig(), t3lib_div::inList(), and t3lib_div::makeInstance().

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 775 of file alt_doc.php.

References t3lib_extMgm::isLoaded(), 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 896 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 854 of file alt_doc.php.

References t3lib_BEfunc::cshItem(), and t3lib_div::htmlspecialchars_decode().

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 587 of file alt_doc.php.

References t3lib_BEfunc::fixVersioningPid(), t3lib_BEfunc::getRecord(), t3lib_BEfunc::getRecordTitle(), t3lib_BEfunc::isRecordLocked(), t3lib_div::makeInstance(), and t3lib_div::trimExplode().

SC_alt_doc::preInit (   ) 
 

First initialization.

Returns:
void

Definition at line 179 of file alt_doc.php.

References t3lib_div::_GET(), t3lib_div::_GP(), closeDocument(), compileStoreDat(), fixWSversioningInEditConf(), t3lib_div::getIndpEnv(), localizationRedirect(), and setDocument().

SC_alt_doc::printContent (   ) 
 

Outputting the accumulated content to screen

Returns:
void

Definition at line 551 of file alt_doc.php.

SC_alt_doc::processData (   ) 
 

Do processing of data, submitting it to TCEmain.

Returns:
void

Definition at line 251 of file alt_doc.php.

References t3lib_div::_GP(), closeDocument(), compileStoreDat(), fixWSversioningInEditConf(), t3lib_div::getIndpEnv(), getNewIconMode(), t3lib_BEfunc::getRecord(), t3lib_BEfunc::getSetUpdateSignal(), t3lib_BEfunc::getWorkspaceVersionOfRecord(), t3lib_div::implodeArrayForUrl(), and t3lib_div::makeInstance().

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 1448 of file alt_doc.php.

References 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 1017 of file alt_doc.php.

References t3lib_div::linkThisScript().

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 1048 of file alt_doc.php.

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