Documentation TYPO3 par Ameos

Disponible dans d'autres versions de TYPO3 -> 3.7.0 3.8.1 4.0.0 4.0.1 4.1.0 <- Available in other TYPO3 versions

tslib_fe Class Reference


Public Member Functions
	tslib_fe ($TYPO3_CONF_VARS, $id, $type, $no_cache='', $cHash='', $jumpurl='', $MP='', $RDCT='')
	connectToMySQL ()
	sendRedirect ()
	initFEuser ()
	initUserGroups ()
	checkAlternativeIdMethods ()
	clear_preview ()
	determineId ()
	fetch_the_id ()
	getPageAndRootline ()
	getPageShortcut ($SC, $mode, $thisUid, $itera=20, $pageLog=array())
	checkRootlineForIncludeSection ()
	checkEnableFields ($row)
	checkPageGroupAccess ($row, $groupList=NULL)
	checkPagerecordForIncludeSection ($row)
	setIDfromArgV ()
	getPageAndRootlineWithDomain ($domainStartPage)
	setSysPageWhereClause ()
	getPagesGroupClause ()
	findDomainRecord ($recursive=0)
	pageNotFoundAndExit ($reason='')
	pageNotFoundHandler ($code, $header='', $reason='')
	checkAndSetAlias ()
	idPartsAnalyze ($str)
	mergingWithGetVars ($GET_VARS)
	makeCacheHash ()
	cHashParams ($addQueryParams)
	initTemplate ()
	getFromCache ()
	getHash ()
	getConfigArray ()
	getCompressedTCarray ()
	includeTCA ($TCAloaded=1)
	settingLanguage ()
	settingLocale ()
	checkDataSubmission ()
	fe_tce ()
	locDataCheck ($locationData)
	sendFormmail ()
	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 ()
	isEXTincScript ()
	storeSessionData ()
	setParseTime ()
	statistics ()
	previewInfo ()
	beLoginLinkIPList ()
	makeSimulFileName ($inTitle, $page, $type, $addParams='', $no_cache='')
	simulateStaticDocuments_pEnc_onlyP_proc ($linkVars)
	getSimulFileName ()
	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 ()
	sendRedirect ()
	initFEuser ()
	initUserGroups ()
	checkAlternativeIdMethods ()
	clear_preview ()
	determineId ()
	fetch_the_id ()
	getPageAndRootline ()
	getPageShortcut ($SC, $mode, $thisUid, $itera=20, $pageLog=array())
	checkRootlineForIncludeSection ()
	checkEnableFields ($row)
	checkPageGroupAccess ($row, $groupList=NULL)
	checkPagerecordForIncludeSection ($row)
	setIDfromArgV ()
	getPageAndRootlineWithDomain ($domainStartPage)
	setSysPageWhereClause ()
	getPagesGroupClause ()
	findDomainRecord ($recursive=0)
	pageNotFoundAndExit ($reason='')
	pageNotFoundHandler ($code, $header='', $reason='')
	checkAndSetAlias ()
	idPartsAnalyze ($str)
	mergingWithGetVars ($GET_VARS)
	makeCacheHash ()
	cHashParams ($addQueryParams)
	initTemplate ()
	getFromCache ()
	getHash ()
	getConfigArray ()
	getCompressedTCarray ()
	includeTCA ($TCAloaded=1)
	settingLanguage ()
	settingLocale ()
	checkDataSubmission ()
	fe_tce ()
	locDataCheck ($locationData)
	sendFormmail ()
	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 ()
	isEXTincScript ()
	storeSessionData ()
	setParseTime ()
	statistics ()
	previewInfo ()
	beLoginLinkIPList ()
	makeSimulFileName ($inTitle, $page, $type, $addParams='', $no_cache='')
	simulateStaticDocuments_pEnc_onlyP_proc ($linkVars)
	getSimulFileName ()
	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
	$MP = ''
	$RDCT = ''
	$page_cache_reg1 = 0
	$siteScript = ''
	$fe_user = ''
	$loginUser = ''
	$gr_list = ''
	$beUserLogin = ''
	$fePreview = ''
	$showHiddenPage = ''
	$showHiddenRecords = ''
	$simUserGroup = '0'
	$versionPreviewMap = array()
	$TYPO3_CONF_VARS = array()
	$config = ''
	$TCAcachedExtras = array()
	$tmpl = ''
	$cacheTimeOutDefault = ''
	$cacheContentFlag = ''
	$all = ''
	$sPre = ''
	$pSetup = ''
	$newHash = ''
	$getMethodUrlIdToken = ''
	$noCacheBeforePageGen = ''
	$tempContent = ''
	$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 192 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 356 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 2851 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 2600 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 1256 of file class.tslib_fe.php.
References t3lib_div::inList().

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)
Two 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. 2) Use PATH_INFO (also Apache) to extract id and type from that var. Does not require any special modules compiled with apache.
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 549 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)
Two 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. 2) Use PATH_INFO (also Apache) to extract id and type from that var. Does not require any special modules compiled with apache.
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 549 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 1145 of file class.tslib_fe.php.
References t3lib_div::testInt().

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 1685 of file class.tslib_fe.php.
References t3lib_div::getIndpEnv().

tslib_fe::checkEnableFields ( $ row )

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)

Returns:
boolean True, if record is viewable.

See also:
tslib_cObj::getTreeList(), checkPagerecordForIncludeSection()

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

tslib_fe::checkFileInclude ( $ incFile )

Checks if a PHPfile may be included.

Parameters:

string Relative path to php file

Returns:
boolean Returns true if $GLOBALS['TYPO3_CONF_VARS']['FE']['noPHPscriptInclude'] is not set OR if the file requested for inclusion is found in one of the allowed paths.

See also:
tslib_cObj::PHP_SCRIPT(), tslib_feTCE::includeScripts(), tslib_menu::includeMakeMenu()

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

tslib_fe::checkJumpUrl ( )

Checks if jumpurl is set. This function also takes care of jumpurl utilized by the Direct Mail module (ext: direct_mail) which may set an integer value for jumpurl which refers to a link in a certain mail-record, mid

Returns:
void

Definition at line 1783 of file class.tslib_fe.php.
References t3lib_div::_GP(), t3lib_div::getIndpEnv(), t3lib_div::stdAuthCode(), and t3lib_div::testInt().

tslib_fe::checkPageGroupAccess ( $ row,

$ groupList = NULL

)

Check group access against a page record

Parameters:

array The page record to evaluate (needs field: fe_group)

mixed List of group id's (comma list or array). Default is $this->gr_list

Returns:
boolean True, if group access is granted. private

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

tslib_fe::checkPagerecordForIncludeSection ( $ row )

Checks page record for include section

Parameters:

array The page record to evaluate (needs fields: extendToSubpages + hidden, starttime, endtime, fe_group)

Returns:
boolean Returns true if either extendToSubpages is not checked or if the enableFields does not disable the page record. private

See also:
checkEnableFields(), tslib_cObj::getTreeList(), checkRootlineForIncludeSection()

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

tslib_fe::checkRootlineForIncludeSection ( )

Checks the current rootline for defined sections.

Returns:
boolean private

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

tslib_fe::checkRootlineForIncludeSection ( )

Checks the current rootline for defined sections.

Returns:
boolean private

Definition at line 928 of file class.tslib_fe.php.
Referenced by getPageAndRootline().

tslib_fe::clear_preview ( )

Clears the preview-flags, sets sim_exec_time to current time. Hidden pages must be hidden as default, $GLOBALS['SIM_EXEC_TIME'] is set to $GLOBALS['EXEC_TIME'] in t3lib/config_default.inc. Alter it by adding or subtracting seconds.

Returns:
void

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

tslib_fe::clearPageCacheContent ( )

Clears cache content (for $this->newHash)

Returns:
void

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

tslib_fe::clearPageCacheContent_pidList ( $ pidList )

Clears cache content for a list of page ids

Parameters:

string A list of INTEGER numbers which points to page uids for which to clear entries in the cache_pages table (page content cache)

Returns:
void

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

tslib_fe::codeString ( $ string,

$ decode = FALSE

)

En/decodes strings with lightweight encryption and a hash containing the server encryptionKey (salt) Can be used for authentication of information sent from server generated pages back to the server to establish that the server generated the page. (Like hidden fields with recipient mail addresses) Encryption is mainly to avoid spam-bots to pick up information.

Parameters:

string Input string to en/decode

boolean If set, string is decoded, not encoded.

Returns:
string encoded/decoded version of $string

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

tslib_fe::connectToMySQL ( )

Connect to SQL database May exit after outputting an error message or some JavaScript redirecting to the install tool.

Returns:
void

Definition at line 387 of file class.tslib_fe.php.
References printError().

tslib_fe::convOutputCharset ( $ content,

$ label

)

Converts input string from renderCharset to metaCharset IF the two charsets are different.

Parameters:

string Content to be converted.

string Label (just for fun, no function)

Returns:
string Converted content string.

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

tslib_fe::convPOSTCharset ( )

Converts the $_POST array from metaCharset (page HTML charset from input form) to renderCharset (internal processing) IF the two charsets are different.

Returns:
void

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

tslib_fe::csConv ( $ str,

$ from = ''

)

Converts the charset of the input string if applicable. The "from" charset is determined by the TYPO3 system charset for the current language key ($this->lang) The "to" charset is determined by the currently used charset for the page which is "iso-8859-1" by default or set by $GLOBALS['TSFE']->config['config']['metaCharset'] Only if there is a difference between the two charsets will a conversion be made The conversion is done real-time - no caching for performance at this point!

Parameters:

string String to convert charset for

string Optional "from" charset.

Returns:
string Output string, converted if needed.

See also:
t3lib_cs

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

tslib_fe::determineId ( )

Determines the id and evaluates any preview settings Basically this function is about determining whether a backend user is logged in, if he has read access to the page and if he's previewing the page. That all determines which id to show and how to initialize the id.

Returns:
void

Definition at line 614 of file class.tslib_fe.php.
References $simUserGroup, t3lib_div::_GP(), t3lib_div::callUserFunction(), clear_preview(), determineId(), fetch_the_id(), t3lib_div::makeInstance(), set_no_cache(), setIDfromArgV(), and t3lib_div::testInt().

tslib_fe::determineId ( )

Determines the id and evaluates any preview settings Basically this function is about determining whether a backend user is logged in, if he has read access to the page and if he's previewing the page. That all determines which id to show and how to initialize the id.

Returns:
void

Definition at line 614 of file class.tslib_fe.php.
References $simUserGroup, t3lib_div::_GP(), t3lib_div::callUserFunction(), clear_preview(), fetch_the_id(), t3lib_div::makeInstance(), set_no_cache(), setIDfromArgV(), and t3lib_div::testInt().
Referenced by determineId().

tslib_fe::doLocalAnchorFix ( )

Returns the mode of Local Anchor prefixing

Returns:
string Keyword: "all", "cached" or "output"

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

tslib_fe::doXHTML_cleaning ( )

Returns the mode of XHTML cleaning

Returns:
string Keyword: "all", "cached" or "output"

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

tslib_fe::encryptEmail ( $ string,

$ back = 0

)

Encryption of email addresses for -tags See the spam protection setup in TS 'config.'

Parameters:

string Input string to en/decode: "mailto:blabla@bla.com"

boolean If set, the process is reversed, effectively decoding, not encoding.

Returns:
string encoded/decoded version of $string

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

tslib_fe::fe_tce ( )

Processes submitted user data (obsolete "Frontend TCE")

Returns:
void

See also:
tslib_feTCE &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=342&cHash=fdf55adb3b

Definition at line 1710 of file class.tslib_fe.php.
References t3lib_div::_POST(), and t3lib_div::makeInstance().

tslib_fe::fetch_the_id ( )

Get The Page ID This gets the id of the page, checks if the page is in the domain and if the page is accessible Sets variables such as $this->sys_page, $this->loginUser, $this->gr_list, $this->id, $this->type, $this->domainStartPage, $this->idParts

Returns:
void private

Definition at line 720 of file class.tslib_fe.php.
References checkAndSetAlias(), fetch_the_id(), findDomainRecord(), getPageAndRootlineWithDomain(), idPartsAnalyze(), initUserGroups(), t3lib_div::makeInstance(), pageNotFoundAndExit(), printError(), set_no_cache(), and setSysPageWhereClause().

tslib_fe::fetch_the_id ( )

Get The Page ID This gets the id of the page, checks if the page is in the domain and if the page is accessible Sets variables such as $this->sys_page, $this->loginUser, $this->gr_list, $this->id, $this->type, $this->domainStartPage, $this->idParts

Returns:
void private

Definition at line 720 of file class.tslib_fe.php.
References checkAndSetAlias(), findDomainRecord(), getPageAndRootlineWithDomain(), idPartsAnalyze(), initUserGroups(), t3lib_div::makeInstance(), pageNotFoundAndExit(), printError(), set_no_cache(), and setSysPageWhereClause().
Referenced by determineId(), and fetch_the_id().

tslib_fe::findDomainRecord ( $ recursive = 0 )

Looking up a domain record based on HTTP_HOST

Parameters:

boolean If set, it looks "recursively" meaning that a domain like "123.456.typo3.com" would find a domain record like "typo3.com" if "123.456.typo3.com" or "456.typo3.com" did not exist.

Returns:
integer Returns the page id of the page where the domain record was found. private

Definition at line 1074 of file class.tslib_fe.php.
References t3lib_div::getIndpEnv().

tslib_fe::generatePage_postProcessing ( )

Does some processing AFTER the pagegen script is included. This includes calling tidy (if configured), XHTML cleaning (if configured), caching the page, indexing the page (if configured) and setting sysLastChanged

Returns:
void

Definition at line 2135 of file class.tslib_fe.php.
References t3lib_div::callUserFunction(), t3lib_div::getUserObj(), and t3lib_div::makeInstance().

tslib_fe::generatePage_preProcessing ( )

Does some processing BEFORE the pagegen script is included.

Returns:
void

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

tslib_fe::generatePage_whichScript ( )

Determines to include custom or pagegen.php script returns script-filename if a TypoScript (config) script is defined and should be include instead of pagegen.php

Returns:
string The relative filepath of "config.pageGenScript" if found and allowed

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

tslib_fe::getCompressedTCarray ( )

Get the compressed $TCA array for use in the front-end A compressed $TCA array holds only the ctrl- and feInterface-part for each table. But the column-definitions are omitted in order to save some memory and be more efficient. Operates on the global variable, $TCA

Returns:
void

See also:
includeTCA()

Definition at line 1489 of file class.tslib_fe.php.
References t3lib_div::loadTCA().

tslib_fe::getConfigArray ( )

Checks if config-array exists already but if not, gets it

Returns:
void

Definition at line 1367 of file class.tslib_fe.php.
References t3lib_div::getIndpEnv(), t3lib_div::intInRange(), t3lib_div::isAllowedAbsPath(), and t3lib_div::locationHeaderUrl().

tslib_fe::getFromCache ( )

See if page is in cache and get it if so Stores the page content in $this->content if something is found.

Returns:
void

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

tslib_fe::getHash ( )

Calculates the cache-hash This hash is unique to the template, the variables ->id, ->type, ->gr_list (list of groups), ->MP (Mount Points) and cHash array Used to get and later store the cached data.

Returns:
string MD5 hash of $this->hash_base which is a serialized version of there variables. private

See also:
getFromCache()

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

tslib_fe::getLLL ( $ index,

$ LOCAL_LANG

)

Returns 'locallang' label - may need initializing by initLLvars

Parameters:

string Local_lang key for which to return label (language is determined by $this->lang)

array The locallang array in which to search

Returns:
string Label value of $index key.

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

tslib_fe::getPageAndRootline ( )

Gets the page and rootline arrays based on the id, $this->id
If the id does not correspond to a proper page, the 'previous' valid page in the rootline is found If the page is a shortcut (doktype=4), the ->id is loaded with that id
Whether or not the ->id is changed to the shortcut id or the previous id in rootline (eg if a page is hidden), the ->page-array and ->rootline is found and must also be valid.
Sets or manipulates internal variables such as: $this->id, $this->page, $this->rootLine, $this->MP, $this->pageNotFound

Returns:
void private

Definition at line 812 of file class.tslib_fe.php.
References checkRootlineForIncludeSection(), getPageShortcut(), pageNotFoundAndExit(), and printError().

tslib_fe::getPageAndRootlineWithDomain ( $ domainStartPage )

Gets ->page and ->rootline information based on ->id. ->id may change during this operation. If not inside domain, then default to first page in domain.

Parameters:

integer Page uid of the page where the found domain record is (pid of the domain record)

Returns:
void private

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

tslib_fe::getPagesGroupClause ( )

Return where-clause for group access

Returns:
string Group where clause part private

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

tslib_fe::getPageShortcut ( $ SC,

$ mode,

$ thisUid,

$ itera = 20,

$ pageLog = array()

)

Get page shortcut; Finds the records pointed to by input value $SC (the shortcut value)

Parameters:

integer The value of the "shortcut" field from the pages record

integer The shortcut mode: 1 and 2 will select either first subpage or random subpage; the default is the page pointed to by $SC

integer The current page UID of the page which is a shortcut

integer Safety feature which makes sure that the function is calling itself recursively max 20 times (since this function can find shortcuts to other shortcuts to other shortcuts...)

array An array filled with previous page uids tested by the function - new page uids are evaluated against this to avoid going in circles.

Returns:
mixed Returns the page record of the page that the shortcut pointed to. private

See also:
getPageAndRootline()

Definition at line 878 of file class.tslib_fe.php.
References t3lib_div::intExplode().

tslib_fe::getPagesTSconfig ( )

Returns the pages TSconfig array based on the currect ->rootLine

Returns:
array

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

tslib_fe::getSimulFileName ( )

Returns the simulated static file name (*.html) for the current page (using the page record in $this->page)

Returns:
string The filename (without path)

See also:
makeSimulFileName(), publish.php

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

tslib_fe::getStorageSiterootPids ( )

Traverses the ->rootLine and returns an array with the first occurrance of storage pid and siteroot pid

Returns:
array Array with keys '_STORAGE_PID' and '_SITEROOT' set to the first occurances found.

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

tslib_fe::idPartsAnalyze ( $ str )

Analyzes the second part of a id-string (after the "+"), looking for B6 or M5 encoding and if found it will resolve it and restore the variables in global $_GET (but NOT $_GET - yet) If values for ->cHash, ->no_cache, ->jumpurl and ->MP is found, they are also loaded into the internal vars of this class.

Parameters:

string String to analyze

Returns:
void private

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

tslib_fe::includeTCA ( $ TCAloaded = 1 )

Includes full TCA. Normally in the frontend only a part of the global $TCA array is loaded, for instance the "ctrl" part. Thus it doesn't take up too much memory. If you need the FULL TCA available for some reason (like plugins using it) you should call this function which will include the FULL TCA. Global vars $TCA, $PAGES_TYPES, $LANG_GENERAL_LABELS can/will be affected. The flag $this->TCAloaded will make sure that such an inclusion happens only once since; If $this->TCAloaded is set, nothing is included.

Parameters:

boolean Probably, keep hands of this value. Just don't set it. (This may affect the first-ever time this function is called since if you set it to zero/false any subsequent call will still trigger the inclusion; In other words, this value will be set in $this->TCAloaded after inclusion and therefore if its false, another inclusion will be possible on the next call. See ->getCompressedTCarray())

Returns:
void

See also:
getCompressedTCarray()

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

tslib_fe::initFEuser ( )

Initializes the front-end login user.

Returns:
void

Definition at line 461 of file class.tslib_fe.php.
References t3lib_div::_GP(), and t3lib_div::makeInstance().

tslib_fe::initLLvars ( )

Initializing the getLL variables needed. Sets $this->langSplitIndex based on $this->config['config']['language']

Returns:
void

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

tslib_fe::initTemplate ( )

Initialize the TypoScript template parser

Returns:
void

Definition at line 1277 of file class.tslib_fe.php.
References t3lib_div::makeInstance().

tslib_fe::initUserGroups ( )

Initializes the front-end user groups.

Returns:
void

Definition at line 501 of file class.tslib_fe.php.
References t3lib_div::devLog().

tslib_fe::initUserGroups ( )

Initializes the front-end user groups.

Returns:
void

Definition at line 501 of file class.tslib_fe.php.
References t3lib_div::devLog().
Referenced by fetch_the_id().

tslib_fe::INTincScript ( )

Processes the INTinclude-scripts

Returns:
void

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

tslib_fe::INTincScript_loadJSCode ( )

Loads the JavaScript code for INTincScript

Returns:
void private

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

tslib_fe::isEXTincScript ( )

Determines if any EXTincScripts should be included

Returns:
boolean True, if external php scripts should be included (set by PHP_SCRIPT_EXT cObjects)

See also:
tslib_cObj::PHP_SCRIPT

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

tslib_fe::isGeneratePage ( )

Returns true if the page should be generated That is if jumpurl is not set and the cacheContentFlag is not set.

Returns:
boolean

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

tslib_fe::isINTincScript ( )

Determines if there are any INTincScripts to include

Returns:
boolean Returns true if scripts are found (and not jumpurl)

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

tslib_fe::isOutputting ( )

Determines if content should be outputted. Outputting content is done only if jumpurl is NOT set.

Returns:
boolean Returns true if $this->jumpurl is not set.

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

tslib_fe::jumpUrl ( )

Sends a header 'Location' to jumpurl, if jumpurl is set. Will exit if a location header is sent (for instance if JumpUrl was triggered)

Returns:
void

Definition at line 1865 of file class.tslib_fe.php.
References t3lib_div::_GP(), and t3lib_div::shortMD5().

tslib_fe::locDataCheck ( $ locationData )

Checks if a formmail submission can be sent as email

Parameters:

string The input from $_POST['locationData']

Returns:
void private

See also:
checkDataSubmission()

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

tslib_fe::make_seed ( )

Seeds the random number engine.

Returns:
void

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

tslib_fe::makeCacheHash ( )

Calculates a hash string based on additional parameters in the url. This is used to cache pages with more parameters than just id and type

Returns:
void

Definition at line 1233 of file class.tslib_fe.php.
References t3lib_div::_GET(), t3lib_div::implodeArrayForUrl(), and t3lib_div::shortMD5().

tslib_fe::makeSimulFileName ( $ inTitle,

$ page,

$ type,

$ addParams = '',

$ no_cache = ''

)

Make simulation filename (without the ".html" ending, only body of filename)

Parameters:

string The page title to use

mixed The page id (integer) or alias (string)

integer The type number

string Query-parameters to encode (will be done only if caching is enabled and TypoScript configured for it. I don't know it this makes much sense in fact...)

boolean The "no_cache" status of the link.

Returns:
string The body of the filename.

See also:
getSimulFileName(), t3lib_tstemplate::linkData(), tslib_frameset::frameParams()

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

tslib_fe::mergingWithGetVars ( $ GET_VARS )

Merging values into the global $_GET

Parameters:

array Array of key/value pairs that will be merged into the current GET-vars. (Non-escaped values)

Returns:
void

Definition at line 1185 of file class.tslib_fe.php.
References t3lib_div::_GET(), t3lib_div::_GETset(), and t3lib_div::array_merge_recursive_overrule().

tslib_fe::newCObj ( )

Creates an instance of tslib_cObj in $this->cObj This instance is used to start the rendering of the TypoScript template structure

Returns:
void

See also:
pagegen.php

Definition at line 2824 of file class.tslib_fe.php.
References t3lib_div::makeInstance().

tslib_fe::pageNotFoundAndExit ( $ reason = '' )

Page-not-found handler for use in frontend plugins from extensions.

Parameters:

string Reason text

Returns:
void Function exits.

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

tslib_fe::pageNotFoundHandler ( $ code,

$ header = '',

$ reason = ''

)

Page not found handler. Exits.

Parameters:

mixed Which type of handling; If a true PHP-boolean and TRUE then a ->printError message is outputted. If integer an error message with that number is shown. Otherwise the $code value is expected to be a "Location:" header value.

string If set, this is passed directly to the PHP function, header()

string If set, error messages will also mention this as the reason for the page-not-found.

Returns:
void (The function exists!)

Definition at line 1107 of file class.tslib_fe.php.
References t3lib_div::getFileAbsFileName(), t3lib_div::getIndpEnv(), t3lib_div::isFirstPartOfStr(), t3lib_div::locationHeaderUrl(), and t3lib_div::testInt().

tslib_fe::plainMailEncoded ( $ email,

$ subject,

$ message,

$ headers = ''

)

Substitute function for the PHP mail() function. It will encode the email with the setting of TS 'config.notification_email_encoding' (base64 or none) It will also find all links to http:// in the text and substitute with a shorter link using the redirect feature which stores the long link in the database. Depends on configuration in TS 'config.notification_email_urlmode'

Parameters:

string recipient email address (or list of)

string The subject

string The message

string The headers (string with lines)

Returns:
void

See also:
t3lib_div::plainMailEncoded()

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

tslib_fe::prefixLocalAnchorsWithScript ( )

Substitutes all occurencies of <a href="#"... in $this->content with <a href="[path-to-url]#"...

Returns:
void Works directly on $this->content

Definition at line 2918 of file class.tslib_fe.php.
References t3lib_div::getIndpEnv().

tslib_fe::previewInfo ( )

Outputs preview info.

Returns:
void

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

tslib_fe::printError ( $ label,

$ header = 'Error!'

)

Prints error msg/header. Echoes out the HTML content

Parameters:

string Message string

string Header string

Returns:
void

See also:
t3lib_timeTrack::debug_typo3PrintError()

Definition at line 2870 of file class.tslib_fe.php.
References t3lib_timeTrack::debug_typo3PrintError(), and t3lib_div::getIndpEnv().

tslib_fe::processOutput ( )

Processes the output before it's actually outputted. Sends headers also. This includes substituting the USERNAME comment, getMethodUrlIdToken, sending additional headers (as defined in the TypoScript "config.additionalheaders" object), tidy'ing content, XHTML cleaning content (if configured) Works on $this->content

Returns:
void

Definition at line 2388 of file class.tslib_fe.php.
References t3lib_div::callUserFunction(), and t3lib_div::makeInstance().

tslib_fe::readLLfile ( $ fileRef )

Read locallang files - for frontend applications

Parameters:

string Reference to a relative filename to include.

Returns:
array Returns the $LOCAL_LANG array found in the file. If no array found, returns empty array.

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

tslib_fe::realPageCacheContent ( )

Set cache content to $this->content

Returns:
void

Definition at line 1992 of file class.tslib_fe.php.
References t3lib_div::getUserObj().

tslib_fe::roundTripCryptString ( $ string )

Encrypts a strings by XOR'ing all characters with the ASCII value of a character in $this->TYPO3_CONF_VARS['SYS']['encryptionKey'] If $this->TYPO3_CONF_VARS['SYS']['encryptionKey'] is empty, 255 is used for XOR'ing. Using XOR means that the string can be decrypted by simply calling the function again - just like rot-13 works (but in this case for ANY byte value).

Parameters:

string Input string

Returns:
string Output string

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

tslib_fe::sendFormmail ( )

Sends the emails from the formmail content object.

Returns:
void private

See also:
checkDataSubmission()

Definition at line 1740 of file class.tslib_fe.php.
References t3lib_div::_POST(), t3lib_div::getUserObj(), and t3lib_div::makeInstance().

tslib_fe::sendRedirect ( )

Looks up the value of $this->RDCT in the database and if it is found to be associated with a redirect URL then the redirection is carried out with a 'Location:' header May exit after sending a location-header.

Returns:
void

Definition at line 423 of file class.tslib_fe.php.
References updateMD5paramsRecord().

tslib_fe::set_cache_timeout_default ( $ seconds )

Sets the cache-timeout in seconds

Parameters:

integer cache-timeout in seconds

Returns:
void

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

tslib_fe::set_no_cache ( )

Sets the cache-flag to 1. Could be called from user-included php-files in order to ensure that a page is not cached.

Returns:
void

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

tslib_fe::setAbsRefPrefix ( )

Substitute the path's to files in the media/ folder like icons used in static_template of TypoScript Works on $this->content

Returns:
void private

See also:
pagegen.php, INTincScript()

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

tslib_fe::setCSS ( $ key,

$ content

)

Sets CSS data in the additionalCSS array

Parameters:

string $key is the key in the array, for num-key let the value be empty

string $content is the content if you want any

Returns:
void

See also:
setJS(), tslib_pibase::pi_setClassStyle()

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

tslib_fe::setIDfromArgV ( )

This checks if there are ARGV-parameters in the QUERY_STRING and if so, those are used for the id $this->id must be 'false' in order for any processing to happen in here If an id/alias value is extracted from the QUERY_STRING it is set in $this->id

Returns:
void private

Definition at line 1010 of file class.tslib_fe.php.
References t3lib_div::getIndpEnv().

tslib_fe::setJS ( $ key,

$ content = ''

)

Sets JavaScript code in the additionalJavaScript array

Parameters:

string $key is the key in the array, for num-key let the value be empty. Note reserved keys 'openPic' and 'mouseOver'

string $content is the content if you want any

Returns:
void

See also:
tslib_gmenu::writeMenu(), tslib_cObj::imageLinkWrap()

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

tslib_fe::setPageCacheContent ( $ c,

$ d,

$ t

)

Sets cache content; Inserts the content string into the cache_pages table.

Parameters:

string The content to store in the HTML field of the cache table

mixed The additional cache_data array, fx. $this->config

integer Timestamp

Returns:
void

See also:
realPageCacheContent(), tempPageCacheContent()

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

tslib_fe::setParseTime ( )

Sets the parsetime of the page.

Returns:
void private

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

tslib_fe::setSysLastChanged ( )

Sets sys last changed Setting the SYS_LASTCHANGED value in the pagerecord: This value will thus be set to the highest tstamp of records rendered on the page. This includes all records with no regard to hidden records, userprotection and so on.

Returns:
void

See also:
tslib_cObj::lastChanged()

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

tslib_fe::setSysPageWhereClause ( )

Sets sys_page where-clause

Returns:
void private

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

tslib_fe::setSysPageWhereClause ( )

Sets sys_page where-clause

Returns:
void private

Definition at line 1053 of file class.tslib_fe.php.
Referenced by fetch_the_id().

tslib_fe::settingLanguage ( )

Setting the language key that'll be used by the current page. In this function it should be checked, 1) that this language exists, 2) that a page_overlay_record exists, .. and if not the default language, 0 (zero), should be set.

Returns:
void private

Definition at line 1570 of file class.tslib_fe.php.
References t3lib_div::intExplode(), t3lib_extMgm::isLoaded(), and t3lib_div::trimExplode().

tslib_fe::settingLocale ( )

Setting locale for frontend rendering

Returns:
void

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

tslib_fe::setUrlIdToken ( )

Sets the URL_ID_TOKEN in the internal var, $this->getMethodUrlIdToken

Returns:
void private

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

tslib_fe::simulateStaticDocuments_pEnc_onlyP_proc ( $ linkVars )

Processes a query-string with GET-parameters and returns two strings, one with the parameters that CAN be encoded and one array with those which can't be encoded (encoded by the M5 or B6 methods)

Parameters:

string Query string to analyse

Returns:
array Two num keys returned, first is the parameters that MAY be encoded, second is the non-encodable parameters.

See also:
makeSimulFileName(), t3lib_tstemplate::linkData()

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

tslib_fe::sL ( $ input )

Split Label function for front-end applications.

Parameters:

string Key string. Accepts the "LLL:" prefix.

Returns:
string Label value, if any.

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

tslib_fe::statistics ( )

Saves hit statistics

Returns:
void

Definition at line 2485 of file class.tslib_fe.php.
References t3lib_div::_GP(), t3lib_div::getIndpEnv(), t3lib_div::inList(), t3lib_div::isFirstPartOfStr(), and t3lib_extMgm::isLoaded().

tslib_fe::storeSessionData ( )

Stores session data for the front end user

Returns:
void

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

tslib_fe::tempPageCacheContent ( )

Temp cache content The temporary cache will expire after a few seconds (typ. 30) or will be cleared by the rendered page, which will also clear and rewrite the cache.

Returns:
void

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

tslib_fe::tidyHTML ( $ content )

Pass the content through tidy - a little program that cleans up HTML-code Requires $this->TYPO3_CONF_VARS['FE']['tidy'] to be true and $this->TYPO3_CONF_VARS['FE']['tidy_path'] to contain the filename/path of tidy including clean-up arguments for tidy. See default value in TYPO3_CONF_VARS in t3lib/config_default.php

Parameters:

string The page content to clean up. Will be written to a temporary file which "tidy" is then asked to clean up. File content is read back and returned.

Returns:
string Returns the

Definition at line 2892 of file class.tslib_fe.php.
References t3lib_div::tempnam().

tslib_fe::uniqueHash ( $ str = '' )

Returns a unique md5 hash. There is no special magic in this, the only point is that you don't have to call md5(uniqid()) which is slow and by this you are sure to get a unique string each time in a little faster way.

Parameters:

string Some string to include in what is hashed. Not significant at all.

Returns:
string MD5 hash of ->uniqueString, input string and uniqueCounter

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

tslib_fe::updateMD5paramsRecord ( $ hash )

Updates the tstamp field of a cache_md5params record to the current time.

Parameters:

string The hash string identifying the cache_md5params record for which to update the "tstamp" field to the current time.

Returns:
void private

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

Member Data Documentation

tslib_fe::$JSeventFuncCalls

Initial value:
array( // you can add JavaScript functions to each entry in these arrays. Please see how this is done in the GMENU_LAYERS script. The point is that many applications on a page can set handlers for onload, onmouseover and onmouseup 'onmousemove' => array(), 'onmouseup' => array(), 'onload' => array(), )

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

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

typo3_src-3.7.0/tslib/class.tslib_fe.php
typo3_src-3.7.0/typo3/sysext/cms/tslib/class.tslib_fe.php

Généré par Le spécialiste TYPO3 avec doxygen

1.4.6