SC_alt_doc Class Reference

List of all members.

Public Member Functions

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

Public Attributes

 $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

Protected Member Functions

 getButtons ()

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

References exit, t3lib_div::locationHeaderUrl(), setDocument(), and t3lib_BEfunc::setUpdateSignal().

Referenced by preInit(), and processData().

SC_alt_doc::compileForm ( editForm  ) 

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

Parameters:
string HTML form.
Returns:
string Composite HTML

Definition at line 934 of file alt_doc.php.

Referenced by main().

SC_alt_doc::compileStoreDat (  ) 

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

Returns:
void
See also:
makeDocSel()

Definition at line 1352 of file alt_doc.php.

References t3lib_div::compileSelectedGetVarsFromArray(), editRegularContentFromId(), 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 255 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 1324 of file alt_doc.php.

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

Referenced by compileStoreDat(), init(), main(), and shortCutLink().

SC_alt_doc::extraFormHeaders (  ) 

Compiles the extra form headers if the tceforms

Returns:
string the HTML

Definition at line 917 of file alt_doc.php.

References t3lib_parsehtml::getSubpart(), and t3lib_parsehtml::substituteMarker().

Referenced by main().

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

References $TCA, getRecordForEdit(), and 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 965 of file alt_doc.php.

References t3lib_div::implodeArrayForUrl().

Referenced by main().

SC_alt_doc::getButtons (  )  [protected]

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

Returns:
array all available buttons as an assoc. array

Definition at line 807 of file alt_doc.php.

References $GLOBALS, $TCA, t3lib_BEfunc::cshItem(), getNewIconMode(), t3lib_extMgm::isLoaded(), openInNewWindowLink(), shortCutLink(), and t3lib_div::testInt().

Referenced by main().

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

References $GLOBALS, $row, and t3lib_BEfunc::getModTSconfig().

Referenced by languageSwitch().

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

References $GLOBALS, and $key.

Referenced by getButtons(), and 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 1290 of file alt_doc.php.

References $GLOBALS, $TCA, t3lib_BEfunc::getRecord(), and t3lib_BEfunc::getWorkspaceVersionOfRecord().

Referenced by fixWSversioningInEditConf().

SC_alt_doc::init (  ) 

Initialize the normal module operation

Returns:
void

Definition at line 418 of file alt_doc.php.

References $BACK_PATH, $GLOBALS, t3lib_div::_GP(), t3lib_BEfunc::BEgetRootLine(), editRegularContentFromId(), t3lib_BEfunc::getModuleData(), t3lib_div::implodeArrayForUrl(), and t3lib_BEfunc::viewOnClick().

SC_alt_doc::langSelector (  ) 

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

Definition at line 903 of file alt_doc.php.

References languageSwitch().

Referenced by main().

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

References $content, $GLOBALS, $pid, $row, $TCA, t3lib_BEfunc::deleteClause(), getLanguages(), and t3lib_BEfunc::versioningPlaceholderClause().

Referenced by langSelector().

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

References $GLOBALS, $returnUrl, $TCA, t3lib_div::_GP(), t3lib_BEfunc::deleteClause(), exit, t3lib_div::locationHeaderUrl(), and t3lib_BEfunc::versioningPlaceholderClause().

Referenced by preInit().

SC_alt_doc::main (  ) 

Main module operation

Returns:
void

Definition at line 507 of file alt_doc.php.

References compileForm(), editRegularContentFromId(), extraFormHeaders(), functionMenus(), getButtons(), t3lib_BEfunc::getModTSconfig(), t3lib_div::inList(), langSelector(), makeEditForm(), t3lib_div::makeInstance(), t3lib_BEfunc::readPageAccess(), t3lib_BEfunc::setUpdateSignal(), and tceformMessages().

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

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

Referenced by main().

SC_alt_doc::openInNewWindowLink (  ) 

Creates open-in-window link

Returns:
string

Definition at line 995 of file alt_doc.php.

References t3lib_div::linkThisScript().

Referenced by getButtons().

SC_alt_doc::preInit (  ) 

First initialization.

Returns:
void

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

SC_alt_doc::processData (  ) 

Do processing of data, submitting it to TCEmain.

Returns:
void

Definition at line 266 of file alt_doc.php.

References $GLOBALS, $key, $TYPO3_CONF_VARS, t3lib_div::_GP(), closeDocument(), compileStoreDat(), debug(), fixWSversioningInEditConf(), t3lib_div::getIndpEnv(), getNewIconMode(), t3lib_BEfunc::getRecord(), t3lib_BEfunc::getWorkspaceVersionOfRecord(), t3lib_div::implodeArrayForUrl(), t3lib_div::makeInstance(), t3lib_BEfunc::setUpdateSignal(), and t3lib_TCEforms_inline::updateInlineView().

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

References $retUrl, exit, t3lib_div::getIndpEnv(), t3lib_extMgm::isLoaded(), and t3lib_div::locationHeaderUrl().

Referenced by closeDocument(), and preInit().

SC_alt_doc::shortCutLink (  ) 

Create shortcut icon

Returns:
string

Definition at line 980 of file alt_doc.php.

References editRegularContentFromId().

Referenced by getButtons().

SC_alt_doc::tceformMessages (  ) 

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

Returns:
void

Definition at line 1011 of file alt_doc.php.

Referenced by main().


Member Data Documentation

SC_alt_doc::$cacheCmd

Definition at line 118 of file alt_doc.php.

SC_alt_doc::$closeDoc

Definition at line 113 of file alt_doc.php.

SC_alt_doc::$columnsOnly

Definition at line 109 of file alt_doc.php.

SC_alt_doc::$content

Definition at line 143 of file alt_doc.php.

Referenced by languageSwitch().

SC_alt_doc::$data

Definition at line 116 of file alt_doc.php.

SC_alt_doc::$defVals

Definition at line 110 of file alt_doc.php.

SC_alt_doc::$disHelp

Definition at line 129 of file alt_doc.php.

SC_alt_doc::$doc

Definition at line 141 of file alt_doc.php.

SC_alt_doc::$docDat

Definition at line 155 of file alt_doc.php.

SC_alt_doc::$docHandler

Definition at line 156 of file alt_doc.php.

SC_alt_doc::$dontStoreDocumentRef

Definition at line 178 of file alt_doc.php.

SC_alt_doc::$doSave

Definition at line 114 of file alt_doc.php.

SC_alt_doc::$editconf

Definition at line 108 of file alt_doc.php.

SC_alt_doc::$editRegularContentFromId

Definition at line 127 of file alt_doc.php.

SC_alt_doc::$elementsData

Definition at line 160 of file alt_doc.php.

SC_alt_doc::$errorC

Definition at line 162 of file alt_doc.php.

SC_alt_doc::$firstEl

Definition at line 161 of file alt_doc.php.

SC_alt_doc::$generalPathOfForm

Definition at line 174 of file alt_doc.php.

SC_alt_doc::$localizationMode

Definition at line 132 of file alt_doc.php.

SC_alt_doc::$mirror

Definition at line 117 of file alt_doc.php.

SC_alt_doc::$modTSconfig

Definition at line 166 of file alt_doc.php.

SC_alt_doc::$newC

Definition at line 163 of file alt_doc.php.

SC_alt_doc::$noView

Definition at line 130 of file alt_doc.php.

SC_alt_doc::$overrideVals

Definition at line 111 of file alt_doc.php.

SC_alt_doc::$popViewId

Definition at line 124 of file alt_doc.php.

SC_alt_doc::$popViewId_addParams

Definition at line 125 of file alt_doc.php.

SC_alt_doc::$R_URI

Definition at line 148 of file alt_doc.php.

SC_alt_doc::$R_URL_getvars

Definition at line 147 of file alt_doc.php.

SC_alt_doc::$R_URL_parts

Definition at line 146 of file alt_doc.php.

SC_alt_doc::$recTitle

Definition at line 128 of file alt_doc.php.

SC_alt_doc::$redirect

Definition at line 119 of file alt_doc.php.

SC_alt_doc::$retUrl

Definition at line 145 of file alt_doc.php.

Referenced by setDocument().

SC_alt_doc::$returnEditConf

Definition at line 131 of file alt_doc.php.

SC_alt_doc::$returnNewPageId

Definition at line 120 of file alt_doc.php.

SC_alt_doc::$returnUrl

Definition at line 112 of file alt_doc.php.

Referenced by localizationRedirect().

SC_alt_doc::$storeArray

Definition at line 151 of file alt_doc.php.

SC_alt_doc::$storeTitle

Definition at line 150 of file alt_doc.php.

SC_alt_doc::$storeUrl

Definition at line 152 of file alt_doc.php.

SC_alt_doc::$storeUrlMd5

Definition at line 153 of file alt_doc.php.

SC_alt_doc::$tceforms

Definition at line 173 of file alt_doc.php.

SC_alt_doc::$template

Definition at line 142 of file alt_doc.php.

SC_alt_doc::$uc

Definition at line 122 of file alt_doc.php.

SC_alt_doc::$vC

Definition at line 121 of file alt_doc.php.

SC_alt_doc::$viewId

Definition at line 164 of file alt_doc.php.

SC_alt_doc::$viewId_addParams

Definition at line 165 of file alt_doc.php.

SC_alt_doc::$viewUrl

Definition at line 126 of file alt_doc.php.


The documentation for this class was generated from the following file:
Generated on Sat Nov 29 04:23:32 2008 for TYPO3 API by  doxygen 1.4.7