TYPO3 API  SVNRelease
Public Member Functions | Public Attributes | Protected Member Functions
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 98 of file alt_doc.php.

Member Function Documentation

SC_alt_doc::closeDocument ( $  code = 0)

Handling the closing of a document

Parameters:
integerClose 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 1411 of file alt_doc.php.

References $BE_USER, t3lib_utility_Http\redirect(), 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:
stringHTML form.
Returns:
string Composite HTML

Definition at line 951 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 1386 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 248 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 1358 of file alt_doc.php.

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

Referenced by init(), and main().

SC_alt_doc::extraFormHeaders ( )

Compiles the extra form headers if the tceforms

Returns:
string the HTML

Definition at line 934 of file alt_doc.php.

Referenced by main().

SC_alt_doc::fixWSversioningInEditConf ( $  mapArray = FALSE)

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

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

Definition at line 1275 of file alt_doc.php.

References $BE_USER, $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 982 of file alt_doc.php.

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

References $GLOBALS, $TCA, getNewIconMode(), t3lib_iconWorks\getSpriteIcon(), t3lib_extMgm\isLoaded(), t3lib_iconWorks\skinImg(), and t3lib_div\testInt().

Referenced by main().

SC_alt_doc::getLanguages ( $  id)

Returns sys_language records.

Parameters:
integerPage 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 1208 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:
stringThe table for which the configuration may be specific
stringThe 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 1399 of file alt_doc.php.

References $GLOBALS.

Referenced by getButtons(), and processData().

SC_alt_doc::getRecordForEdit ( $  table,
$  theUid 
)

Get record for editing.

Parameters:
stringTable name
integerRecord UID
Returns:
array Returns record to edit, false if none

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

References $BACK_PATH, $BE_USER, $GLOBALS, t3lib_div\_GP(), t3lib_BEfunc\BEgetRootLine(), editRegularContentFromId(), t3lib_BEfunc\getModuleData(), t3lib_BEfunc\getUrlToken(), 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

  • multiple records are too confusing
    Returns:
    string the HTML

Definition at line 920 of file alt_doc.php.

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:
stringTable name
integeruid for which to create a new language
integerpid of the record
Returns:
string <select> HTML element (if there were items for the box anyways...)

Definition at line 1072 of file alt_doc.php.

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

SC_alt_doc::localizationRedirect ( $  justLocalized)

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

Parameters:
stringString passed by GET &justLocalized=
Returns:
void

Definition at line 1175 of file alt_doc.php.

References $GLOBALS, $returnUrl, $TCA, t3lib_div\_GP(), t3lib_BEfunc\deleteClause(), t3lib_BEfunc\getUrlToken(), t3lib_utility_Http\redirect(), t3lib_div\sanitizeLocalUrl(), and t3lib_BEfunc\versioningPlaceholderClause().

Referenced by preInit().

SC_alt_doc::main ( )

Main module operation

Returns:
void

Definition at line 509 of file alt_doc.php.

References $BE_USER, 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 623 of file alt_doc.php.

References $BE_USER, $GLOBALS, $TCA, t3lib_FlashMessageQueue\addMessage(), t3lib_div\callUserFunction(), t3lib_BEfunc\fixVersioningPid(), t3lib_BEfunc\getRecord(), t3lib_BEfunc\getRecordTitle(), t3lib_BEfunc\isRecordLocked(), t3lib_div\makeInstance(), t3lib_div\trimExplode(), and t3lib_message_AbstractMessage\WARNING.

Referenced by main().

SC_alt_doc::openInNewWindowLink ( )

Creates open-in-window link

Returns:
string

Definition at line 1017 of file alt_doc.php.

SC_alt_doc::preInit ( )

First initialization.

Returns:
void

Definition at line 184 of file alt_doc.php.

References $BE_USER, t3lib_div\_GET(), t3lib_div\_GP(), closeDocument(), compileStoreDat(), fixWSversioningInEditConf(), t3lib_div\getIndpEnv(), localizationRedirect(), t3lib_div\sanitizeLocalUrl(), and setDocument().

SC_alt_doc::printContent ( )

Outputting the accumulated content to screen

Returns:
void

Definition at line 589 of file alt_doc.php.

SC_alt_doc::processData ( )

Do processing of data, submitting it to TCEmain.

Returns:
void

Definition at line 259 of file alt_doc.php.

References $BE_USER, $GLOBALS, $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:
stringPointer to the document in the docHandler array
stringAlternative/Default retUrl
Returns:
void

Definition at line 1462 of file alt_doc.php.

References $retUrl, t3lib_div\getIndpEnv(), t3lib_extMgm\isLoaded(), and t3lib_utility_Http\redirect().

Referenced by closeDocument(), and preInit().

SC_alt_doc::shortCutLink ( )

Create shortcut icon

Returns:
string

Definition at line 1002 of file alt_doc.php.

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

Referenced by main().

Member Data Documentation

SC_alt_doc::$cacheCmd

Definition at line 111 of file alt_doc.php.

SC_alt_doc::$closeDoc

Definition at line 106 of file alt_doc.php.

SC_alt_doc::$columnsOnly

Definition at line 102 of file alt_doc.php.

SC_alt_doc::$content

Definition at line 136 of file alt_doc.php.

Referenced by languageSwitch().

SC_alt_doc::$data

Definition at line 109 of file alt_doc.php.

SC_alt_doc::$defVals

Definition at line 103 of file alt_doc.php.

SC_alt_doc::$disHelp

Definition at line 122 of file alt_doc.php.

SC_alt_doc::$doc

Definition at line 134 of file alt_doc.php.

SC_alt_doc::$docDat

Definition at line 148 of file alt_doc.php.

SC_alt_doc::$docHandler

Definition at line 149 of file alt_doc.php.

SC_alt_doc::$dontStoreDocumentRef

Definition at line 171 of file alt_doc.php.

SC_alt_doc::$doSave

Definition at line 107 of file alt_doc.php.

SC_alt_doc::$editconf

Definition at line 101 of file alt_doc.php.

SC_alt_doc::$editRegularContentFromId

Definition at line 120 of file alt_doc.php.

SC_alt_doc::$elementsData

Definition at line 153 of file alt_doc.php.

SC_alt_doc::$errorC

Definition at line 155 of file alt_doc.php.

SC_alt_doc::$firstEl

Definition at line 154 of file alt_doc.php.

SC_alt_doc::$generalPathOfForm

Definition at line 167 of file alt_doc.php.

SC_alt_doc::$localizationMode

Definition at line 125 of file alt_doc.php.

SC_alt_doc::$mirror

Definition at line 110 of file alt_doc.php.

SC_alt_doc::$modTSconfig

Definition at line 159 of file alt_doc.php.

SC_alt_doc::$newC

Definition at line 156 of file alt_doc.php.

SC_alt_doc::$noView

Definition at line 123 of file alt_doc.php.

SC_alt_doc::$overrideVals

Definition at line 104 of file alt_doc.php.

SC_alt_doc::$popViewId

Definition at line 117 of file alt_doc.php.

SC_alt_doc::$popViewId_addParams

Definition at line 118 of file alt_doc.php.

SC_alt_doc::$R_URI

Definition at line 141 of file alt_doc.php.

SC_alt_doc::$R_URL_getvars

Definition at line 140 of file alt_doc.php.

SC_alt_doc::$R_URL_parts

Definition at line 139 of file alt_doc.php.

SC_alt_doc::$recTitle

Definition at line 121 of file alt_doc.php.

SC_alt_doc::$redirect

Definition at line 112 of file alt_doc.php.

SC_alt_doc::$retUrl

Definition at line 138 of file alt_doc.php.

Referenced by setDocument().

SC_alt_doc::$returnEditConf

Definition at line 124 of file alt_doc.php.

SC_alt_doc::$returnNewPageId

Definition at line 113 of file alt_doc.php.

SC_alt_doc::$returnUrl

Definition at line 105 of file alt_doc.php.

Referenced by localizationRedirect().

SC_alt_doc::$storeArray

Definition at line 144 of file alt_doc.php.

SC_alt_doc::$storeTitle

Definition at line 143 of file alt_doc.php.

SC_alt_doc::$storeUrl

Definition at line 145 of file alt_doc.php.

SC_alt_doc::$storeUrlMd5

Definition at line 146 of file alt_doc.php.

SC_alt_doc::$tceforms

Definition at line 166 of file alt_doc.php.

SC_alt_doc::$template

Definition at line 135 of file alt_doc.php.

SC_alt_doc::$uc

Definition at line 115 of file alt_doc.php.

SC_alt_doc::$vC

Definition at line 114 of file alt_doc.php.

SC_alt_doc::$viewId

Definition at line 157 of file alt_doc.php.

SC_alt_doc::$viewId_addParams

Definition at line 158 of file alt_doc.php.

SC_alt_doc::$viewUrl

Definition at line 119 of file alt_doc.php.

The documentation for this class was generated from the following file:
Generated on Sat Feb 4 2012 04:20:45 for TYPO3 API by   doxygen 1.7.5.1