Documentation TYPO3 par Ameos

tslib_fe Class Reference

List of all members.

Public Member Functions

 tslib_fe ($TYPO3_CONF_VARS, $id, $type, $no_cache='', $cHash='', $jumpurl='', $MP='', $RDCT='')
 connectToMySQL ()
 connectToDB ()
 sendRedirect ()
 initFEuser ()
 initUserGroups ()
 isUserOrGroupSet ()
 checkAlternativeIdMethods ()
 clear_preview ()
 determineId ()
 fetch_the_id ()
 getPageAndRootline ()
 getPageShortcut ($SC, $mode, $thisUid, $itera=20, $pageLog=array())
 checkRootlineForIncludeSection ()
 checkEnableFields ($row, $bypassGroupCheck=FALSE)
 checkPageGroupAccess ($row, $groupList=NULL)
 checkPagerecordForIncludeSection ($row)
 checkIfLoginAllowedInBranch ()
 getPageAccessFailureReasons ()
 setIDfromArgV ()
 getPageAndRootlineWithDomain ($domainStartPage)
 setSysPageWhereClause ()
 getPagesGroupClause ()
 findDomainRecord ($recursive=0)
 pageNotFoundAndExit ($reason='')
 pageNotFoundHandler ($code, $header='', $reason='')
 checkAndSetAlias ()
 idPartsAnalyze ($str)
 mergingWithGetVars ($GET_VARS)
 makeCacheHash ()
 reqCHash ()
 cHashParams ($addQueryParams)
 initTemplate ()
 getFromCache ()
 headerNoCache ()
 getHash ()
 getConfigArray ()
 getCompressedTCarray ()
 includeTCA ($TCAloaded=1)
 settingLanguage ()
 settingLocale ()
 checkDataSubmission ()
 fe_tce ()
 locDataCheck ($locationData)
 sendFormmail ()
 extractRecipientCopy ($bodytext)
 checkJumpUrl ()
 jumpUrl ()
 setUrlIdToken ()
 isGeneratePage ()
 tempPageCacheContent ()
 realPageCacheContent ()
 setPageCacheContent ($c, $d, $t)
 clearPageCacheContent ()
 clearPageCacheContent_pidList ($pidList)
 setSysLastChanged ()
 generatePage_preProcessing ()
 generatePage_whichScript ()
 generatePage_postProcessing ()
 INTincScript ()
 INTincScript_loadJSCode ()
 isINTincScript ()
 doXHTML_cleaning ()
 doLocalAnchorFix ()
 isOutputting ()
 processOutput ()
 sendCacheHeaders ()
 isStaticCacheble ()
 contentStrReplace ()
 isEXTincScript ()
 storeSessionData ()
 setParseTime ()
 statistics ()
 previewInfo ()
 hook_eofe ()
 beLoginLinkIPList ()
 makeSimulFileName ($inTitle, $page, $type, $addParams='', $no_cache='')
 simulateStaticDocuments_pEnc_onlyP_proc ($linkVars)
 getSimulFileName ()
 fileNameASCIIPrefix ($inTitle, $titleChars, $mergeChar='.')
 encryptEmail ($string, $back=0)
 codeString ($string, $decode=FALSE)
 roundTripCryptString ($string)
 checkFileInclude ($incFile)
 newCObj ()
 setAbsRefPrefix ()
 baseUrlWrap ($url)
 printError ($label, $header='Error!')
 updateMD5paramsRecord ($hash)
 tidyHTML ($content)
 prefixLocalAnchorsWithScript ()
 getStorageSiterootPids ()
 getPagesTSconfig ()
 setJS ($key, $content='')
 setCSS ($key, $content)
 make_seed ()
 uniqueHash ($str='')
 set_no_cache ()
 set_cache_timeout_default ($seconds)
 plainMailEncoded ($email, $subject, $message, $headers='')
 sL ($input)
 readLLfile ($fileRef)
 getLLL ($index, $LOCAL_LANG)
 initLLvars ()
 csConv ($str, $from='')
 convOutputCharset ($content, $label='')
 convPOSTCharset ()
 tslib_fe ($TYPO3_CONF_VARS, $id, $type, $no_cache='', $cHash='', $jumpurl='', $MP='', $RDCT='')
 connectToMySQL ()
 connectToDB ()
 sendRedirect ()
 initFEuser ()
 initUserGroups ()
 isUserOrGroupSet ()
 checkAlternativeIdMethods ()
 clear_preview ()
 determineId ()
 fetch_the_id ()
 getPageAndRootline ()
 getPageShortcut ($SC, $mode, $thisUid, $itera=20, $pageLog=array())
 checkRootlineForIncludeSection ()
 checkEnableFields ($row, $bypassGroupCheck=FALSE)
 checkPageGroupAccess ($row, $groupList=NULL)
 checkPagerecordForIncludeSection ($row)
 checkIfLoginAllowedInBranch ()
 getPageAccessFailureReasons ()
 setIDfromArgV ()
 getPageAndRootlineWithDomain ($domainStartPage)
 setSysPageWhereClause ()
 getPagesGroupClause ()
 findDomainRecord ($recursive=0)
 pageNotFoundAndExit ($reason='')
 pageNotFoundHandler ($code, $header='', $reason='')
 checkAndSetAlias ()
 idPartsAnalyze ($str)
 mergingWithGetVars ($GET_VARS)
 makeCacheHash ()
 reqCHash ()
 cHashParams ($addQueryParams)
 initTemplate ()
 getFromCache ()
 headerNoCache ()
 getHash ()
 getConfigArray ()
 getCompressedTCarray ()
 includeTCA ($TCAloaded=1)
 settingLanguage ()
 settingLocale ()
 checkDataSubmission ()
 fe_tce ()
 locDataCheck ($locationData)
 sendFormmail ()
 extractRecipientCopy ($bodytext)
 checkJumpUrl ()
 jumpUrl ()
 setUrlIdToken ()
 isGeneratePage ()
 tempPageCacheContent ()
 realPageCacheContent ()
 setPageCacheContent ($c, $d, $t)
 clearPageCacheContent ()
 clearPageCacheContent_pidList ($pidList)
 setSysLastChanged ()
 generatePage_preProcessing ()
 generatePage_whichScript ()
 generatePage_postProcessing ()
 INTincScript ()
 INTincScript_loadJSCode ()
 isINTincScript ()
 doXHTML_cleaning ()
 doLocalAnchorFix ()
 isOutputting ()
 processOutput ()
 sendCacheHeaders ()
 isStaticCacheble ()
 contentStrReplace ()
 isEXTincScript ()
 storeSessionData ()
 setParseTime ()
 statistics ()
 previewInfo ()
 hook_eofe ()
 beLoginLinkIPList ()
 makeSimulFileName ($inTitle, $page, $type, $addParams='', $no_cache='')
 simulateStaticDocuments_pEnc_onlyP_proc ($linkVars)
 getSimulFileName ()
 fileNameASCIIPrefix ($inTitle, $titleChars, $mergeChar='.')
 encryptEmail ($string, $back=0)
 codeString ($string, $decode=FALSE)
 roundTripCryptString ($string)
 checkFileInclude ($incFile)
 newCObj ()
 setAbsRefPrefix ()
 baseUrlWrap ($url)
 printError ($label, $header='Error!')
 updateMD5paramsRecord ($hash)
 tidyHTML ($content)
 prefixLocalAnchorsWithScript ()
 getStorageSiterootPids ()
 getPagesTSconfig ()
 setJS ($key, $content='')
 setCSS ($key, $content)
 make_seed ()
 uniqueHash ($str='')
 set_no_cache ()
 set_cache_timeout_default ($seconds)
 plainMailEncoded ($email, $subject, $message, $headers='')
 sL ($input)
 readLLfile ($fileRef)
 getLLL ($index, $LOCAL_LANG)
 initLLvars ()
 csConv ($str, $from='')
 convOutputCharset ($content, $label='')
 convPOSTCharset ()

Public Attributes

 $id = ''
 $type = ''
 $idParts = array()
 $cHash = ''
 $no_cache = ''
 $rootLine = ''
 $page = ''
 $contentPid = 0
 $sys_page = ''
 $jumpurl = ''
 $pageNotFound = 0
 $domainStartPage = 0
 $pageAccessFailureHistory = array()
 $MP = ''
 $RDCT = ''
 $page_cache_reg1 = 0
 $siteScript = ''
 $fe_user = ''
 $loginUser = ''
 $gr_list = ''
 $beUserLogin = ''
 $loginAllowedInBranch = TRUE
 $fePreview = ''
 $showHiddenPage = ''
 $showHiddenRecords = ''
 $simUserGroup = '0'
 $versionPreviewMap = array()
 $TYPO3_CONF_VARS = array()
 $config = ''
 $TCAcachedExtras = array()
 $tmpl = ''
 $cacheTimeOutDefault = ''
 $cacheContentFlag = ''
 $cacheExpires = 0
 $isClientCachable = FALSE
 $all = ''
 $sPre = ''
 $pSetup = ''
 $newHash = ''
 $getMethodUrlIdToken = ''
 $noCacheBeforePageGen = ''
 $tempContent = FALSE
 $forceTemplateParsing = ''
 $cHash_array = array()
 $hash_base = ''
 $pagesTSconfig = ''
 $defaultBodyTag = '<body bgcolor="#FFFFFF">'
 $additionalHeaderData = array()
 $additionalJavaScript = array()
 $additionalCSS = array()
 $JSeventFuncCalls
 $JSCode = ''
 $JSImgCode = ''
 $divSection = ''
 $debug = ''
 $intTarget = ''
 $extTarget = ''
 $MP_defaults = array()
 $spamProtectEmailAddresses = 0
 $absRefPrefix = ''
 $absRefPrefix_force = 0
 $compensateFieldWidth = ''
 $lockFilePath = ''
 $ATagParams = ''
 $sWordRegEx = ''
 $sWordList = ''
 $linkVars = ''
 $excludeCHashVars = ''
 $displayEditIcons = ''
 $displayFieldEditIcons = ''
 $sys_language_uid = 0
 $sys_language_mode = ''
 $sys_language_content = 0
 $sys_language_contentOL = 0
 $sys_language_isocode = ''
 $applicationData = Array()
 $register = Array()
 $registerStack = Array()
 $cObjectDepthCounter = 50
 $recordRegister = Array()
 $currentRecord = ''
 $accessKey = array()
 $imagesOnPage = array()
 $lastImageInfo = array()
 $uniqueCounter = 0
 $uniqueString = ''
 $indexedDocTitle = ''
 $altPageTitle = ''
 $pEncAllowedParamNames = array()
 $baseUrl = ''
 $anchorPrefix = ''
 $cObj = ''
 $content = ''
 $clientInfo = ''
 $scriptParseTime = 0
 $TCAloaded = 0
 $csConvObj
 $defaultCharSet = 'iso-8859-1'
 $renderCharset = ''
 $metaCharset = ''
 $localeCharset = ''
 $lang = ''
 $langSplitIndex = 0
 $labelsCharset = ''
 $convCharsetToFrom = ''
 $LL_labels_cache = array()
 $LL_files_cache = array()

Detailed Description

Definition at line 201 of file class.tslib_fe.php.


Constructor & Destructor Documentation

tslib_fe::tslib_fe TYPO3_CONF_VARS,
id,
type,
no_cache = '',
cHash = '',
jumpurl = '',
MP = '',
RDCT = ''
 

Class constructor Takes a number of GET/POST input variable as arguments and stores them internally. The processing of these variables goes on later in this class. Also sets internal clientInfo array (browser information) and a unique string (->uniqueString) for this script instance; A md5 hash of the microtime()

Parameters:
array The global $TYPO3_CONF_VARS array. Will be set internally in ->TYPO3_CONF_VARS
mixed The value of t3lib_div::_GP('id')
integer The value of t3lib_div::_GP('type')
boolean The value of t3lib_div::_GP('no_cache'), evaluated to 1/0
string The value of t3lib_div::_GP('cHash')
string The value of t3lib_div::_GP('jumpurl')
string The value of t3lib_div::_GP('MP')
string The value of t3lib_div::_GP('RDCT')
Returns:
void
See also:
index_ts.php

Definition at line 369 of file class.tslib_fe.php.

References $cHash, $id, $jumpurl, $MP, $no_cache, $RDCT, $type, $TYPO3_CONF_VARS, t3lib_div::callUserFunction(), t3lib_div::clientInfo(), and t3lib_div::makeInstance().

tslib_fe::tslib_fe TYPO3_CONF_VARS,
id,
type,
no_cache = '',
cHash = '',
jumpurl = '',
MP = '',
RDCT = ''
 

Class constructor Takes a number of GET/POST input variable as arguments and stores them internally. The processing of these variables goes on later in this class. Also sets internal clientInfo array (browser information) and a unique string (->uniqueString) for this script instance; A md5 hash of the microtime()

Parameters:
array The global $TYPO3_CONF_VARS array. Will be set internally in ->TYPO3_CONF_VARS
mixed The value of t3lib_div::_GP('id')
integer The value of t3lib_div::_GP('type')
boolean The value of t3lib_div::_GP('no_cache'), evaluated to 1/0
string The value of t3lib_div::_GP('cHash')
string The value of t3lib_div::_GP('jumpurl')
string The value of t3lib_div::_GP('MP')
string The value of t3lib_div::_GP('RDCT')
Returns:
void
See also:
index_ts.php

Definition at line 369 of file class.tslib_fe.php.

References $cHash, $id, $jumpurl, $MP, $no_cache, $RDCT, $type, $TYPO3_CONF_VARS, t3lib_div::callUserFunction(), t3lib_div::clientInfo(), and t3lib_div::makeInstance().


Member Function Documentation

tslib_fe::baseUrlWrap url  ) 
 

Prefixing the input URL with ->baseUrl If ->baseUrl is set and the input url is not absolute in some way. Designed as a wrapper functions for use with all frontend links that are processed by JavaScript (for "realurl" compatibility!). So each time a URL goes into window.open, document.location or otherwise, wrap it with this function!

Parameters:
string Input URL, relative or absolute
Returns:
string Processed input value.

Definition at line 3241 of file class.tslib_fe.php.

tslib_fe::baseUrlWrap url  ) 
 

Prefixing the input URL with ->baseUrl If ->baseUrl is set and the input url is not absolute in some way. Designed as a wrapper functions for use with all frontend links that are processed by JavaScript (for "realurl" compatibility!). So each time a URL goes into window.open, document.location or otherwise, wrap it with this function!

Parameters:
string Input URL, relative or absolute
Returns:
string Processed input value.

Definition at line 3241 of file class.tslib_fe.php.

tslib_fe::beLoginLinkIPList  ) 
 

Returns a link to the login screen with redirect to the front-end

Returns:
string HTML, a tag for a link to the backend.

Definition at line 2964 of file class.tslib_fe.php.

References t3lib_div::cmpIP(), and t3lib_div::getIndpEnv().

tslib_fe::beLoginLinkIPList  ) 
 

Returns a link to the login screen with redirect to the front-end

Returns:
string HTML, a tag for a link to the backend.

Definition at line 2964 of file class.tslib_fe.php.

References t3lib_div::cmpIP(), and t3lib_div::getIndpEnv().

tslib_fe::cHashParams addQueryParams  ) 
 

Splits the input query-parameters into an array with certain parameters filtered out. Used to create the cHash value

Parameters:
string Query-parameters: "&xxx=yyy&zzz=uuu"
Returns:
array Array with key/value pairs of query-parameters WITHOUT a certain list of variable names (like id, type, no_cache etc) and WITH a variable, encryptionKey, specific for this server/installation private
See also:
makeCacheHash(), tslib_cObj::typoLink()

Definition at line 1422 of file class.tslib_fe.php.

References t3lib_div::cHashParams().

tslib_fe::cHashParams addQueryParams  ) 
 

Splits the input query-parameters into an array with certain parameters filtered out. Used to create the cHash value

Parameters:
string Query-parameters: "&xxx=yyy&zzz=uuu"
Returns:
array Array with key/value pairs of query-parameters WITHOUT a certain list of variable names (like id, type, no_cache etc) and WITH a variable, encryptionKey, specific for this server/installation private
See also:
makeCacheHash(), tslib_cObj::typoLink()

Definition at line 1422 of file class.tslib_fe.php.

References t3lib_div::cHashParams().

tslib_fe::checkAlternativeIdMethods  ) 
 

Provides ways to bypass the '?id=[xxx]&type=[xx]' format, using either PATH_INFO or virtual HTML-documents (using Apache mod_rewrite)

Three options: 1) Apache mod_rewrite: Here a .htaccess file maps all .html-files to index.php and then we extract the id and type from the name of that HTML-file. (AKA "simulateStaticDocuments") 2) Use PATH_INFO (also Apache) to extract id and type from that var. Does not require any special modules compiled with apache. (less typical) 3) Using hook which enables features like those provided from "realurl" extension (AKA "Speaking URLs")

Support for RewriteRule to generate (simulateStaticDocuments) With the mod_rewrite compiled into apache, put these lines into a .htaccess in this directory: RewriteEngine On RewriteRule ^[^/]*\.html$ index.php The url must end with '.html' and the format must comply with either of these: 1: '[title].[id].[type].html' - title is just for easy recognition in the logfile!; no practical use of the title for TYPO3. 2: '[id].[type].html' - above, but title is omitted; no practical use of the title for TYPO3. 3: '[id].html' - only id, type is set to the default, zero! NOTE: In all case 'id' may be the uid-number OR the page alias (if any)

Returns:
void &tx_extrepmgm_pi1[extUid]=270&cHash=4ad9d7acb4

Definition at line 605 of file class.tslib_fe.php.

References t3lib_div::callUserFunction(), checkAlternativeIdMethods(), t3lib_div::getIndpEnv(), t3lib_div::split_fileref(), and t3lib_div::trimExplode().

tslib_fe::checkAlternativeIdMethods  ) 
 

Provides ways to bypass the '?id=[xxx]&type=[xx]' format, using either PATH_INFO or virtual HTML-documents (using Apache mod_rewrite)

Three options: 1) Apache mod_rewrite: Here a .htaccess file maps all .html-files to index.php and then we extract the id and type from the name of that HTML-file. (AKA "simulateStaticDocuments") 2) Use PATH_INFO (also Apache) to extract id and type from that var. Does not require any special modules compiled with apache. (less typical) 3) Using hook which enables features like those provided from "realurl" extension (AKA "Speaking URLs")

Support for RewriteRule to generate (simulateStaticDocuments) With the mod_rewrite compiled into apache, put these lines into a .htaccess in this directory: RewriteEngine On RewriteRule ^[^/]*\.html$ index.php The url must end with '.html' and the format must comply with either of these: 1: '[title].[id].[type].html' - title is just for easy recognition in the logfile!; no practical use of the title for TYPO3. 2: '[id].[type].html' - above, but title is omitted; no practical use of the title for TYPO3. 3: '[id].html' - only id, type is set to the default, zero! NOTE: In all case 'id' may be the uid-number OR the page alias (if any)

Returns:
void &tx_extrepmgm_pi1[extUid]=270&cHash=4ad9d7acb4

Definition at line 605 of file class.tslib_fe.php.

References t3lib_div::callUserFunction(), t3lib_div::getIndpEnv(), t3lib_div::split_fileref(), and t3lib_div::trimExplode().

Referenced by checkAlternativeIdMethods().

tslib_fe::checkAndSetAlias  ) 
 

Fetches the integer page id for a page alias. Looks if ->id is not an integer and if so it will search for a page alias and if found the page uid of that page is stored in $this->id

Returns:
void private

Definition at line 1287 of file class.tslib_fe.php.

References t3lib_div::testInt().

tslib_fe::checkAndSetAlias  ) 
 

Fetches the integer page id for a page alias. Looks if ->id is not an integer and if so it will search for a page alias and if found the page uid of that page is stored in $this->id

Returns:
void private

Definition at line 1287 of file class.tslib_fe.php.

References t3lib_div::testInt().

Referenced by fetch_the_id().

tslib_fe::checkDataSubmission  ) 
 

Checks if any email-submissions or submission via the fe_tce

Returns:
string 'email' if a formmail has been send, 'fe_tce' if front-end data submission (like forums, guestbooks) is send. '' if none.

Definition at line 1869 of file class.tslib_fe.php.

References t3lib_div::getIndpEnv().

tslib_fe::checkDataSubmission  ) 
 

Checks if any email-submissions or submission via the fe_tce

Returns:
string 'email' if a formmail has been send, 'fe_tce' if front-end data submission (like forums, guestbooks) is send. '' if none.

Definition at line 1869 of file class.tslib_fe.php.

References t3lib_div::getIndpEnv().

tslib_fe::checkEnableFields row,
bypassGroupCheck = FALSE
 

Checks page record for enableFields Returns true if enableFields does not disable the page record. Takes notice of the ->showHiddenPage flag and uses SIM_EXEC_TIME for start/endtime evaluation

Parameters:
array The page record to evaluate (needs fields: hidden, starttime, endtime, fe_group)
boolean Bypass group-check
Returns:
boolean True, if record is viewable.
See also:
tslib_cObj::getTreeList(), checkPagerecordForIncludeSection()

Definition at line 1044 of file class.tslib_fe.php.

tslib_fe::checkEnableFields row,