TypoScriptFrontendController Class Reference

References TypoScriptFrontendController\checkPagerecordForIncludeSection(), PageRepository\DOKTYPE_BE_USER_SECTION, TypoScriptFrontendController\getBackendUser(), and TypoScriptFrontendController\getDatabaseConnection().

checkIfLoginAllowedInBranch ( )

Checks if logins are allowed in the current branch of the page tree. Traverses the full root line and returns TRUE if logins are OK, otherwise FALSE (and then the login user must be unset!)

Returns: bool returns TRUE if logins are OK, otherwise FALSE (and then the login user must be unset!)

Definition at line 1847 of file TypoScriptFrontendController.php.

References elseif.

Referenced by TypoScriptFrontendController\determineId().

checkPageForMountpointRedirect ( )

Redirect to target page if the current page is an overlaid mountpoint.

If the current page is of type mountpoint and should be overlaid with the contents of the mountpoint page and is accessed directly, the user will be redirected to the mountpoint context.

Returns: void

Definition at line 3023 of file TypoScriptFrontendController.php.

References PageRepository\DOKTYPE_MOUNTPOINT.

checkPageForShortcutRedirect ( )

Redirect to target page, if the current page is a Shortcut.

If the current page is of type shortcut and accessed directly via its URL, this function redirects to the Shortcut target using a Location header.

Returns: void If page is not a Shortcut, redirects and exits otherwise

Definition at line 3038 of file TypoScriptFrontendController.php.

References PageRepository\DOKTYPE_SHORTCUT.

checkPageGroupAccess	(	$row,
		$groupList = `null`
	)

Check group access against a page record

Parameters

array	$row	The page record to evaluate (needs field: fe_group)
mixed	$groupList	List of group id's (comma list or array). Default is $this->gr_list

Returns: bool TRUE, if group access is granted. private

Definition at line 1817 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\$gr_list.

Referenced by TypoScriptFrontendController\checkEnableFields(), and TypoScriptFrontendController\getPageAccessFailureReasons().

checkPagerecordForIncludeSection ( $row )

Checks page record for include section

Parameters

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

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

See Also: checkEnableFields(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getTreeList(), checkRootlineForIncludeSection()

Definition at line 1837 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\checkEnableFields().

Referenced by TypoScriptFrontendController\checkRootlineForIncludeSection().

checkPageUnavailableHandler ( )

Checks whether the pageUnavailableHandler should be used. To be used, pageUnavailable_handling must be set and devIPMask must not match the current visitor's IP address.

Returns: bool TRUE/FALSE whether the pageUnavailable_handler should be used.

Definition at line 2022 of file TypoScriptFrontendController.php.

References GeneralUtility\cmpIP(), and GeneralUtility\getIndpEnv().

Referenced by TypoScriptFrontendController\connectToDB(), TypoScriptFrontendController\fetch_the_id(), TypoScriptFrontendController\getConfigArray(), and TypoScriptFrontendController\getPageAndRootline().

checkRootlineForIncludeSection ( )

Checks the current rootline for defined sections.

Returns: bool private

Definition at line 1748 of file TypoScriptFrontendController.php.

Referenced by TypoScriptFrontendController\getPageAndRootline().

checkTranslatedShortcut ( )

protected

Checks whether a translated shortcut page has a different shortcut target than the original language page. If that is the case, things get corrected to follow that alternative shortcut

Returns: void

Definition at line 2841 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\fetch_the_id(), and TypoScriptFrontendController\getPageShortcut().

Referenced by TypoScriptFrontendController\settingLanguage().

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 bootstrap initializeGlobalTimeVariables(). Alter it by adding or subtracting seconds.

Returns: void

Definition at line 1189 of file TypoScriptFrontendController.php.

References $GLOBALS.

Referenced by TypoScriptFrontendController\determineId().

clearPageCacheContent ( )

Clears cache content (for $this->newHash)

Returns: void

Definition at line 3224 of file TypoScriptFrontendController.php.

Referenced by TypoScriptFrontendController\generatePage_postProcessing(), and TypoScriptFrontendController\reqCHash().

clearPageCacheContent_pidList ( $pidList )

Clears cache content for a list of page ids

Parameters

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

Returns: void

Definition at line 3235 of file TypoScriptFrontendController.php.

References GeneralUtility\trimExplode().

connectToDB ( )

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

Exceptions

\RuntimeException
ServiceUnavailableException

Returns: void

Definition at line 967 of file TypoScriptFrontendController.php.

References GeneralUtility\callUserFunction(), TypoScriptFrontendController\checkPageUnavailableHandler(), TypoScriptFrontendController\getDatabaseConnection(), TypoScriptFrontendController\pageUnavailableAndExit(), and GeneralUtility\SYSLOG_SEVERITY_ERROR.

contentStrReplace ( )

Substitute various tokens in content. This should happen only if the content is not cached by proxies or client browsers.

Returns: void

Definition at line 3822 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\$getMethodUrlIdToken, and GeneralUtility\callUserFunction().

Referenced by TypoScriptFrontendController\processOutput().

convOutputCharset ( $content )

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

Parameters

string $content Content to be converted.

Returns: string Converted content string.

Definition at line 4644 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\$content.

Referenced by TypoScriptFrontendController\generatePage_postProcessing(), and TypoScriptFrontendController\INTincScript_process().

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 4657 of file TypoScriptFrontendController.php.

References $GLOBALS.

createHashBase ( $createLockHashBase = false )

protected

Calculates the cache-hash (or the lock-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.

Parameters

bool $createLockHashBase Whether to create the lock hash, which doesn't contain the "this->all" (the template information)

Returns: string the serialized hash base

Definition at line 2536 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\$all, and GeneralUtility\callUserFunction().

Referenced by TypoScriptFrontendController\getHash(), and TypoScriptFrontendController\getLockHash().

csConv	(	$str,
		$from = `''`
	)

Converts the charset of the input string if applicable. The "to" charset is determined by the currently used charset for the page which is "utf-8" by default or set by $GLOBALS['TSFE']->config['config']['renderCharset'] 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	$str	String to convert charset for
string	$from	Optional "from" charset.

Returns: string Output string, converted if needed.

See Also: CharsetConverter

Definition at line 4628 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\$renderCharset.

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 1273 of file TypoScriptFrontendController.php.

determineIdIsHiddenPage ( )

protected

Checks if the page is hidden in the active workspace. If it is hidden, preview flags will be set.

Returns: bool

Definition at line 1415 of file TypoScriptFrontendController.php.

References $GLOBALS, TypoScriptFrontendController\$page, MathUtility\canBeInterpretedAsInteger(), TypoScriptFrontendController\getDatabaseConnection(), GeneralUtility\makeInstance(), and TypoScriptFrontendController\whichWorkspace().

Referenced by TypoScriptFrontendController\determineId().

disableCache ( )

protected

Disables caching of the current page.

Returns: void

Definition at line 4409 of file TypoScriptFrontendController.php.

Referenced by TypoScriptFrontendController\__construct(), TypoScriptFrontendController\determineId(), TypoScriptFrontendController\makeCacheHash(), TypoScriptFrontendController\prefixLocalAnchorsWithScript(), TypoScriptFrontendController\reqCHash(), and TypoScriptFrontendController\set_no_cache().

doLocalAnchorFix ( )

Returns the mode of Local Anchor prefixing

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

Deprecated:: The TypoScript option "config.prefixLocalAnchors" and the according method in TSFE have been deprecated with TYPO3 CMS 7 and will be removed with TYPO3 CMS 8.

Definition at line 3648 of file TypoScriptFrontendController.php.

domainNameMatchesCurrentRequest ( $domainName )

Whether the given domain name (potentially including a path segment) matches currently requested host or the host including the path segment

Parameters

string $domainName

Returns: bool

Definition at line 4838 of file TypoScriptFrontendController.php.

References GeneralUtility\getIndpEnv().

doWorkspacePreview ( )

Returns TRUE if workspace preview is enabled

Returns: bool Returns TRUE if workspace preview is enabled

Definition at line 4182 of file TypoScriptFrontendController.php.

Referenced by TypoScriptFrontendController\determineId(), TypoScriptFrontendController\processOutput(), TypoScriptFrontendController\sendCacheHeaders(), and TypoScriptFrontendController\whichWorkspace().

doXHTML_cleaning ( )

Returns the mode of XHTML cleaning

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

Deprecated:: since TYPO3 CMS 7, will be removed in TYPO3 CMS 8; The TypoScript option "config.xhtml_cleaning" has been deprecated

Definition at line 3636 of file TypoScriptFrontendController.php.

References GeneralUtility\callUserFunction(), TypoScriptFrontendController\clearPageCacheContent(), TypoScriptFrontendController\convOutputCharset(), elseif, GeneralUtility\getUserObj(), TypoScriptFrontendController\realPageCacheContent(), TypoScriptFrontendController\set_no_cache(), and TypoScriptFrontendController\setSysLastChanged().

encryptCharcode	(	$n,
		$start,
		$end,
		$offset
	)

Encryption (or decryption) of a single character. Within the given range the character is shifted with the supplied offset.

Parameters

int	$n	Ordinal of input character
int	$start	Start of range
int	$end	End of range
int	$offset	Offset

Returns: string encoded/decoded version of character

Definition at line 3976 of file TypoScriptFrontendController.php.

References elseif.

Referenced by TypoScriptFrontendController\encryptEmail().

encryptEmail	(	$string,
		$back = `false`
	)

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

Parameters

string	$string	Input string to en/decode: "blabl.nosp@m.a@bl.nosp@m.a.com
bool	$back	If set, the process is reversed, effectively decoding, not encoding.

Returns: string encoded/decoded version of $string

Definition at line 3994 of file TypoScriptFrontendController.php.

References elseif, and TypoScriptFrontendController\encryptCharcode().

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

Exceptions

ServiceUnavailableException

Returns: void private

Definition at line 1443 of file TypoScriptFrontendController.php.

Referenced by TypoScriptFrontendController\checkTranslatedShortcut(), and TypoScriptFrontendController\determineId().

findDomainRecord ( $recursive = false )

Looking up a domain record based on HTTP_HOST

Parameters

bool $recursive 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: int Returns the page id of the page where the domain record was found. private

Definition at line 1969 of file TypoScriptFrontendController.php.

References GeneralUtility\getIndpEnv().

Referenced by TypoScriptFrontendController\fetch_the_id().

generatePage_postProcessing ( )

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

Returns: void

Definition at line 3397 of file TypoScriptFrontendController.php.

generatePage_preProcessing ( )

Does some processing BEFORE the pagegen script is included.

Returns: void

Definition at line 3354 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\$no_cache, TypoScriptFrontendController\getHash(), TypoScriptFrontendController\releaseLock(), and TypoScriptFrontendController\tempPageCacheContent().

generatePage_whichScript ( )

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

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

Definition at line 3383 of file TypoScriptFrontendController.php.

getBackendUser ( )

protected

Returns the current BE user.

Returns

Definition at line 4976 of file TypoScriptFrontendController.php.

References $GLOBALS.

Referenced by TypoScriptFrontendController\checkRootlineForIncludeSection(), TypoScriptFrontendController\determineId(), and TypoScriptFrontendController\whichWorkspace().

getConfigArray ( )

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

Exceptions

ServiceUnavailableException

Returns: void

Definition at line 2569 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\$forceTemplateParsing, TypoScriptFrontendController\$type, GeneralUtility\_GET(), GeneralUtility\_GETset(), GeneralUtility\callUserFunction(), TypoScriptFrontendController\checkPageUnavailableHandler(), TypoScriptFrontendController\getTimeTracker(), ArrayUtility\mergeRecursiveWithOverrule(), TypoScriptFrontendController\pageUnavailableAndExit(), GeneralUtility\removeDotsFromTS(), TypoScriptFrontendController\set_no_cache(), and GeneralUtility\SYSLOG_SEVERITY_ERROR.

getCurrentPageCacheConfiguration ( )

protected

Obtains a list of table/pid pairs to consider for page caching.

TS configuration looks like this:

The cache lifetime of all pages takes starttime and endtime of news records of page 14 into account: config.cache.all = tt_news:14

The cache lifetime of page 42 takes starttime and endtime of news records of page 15 and addresses of page 16 into account: config.cache.42 = tt_news:15,tt_address:16

Returns: array Array of 'tablename:pid' pairs. There is at least a current page id in the array

See Also: TypoScriptFrontendController::calculatePageCacheTimeout()

Definition at line 4702 of file TypoScriptFrontendController.php.

References GeneralUtility\trimExplode().

Referenced by TypoScriptFrontendController\calculatePageCacheTimeout().

getDatabaseConnection ( )

protected

Returns the database connection

Returns

Definition at line 4986 of file TypoScriptFrontendController.php.

References $GLOBALS.

Referenced by TypoScriptFrontendController\checkRootlineForIncludeSection(), TypoScriptFrontendController\connectToDB(), TypoScriptFrontendController\determineIdIsHiddenPage(), TypoScriptFrontendController\initFEuser(), TypoScriptFrontendController\sendRedirect(), TypoScriptFrontendController\setSysLastChanged(), TypoScriptFrontendController\updateMD5paramsRecord(), and TypoScriptFrontendController\whichWorkspace().

getDocumentTemplate ( )

protected

Returns an instance of DocumentTemplate

Returns

Definition at line 5004 of file TypoScriptFrontendController.php.

References $GLOBALS.

getDomainDataForPid ( $targetPid )

Obtains domain data for the target pid. Domain data is an array with 'pid', 'domainName' and 'forced' members (see sys_domain table for meaning of these fields.

Parameters

int $targetPid Target page id

Returns: mixed Return domain data or NULL

Definition at line 4853 of file TypoScriptFrontendController.php.

Referenced by TypoScriptFrontendController\getDomainNameForPid().

getDomainNameForPid ( $targetPid )

Obtains the domain name for the target pid. If there are several domains, the first is returned.

Parameters

int $targetPid Target page id

Returns: mixed Return domain name or NULL if not found

Definition at line 4883 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\getDomainDataForPid().

getFirstTimeValueForRecord	(	$tableDef,
		$now
	)

protected

Find the minimum starttime or endtime value in the table and pid that is greater than the current time.

Parameters

string	$tableDef	Table definition (format tablename:pid)
int	$now	"Now" time value

Exceptions

\InvalidArgumentException

Returns: int Value of the next start/stop time or PHP_INT_MAX if not found

See Also: TypoScriptFrontendController::calculatePageCacheTimeout()

Definition at line 4723 of file TypoScriptFrontendController.php.

References $GLOBALS, and GeneralUtility\trimExplode().

Referenced by TypoScriptFrontendController\calculatePageCacheTimeout().

getFromCache ( )

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

Exceptions

\InvalidArgumentException
\RuntimeException

Definition at line 2341 of file TypoScriptFrontendController.php.

References $GLOBALS, TypoScriptFrontendController\acquireLock(), GeneralUtility\callUserFunction(), TypoScriptFrontendController\getFromCache_queryRow(), TypoScriptFrontendController\getHash(), TypoScriptFrontendController\getLockHash(), TypoScriptFrontendController\getTimeTracker(), TypoScriptFrontendController\headerNoCache(), and TypoScriptFrontendController\releaseLock().

getFromCache_queryRow ( )

Returning the cached version of page with hash = newHash

Returns: array Cached row, if any. Otherwise void.

Definition at line 2465 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\getTimeTracker().

Referenced by TypoScriptFrontendController\getFromCache(), and TypoScriptFrontendController\tempPageCacheContent().

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 serialized hash base from createHashBase() private

See Also: getFromCache(), getLockHash()

Definition at line 2507 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\createHashBase().

Referenced by TypoScriptFrontendController\generatePage_preProcessing(), and TypoScriptFrontendController\getFromCache().

getLLL	(	$index,
		$LOCAL_LANG
	)

Returns 'locallang' label - may need initializing by initLLvars

Parameters

string	$index	Local_lang key for which to return label (language is determined by $this->lang)
array	$LOCAL_LANG	The locallang array in which to search

Returns: string Label value of $index key.

Definition at line 4574 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\$lang, and elseif.

Referenced by TypoScriptFrontendController\sL().

getLockHash ( )

Calculates the lock-hash This hash is unique to the above hash, except that it doesn't contain the template information in $this->all.

Returns: string MD5 hash private

See Also: getFromCache(), getHash()

Definition at line 2520 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\createHashBase().

Referenced by TypoScriptFrontendController\getFromCache().

getPageAccessFailureReasons ( )

Analysing $this->pageAccessFailureHistory into a summary array telling which features disabled display and on which pages and conditions. That data can be used inside a page-not-found handler

Returns: array Summary of why page access was not allowed.

Definition at line 1876 of file TypoScriptFrontendController.php.

References $GLOBALS, and TypoScriptFrontendController\checkPageGroupAccess().

Referenced by TypoScriptFrontendController\pageErrorHandler().

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

Exceptions

ServiceUnavailableException
PageNotFoundException

Returns: void private

Definition at line 1558 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\$page, TypoScriptFrontendController\checkPageUnavailableHandler(), TypoScriptFrontendController\checkRootlineForIncludeSection(), PageRepository\DOKTYPE_MOUNTPOINT, PageRepository\DOKTYPE_SHORTCUT, PageRepository\DOKTYPE_SPACER, TypoScriptFrontendController\getPageShortcut(), TypoScriptFrontendController\pageNotFoundAndExit(), TypoScriptFrontendController\pageUnavailableAndExit(), GeneralUtility\SYSLOG_SEVERITY_ERROR, and TypoScriptFrontendController\whichWorkspace().

Referenced by TypoScriptFrontendController\getPageAndRootlineWithDomain().

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

int $domainStartPage Page uid of the page where the found domain record is (pid of the domain record)

Returns: void private

Definition at line 1928 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\$domainStartPage, and TypoScriptFrontendController\getPageAndRootline().

Referenced by TypoScriptFrontendController\fetch_the_id().

getPageRenderer ( )

Gets instance of PageRenderer

Returns: PageRenderer

Deprecated:: since TYPO3 CMS 7, will be removed in TYPO3 CMS 8.

Definition at line 1033 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\$pageRenderer, TypoScriptFrontendController\initPageRenderer(), and GeneralUtility\logDeprecatedFunction().

getPageShortcut	(	$SC,
		$mode,
		$thisUid,
		$itera = `20`,
		$pageLog = `array()`,
		$disableGroupCheck = `false`
	)

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

Parameters

int	$SC	The value of the "shortcut" field from the pages record
int	$mode	The shortcut mode: 1 will select first subpage, 2 a random subpage, 3 the parent page; default is the page pointed to by $SC
int	$thisUid	The current page UID of the page which is a shortcut
int	$itera	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	$pageLog	An array filled with previous page uids tested by the function - new page uids are evaluated against this to avoid going in circles.
bool	$disableGroupCheck	If true, the group check is disabled when fetching the target page (needed e.g. for menu generation)

Exceptions

\RuntimeException
PageNotFoundException

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

See Also: getPageAndRootline()

Definition at line 1683 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\$page, PageRepository\DOKTYPE_BE_USER_SECTION, PageRepository\DOKTYPE_SHORTCUT, GeneralUtility\intExplode(), PageRepository\SHORTCUT_MODE_FIRST_SUBPAGE, PageRepository\SHORTCUT_MODE_PARENT_PAGE, PageRepository\SHORTCUT_MODE_RANDOM_SUBPAGE, and GeneralUtility\SYSLOG_SEVERITY_ERROR.

Referenced by TypoScriptFrontendController\checkTranslatedShortcut(), and TypoScriptFrontendController\getPageAndRootline().

getPagesTSconfig ( )

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

Returns: array

Definition at line 4269 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\$pagesTSconfig, TypoScriptParser\checkIncludeLines_array(), and GeneralUtility\makeInstance().

getRequestedId ( )

Fetches the originally requested id, fallsback to $this->id

Returns: int the originally requested page uid

See Also: fetch_the_id()

Definition at line 4895 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\$id.

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 occurrences found.

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8. The usage of "storage_pid" is discouraged, the option for "is_siteroot" is handled via the RootlineUtility directly.

Definition at line 4246 of file TypoScriptFrontendController.php.

getTimeTracker ( )

protected

Returns

Definition at line 4994 of file TypoScriptFrontendController.php.

References $GLOBALS.

getUniqueId ( $desired = '' )

Returns a unique id to be used as a XML ID (in HTML / XHTML mode)

Parameters

string $desired The desired id. If already used it is suffixed with a number

Returns: string The unique id

Definition at line 4478 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\uniqueHash().

handleDataSubmission ( )

Handle data submission This is done at this point, because we need the config values

Returns: void

Definition at line 2864 of file TypoScriptFrontendController.php.

References GeneralUtility\getUserObj().

headerNoCache ( )

Detecting if shift-reload has been clicked Will not be called if re-generation of page happens by other reasons (for instance that the page is not in cache yet!) Also, a backend user MUST be logged in for the shift-reload to be detected due to DoS-attack-security reasons.

Returns: bool If shift-reload in client browser has been clicked, disable getting cached page (and regenerate it).

Definition at line 2480 of file TypoScriptFrontendController.php.

Referenced by TypoScriptFrontendController\acquirePageGenerationLock(), TypoScriptFrontendController\getFromCache(), TypoScriptFrontendController\releasePageGenerationLock(), and TypoScriptFrontendController\tempPageCacheContent().

hook_eofe ( )

End-Of-Frontend hook

Returns: void

Definition at line 3913 of file TypoScriptFrontendController.php.

includeLibraries ( array $libraries )

Includes a comma-separated list of library files by PHP function include_once.

Parameters

array $libraries The libraries to be included.

Returns: void

Todo:: deprecate this method

Definition at line 4219 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\getTimeTracker().

Referenced by TypoScriptFrontendController\INTincScript_includeLibs().

initCaches ( )

protected

Initializes the caching system.

Returns: void

Definition at line 1051 of file TypoScriptFrontendController.php.

Referenced by TypoScriptFrontendController\__construct().

initFEuser ( )

Initializes the front-end login user.

Returns: void

Definition at line 1061 of file TypoScriptFrontendController.php.

References $GLOBALS, GeneralUtility\_GP(), GeneralUtility\callUserFunction(), FrontendUserAuthentication\getCookieName(), TypoScriptFrontendController\getDatabaseConnection(), and GeneralUtility\makeInstance().

initPageRenderer ( )

protected

Initializes the page renderer object

Definition at line 940 of file TypoScriptFrontendController.php.

Referenced by TypoScriptFrontendController\__construct(), and TypoScriptFrontendController\getPageRenderer().

initTemplate ( )

Initialize the TypoScript template parser

Returns: void

Definition at line 2326 of file TypoScriptFrontendController.php.

initUserGroups ( )

Initializes the front-end user groups. Sets ->loginUser and ->gr_list based on front-end user status.

Returns: void

Definition at line 1114 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\$showHiddenRecords, and GeneralUtility\devLog().

Referenced by TypoScriptFrontendController\fetch_the_id().

INTincScript_includeLibs ( $INTiS_config )

protected

Include libraries for uncached objects.

Parameters

array $INTiS_config $GLOBALS['TSFE']->config['INTincScript'] or part of it

Returns: void

See Also: INTincScript()

Definition at line 3526 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\includeLibraries(), and GeneralUtility\trimExplode().

Referenced by TypoScriptFrontendController\recursivelyReplaceIntPlaceholdersInContent().

INTincScript_loadJSCode ( )

Loads the JavaScript code for INTincScript

Returns: void

Definition at line 3590 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\$additionalCSS, and TypoScriptFrontendController\$additionalJavaScript.

INTincScript_process ( $INTiS_config )

protected

Processes the INTinclude-scripts and substitue in content.

Parameters

array $INTiS_config $GLOBALS['TSFE']->config['INTincScript'] or part of it

Returns: void

See Also: INTincScript()

Definition at line 3543 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\convOutputCharset(), and TypoScriptFrontendController\getTimeTracker().

Referenced by TypoScriptFrontendController\recursivelyReplaceIntPlaceholdersInContent().

isBackendUserLoggedIn ( )

Checks if a backend user is logged in

Returns: bool whether a backend user is logged in

Definition at line 1203 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\$beUserLogin.

isGeneratePage ( )

Returns TRUE if the page should be generated. That is if no URL handler is active and the cacheContentFlag is not set.

Returns: bool

Definition at line 3082 of file TypoScriptFrontendController.php.

isINTincScript ( )

Determines if there are any INTincScripts to include.

Returns: bool Returns TRUE if scripts are found and no URL handler is active.

Definition at line 3625 of file TypoScriptFrontendController.php.

Referenced by TypoScriptFrontendController\isStaticCacheble(), and TypoScriptFrontendController\sendCacheHeaders().

isOutputting ( )

Determines if content should be outputted. Outputting content is done only if no URL handler is active and no hook disables the output.

Returns: bool Returns TRUE if no redirect URL is set and no hook disables the output.

Definition at line 3665 of file TypoScriptFrontendController.php.

isStaticCacheble ( )

Reporting status whether we can send cache control headers for proxy caching or publishing to static files

Rules are: no_cache cannot be set: If it is, the page might contain dynamic content and should never be cached. There can be no USER_INT objects on the page ("isINTincScript()") because they implicitly indicate dynamic content There can be no logged in user because user sessions are based on a cookie and thereby does not offer client caching a chance to know if the user is logged in. Actually, there will be a reverse problem here; If a page will somehow change when a user is logged in he may not see it correctly if the non-login version sent a cache-header! So do NOT use cache headers in page sections where user logins change the page content. (unless using such as realurl to apply a prefix in case of login sections)

Returns: bool

Definition at line 3811 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\isINTincScript(), and TypoScriptFrontendController\isUserOrGroupSet().

Referenced by TypoScriptFrontendController\sendCacheHeaders().

isUserOrGroupSet ( )

Checking if a user is logged in or a group constellation different from "0,-1"

Returns: bool TRUE if either a login user is found (array fe_user->user) OR if the gr_list is set to something else than '0,-1' (could be done even without a user being logged in!)

Definition at line 1156 of file TypoScriptFrontendController.php.

Referenced by TypoScriptFrontendController\determineId(), and TypoScriptFrontendController\isStaticCacheble().

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)

"jumpUrl" is a concept where external links are redirected from the TYPO3 Frontend, but first logs the URL.

Exceptions

\Exception

Returns: void

Deprecated:: since TYPO3 CMS 7, will be removed in TYPO3 CMS 8. JumpURL handling is moved to extensions.

Definition at line 2933 of file TypoScriptFrontendController.php.

References GeneralUtility\logDeprecatedFunction(), and TypoScriptFrontendController\redirectToExternalUrl().

logDeprecatedTyposcript	(	$typoScriptProperty,
		$explanation = `''`
	)

Logs access to deprecated TypoScript objects and properties.

Dumps message to the TypoScript message log (admin panel) and the TYPO3 deprecation log.

Parameters

string	$typoScriptProperty	Deprecated object or property
string	$explanation	Message or additional information

Returns: void

Definition at line 4125 of file TypoScriptFrontendController.php.

References GeneralUtility\deprecationLog(), and TypoScriptFrontendController\getTimeTracker().

makeCacheHash ( )

Calculates a hash string based on additional parameters in the url.

Calculated hash is stored in $this->cHash_array. This is used to cache pages with more parameters than just id and type.

Returns: void

See Also: reqCHash()

Definition at line 2273 of file TypoScriptFrontendController.php.

References GeneralUtility\_GET(), TypoScriptFrontendController\disableCache(), elseif, TypoScriptFrontendController\getTimeTracker(), GeneralUtility\implodeArrayForUrl(), TypoScriptFrontendController\pageNotFoundAndExit(), and TypoScriptFrontendController\reqCHash().

mergingWithGetVars ( $GET_VARS )

Merging values into the global $_GET

Parameters

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

Returns: void

Definition at line 2227 of file TypoScriptFrontendController.php.

References GeneralUtility\_GET(), GeneralUtility\_GETset(), ArrayUtility\mergeRecursiveWithOverrule(), and TypoScriptFrontendController\set_no_cache().

newCObj ( )

Creates an instance of ContentObjectRenderer 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 4045 of file TypoScriptFrontendController.php.

Referenced by TypoScriptFrontendController\prefixLocalAnchorsWithScript().

pageErrorHandler	(	$code,
		$header = `''`,
		$reason = `''`
	)

Generic error page handler. Exits.

Parameters

mixed	$code	Which type of handling; If a true PHP-boolean or TRUE then a 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	$header	If set, this is passed directly to the PHP function, header()
string	$reason	If set, error messages will also mention this as the reason for the page-not-found.

Exceptions

\RuntimeException

Returns: void (The function exits!)

Definition at line 2074 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\$content, GeneralUtility\callUserFunction(), elseif, GeneralUtility\getFileAbsFileName(), GeneralUtility\getIndpEnv(), TypoScriptFrontendController\getPageAccessFailureReasons(), GeneralUtility\getUrl(), GeneralUtility\isFirstPartOfStr(), GeneralUtility\makeInstance(), and HttpUtility\redirect().

Referenced by TypoScriptFrontendController\pageNotFoundHandler(), and TypoScriptFrontendController\pageUnavailableHandler().

pageNotFoundAndExit	(	$reason = `''`,
		$header = `''`
	)

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

Parameters

string	$reason	Reason text
string	$header	HTTP header to send

Returns: void Function exits.

Definition at line 2009 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\pageNotFoundHandler().

Referenced by TypoScriptFrontendController\fetch_the_id(), TypoScriptFrontendController\getPageAndRootline(), TypoScriptFrontendController\makeCacheHash(), TypoScriptFrontendController\reqCHash(), and TypoScriptFrontendController\settingLanguage().

pageNotFoundHandler	(	$code,
		$header = `''`,
		$reason = `''`
	)

Page not found handler. Acts a wrapper for the pageErrorHandler method.

Parameters

mixed	$code	Which type of handling; If a true PHP-boolean or TRUE then a 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	$header	If set, this is passed directly to the PHP function, header()
string	$reason	If set, error messages will also mention this as the reason for the page-not-found.

Returns: void (The function exits!)

Definition at line 2059 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\pageErrorHandler().

Referenced by TypoScriptFrontendController\pageNotFoundAndExit().

pageUnavailableAndExit	(	$reason = `''`,
		$header = `''`
	)

Page unavailable handler for use in frontend plugins from extensions.

Parameters

string	$reason	Reason text
string	$header	HTTP header to send

Returns: void Function exits.

Definition at line 1995 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\pageUnavailableHandler().

Referenced by TypoScriptFrontendController\connectToDB(), TypoScriptFrontendController\fetch_the_id(), TypoScriptFrontendController\getConfigArray(), and TypoScriptFrontendController\getPageAndRootline().

pageUnavailableHandler	(	$code,
		$header,
		$reason
	)

Page unavailable handler. Acts a wrapper for the pageErrorHandler method.

Parameters

mixed	$code	Which type of handling; If a true PHP-boolean or TRUE then a 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	$header	If set, this is passed directly to the PHP function, header()
string	$reason	If set, error messages will also mention this as the reason for the page-not-found.

Returns: void (The function exits!)

Definition at line 2046 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\pageErrorHandler().

Referenced by TypoScriptFrontendController\pageUnavailableAndExit().

prefixLocalAnchorsWithScript ( )

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

Returns: void Works directly on $this->content

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8

Definition at line 4150 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\$content, TypoScriptFrontendController\disableCache(), GeneralUtility\getIndpEnv(), GeneralUtility\logDeprecatedFunction(), TypoScriptFrontendController\newCObj(), and GeneralUtility\SYSLOG_SEVERITY_FATAL.

previewInfo ( )

Outputs preview info.

Returns: void

Definition at line 3894 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\addTempContentHttpHeaders(), GeneralUtility\callUserFunction(), TypoScriptFrontendController\contentStrReplace(), GeneralUtility\deprecationLog(), TypoScriptFrontendController\doWorkspacePreview(), and TypoScriptFrontendController\sendCacheHeaders().

processOutput ( )

Process the output before it's actually outputted. Sends headers also.

This includes substituting the "username" comment, sending additional headers (as defined in the TypoScript "config.additionalheaders" object), XHTML cleaning content (if configured) Works on $this->content.

Returns: void

Definition at line 3688 of file TypoScriptFrontendController.php.

realPageCacheContent ( )

Set cache content to $this->content

Returns: void

Definition at line 3151 of file TypoScriptFrontendController.php.

References $GLOBALS, GeneralUtility\getUserObj(), and TypoScriptFrontendController\setPageCacheContent().

Referenced by TypoScriptFrontendController\generatePage_postProcessing().

recursivelyReplaceIntPlaceholdersInContent ( )

protected

Replaces INT placeholders (COA_INT and USER_INT) in $this->content In case the replacement adds additional placeholders, it loops until no new placeholders are found any more.

Definition at line 3507 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\INTincScript_includeLibs(), and TypoScriptFrontendController\INTincScript_process().

redirectToExternalUrl ( )

Loops over all registered URL handlers and lets them process the current URL.

If no handler has stopped the current process (e.g. by redirecting) and a the redirectUrl propert is not empty, the user will be redirected to this URL.

Definition at line 2947 of file TypoScriptFrontendController.php.

Referenced by TypoScriptFrontendController\jumpUrl().

regeneratePageTitle ( )

protected

Generate the page title again as TSFE->altPageTitle might have been modified by an inc script

Returns: void

Definition at line 3450 of file TypoScriptFrontendController.php.

releaseLock ( $type )

protected

Release a page specific lock

Parameters

string $type

Exceptions

\InvalidArgumentException
\RuntimeException
\TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException

Definition at line 4955 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\$type.

Referenced by TypoScriptFrontendController\generatePage_preProcessing(), TypoScriptFrontendController\getFromCache(), and TypoScriptFrontendController\releaseLocks().

releaseLocks ( )

Release pending locks

Definition at line 3326 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\releaseLock().

releasePageGenerationLock ( & $lockObj )

Release the page generation lock

Parameters

Locker $lockObj Reference to a locking object

Returns: bool Returns TRUE on success, FALSE otherwise

See Also: acquirePageGenerationLock()

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8

Definition at line 3305 of file TypoScriptFrontendController.php.

References elseif, Locker\getLockStatus(), TypoScriptFrontendController\headerNoCache(), and GeneralUtility\logDeprecatedFunction().

reqCHash ( )

Will disable caching if the cHash value was not set. This function should be called to check the existence of "&cHash" whenever a plugin generating cacheable output is using extra GET variables. If there is a cHash value the validation of it automatically takes place in makeCacheHash() (see above)

Returns: void

See Also: makeCacheHash(), ::pi_cHashCheck()

Definition at line 2306 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\clearPageCacheContent(), TypoScriptFrontendController\disableCache(), TypoScriptFrontendController\getTimeTracker(), and TypoScriptFrontendController\pageNotFoundAndExit().

Referenced by TypoScriptFrontendController\makeCacheHash().

sendCacheHeaders ( )

Send cache headers good for client/reverse proxy caching This function should not be called if the page content is temporary (like for "Page is being generated..." message, but in that case it is ok because the config-variables are not yet available and so will not allow to send cache headers)

Returns: void -author Ole Tange, Forbrugernes Hus, Denmark

Definition at line 3759 of file TypoScriptFrontendController.php.

References $GLOBALS, TypoScriptFrontendController\doWorkspacePreview(), TypoScriptFrontendController\getTimeTracker(), TypoScriptFrontendController\isINTincScript(), and TypoScriptFrontendController\isStaticCacheble().

Referenced by TypoScriptFrontendController\processOutput().

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 1014 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\getDatabaseConnection(), and TypoScriptFrontendController\updateMD5paramsRecord().

set_cache_timeout_default ( $seconds )

Sets the cache-timeout in seconds

Parameters

int $seconds Cache-timeout in seconds

Returns: void

Definition at line 4420 of file TypoScriptFrontendController.php.

set_no_cache	(	$reason = `''`,
		$internal = `false`
	)

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

Parameters

string	$reason	An optional reason to be written to the syslog.
bool	$internal	Whether the call is done from core itself (should only be used by core).

Returns: void

Definition at line 4369 of file TypoScriptFrontendController.php.

References $GLOBALS, StringUtility\beginsWith(), TypoScriptFrontendController\disableCache(), TypoScriptFrontendController\getTimeTracker(), GeneralUtility\SYSLOG_SEVERITY_NOTICE, and GeneralUtility\SYSLOG_SEVERITY_WARNING.

Referenced by TypoScriptFrontendController\fetch_the_id(), TypoScriptFrontendController\generatePage_postProcessing(), TypoScriptFrontendController\getConfigArray(), TypoScriptFrontendController\mergingWithGetVars(), and TypoScriptFrontendController\tempPageCacheContent().

setContentType ( $contentType )

Parameters

string $contentType

Definition at line 954 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\$contentType.

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

Definition at line 4343 of file TypoScriptFrontendController.php.

References TypoScriptFrontendController\$content.

setExternalJumpUrl ( )

Checks if the current page points to an external URL and stores this value in the redirectUrl variable. The redirection will then be handled by the redirectToExternalUrl() method.

Returns: void

Deprecated:: since TYPO3 CMS 7, will be removed in TYPO3 CMS 8. See handleExternalUrlPage()

Definition at line 2917 of file TypoScriptFrontendController.php.