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

Detailed Description

Definition at line 105 of file alt_doc.php.

Member Function Documentation

SC_alt_doc::preInit (  ) 

First initialization.

Returns:
void

Definition at line 180 of file alt_doc.php.

SC_alt_doc::doProcessData (  ) 

Detects, if a save command has been triggered.

Returns:
boolean True, then save the document (data submitted)

Definition at line 243 of file alt_doc.php.

SC_alt_doc::processData (  ) 

Do processing of data, submitting it to TCEmain.

Returns:
void

Definition at line 253 of file alt_doc.php.

SC_alt_doc::init (  ) 

Initialize the normal module operation

Returns:
void

Definition at line 399 of file alt_doc.php.

SC_alt_doc::main (  ) 

Main module operation

Returns:
void

Definition at line 493 of file alt_doc.php.

SC_alt_doc::printContent (  ) 

Outputting the accumulated content to screen

Returns:
void

Definition at line 571 of file alt_doc.php.

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

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

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

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

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

SC_alt_doc::functionMenus (  ) 

Create the checkbox buttons in the bottom of the pages.

Returns:
string HTML for function menus.

Definition at line 1011 of file alt_doc.php.

SC_alt_doc::shortCutLink (  ) 

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

Returns:
string

Definition at line 1042 of file alt_doc.php.

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

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

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

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

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

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 1353 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 1387 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 1415 of file alt_doc.php.

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

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

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

The documentation for this class was generated from the following file:
This documentation has been generated automatically from TYPO3 source code using Doxygen and is provided as is by Cast Iron Coding as a courtesy to other TYPO3 developers and users. Please consider Cast Iron Coding — a full-service web development agency in Portland, Oregon specializing in TYPO3 extension development — for all of your TYPO3 development and consulting needs!