TypoScriptFrontendController implements LoggerAwareInterface uses LoggerAwareTrait, PublicPropertyDeprecationTrait

Class for the built TypoScript based frontend. Instantiated in \TYPO3\CMS\Frontend\Http\RequestHandler as the global object TSFE.

Table of Contents

Interfaces

LoggerAwareInterface

Properties

$absRefPrefix  : string

Absolute Reference prefix

$accessKey  : array<string|int, mixed>

Used by class \TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject to keep track of access-keys.

$additionalFooterData  : array<string|int, mixed>

Used to accumulate additional HTML-code for the footer-section of the template

$additionalHeaderData  : array<string|int, mixed>

Eg. insert JS-functions in this array ($additionalHeaderData) to include them once. Use associative keys.

$all  : array<string|int, mixed>

Used by template fetching system. This array is an identification of the template. If $this->all is empty it's because the template-data is not cached, which it must be.

$applicationData  : array<string|int, mixed>

'Global' Storage for various applications. Keys should be 'tx_'.extKey for extensions.

$baseUrl  : string

The base URL set for the page header.

$cObj  : ContentObjectRenderer

Page content render object

$cObjectDepthCounter  : int

Checking that the function is not called eternally. This is done by interrupting at a depth of 50

$config  : array<string|int, mixed>

"CONFIG" object from TypoScript. Array generated based on the TypoScript configuration of the current page. Saved with the cached pages.

$content  : string

All page content is accumulated in this variable. See RequestHandler

$contentPid  : int

This will normally point to the same value as id, but can be changed to point to another page from which content will then be displayed instead.

$currentRecord  : string

This is set to the [table]:[uid] of the latest record rendered. Note that class ContentObjectRenderer has an equal value, but that is pointing to the record delivered in the $data-array of the ContentObjectRenderer instance, if the cObjects CONTENT or RECORD created that instance

$displayEditIcons  : string

If set, edit icons are rendered aside content records. Must be set only if the ->beUserLogin flag is set and set_no_cache() must be called as well.

$displayFieldEditIcons  : string

If set, edit icons are rendered aside individual fields of content. Must be set only if the ->beUserLogin flag is set and set_no_cache() must be called as well.

$extTarget  : string

Default external target

$fe_user  : FrontendUserAuthentication

The frontend user

$fileTarget  : string

Default file link target

$id  : string|int

The page id (int)

$indexedDocTitle  : string

This value will be used as the title for the page in the indexer (if indexing happens)

$intTarget  : string

Default internal target

$lastImgResourceInfo  : array<string|int, mixed>|null

Info-array of the last resulting image resource of content object IMG_RESOURCE (if any), containing width, height and so on.

$linkVars  : string

A string prepared for insertion in all links on the page as url-parameters.

$metaCharset  : string

Output charset of the websites content. This is the charset found in the header, meta tag etc. If different than utf-8 a conversion happens before output to browser. Defaults to utf-8.

$MP  : string

$newHash  : string

This hash is unique to the template, the $this->id and $this->type vars and the list of groups. Used to get and later store the cached data

$no_cache  : bool

Page will not be cached. Write only TRUE. Never clear value (some other code might have reasons to set it TRUE).

$page  : array<string|int, mixed>

The pagerecord

$pageNotFound  : int

Is set to 1 if a pageNotFound handler could have been called.

$pSetup  : array<string|int, mixed>|string

TypoScript configuration of the page-object pointed to by sPre.

$recordRegister  : array<string|int, mixed>

Used by RecordContentObject and ContentContentObject to ensure the a records is NOT rendered twice through it!

$register  : array<string|int, mixed>

$registerStack  : array<string|int, mixed>

Stack used for storing array and retrieving register arrays (see LOAD_REGISTER and RESTORE_REGISTER)

$rootLine  : array<string|int, mixed>

The rootLine (all the way to tree root, not only the current site!)

$simUserGroup  : int

Value that contains the simulated usergroup if any

$spamProtectEmailAddresses  : string|int

If set, typolink() function encrypts email addresses.

$sPre  : string

Toplevel - objArrayName, eg 'page'

$sWordList  : string

Is set to the incoming array sword_list in case of a page-view jumped to from a search-result.

$sWordRegEx  : string

Search word regex, calculated if there has been search-words send. This is used to mark up the found search words on a page when jumped to from a link in a search-result.

$sys_page  : PageRepository|string

sys_page-object, pagefunctions

$tmpl  : TemplateService

The TypoScript template object. Used to parse the TypoScript template

$type  : int|string

The type (read-only)

$xhtmlDoctype  : string

Doctype to use

$xhtmlVersion  : int

$ATagParams  : string

<A>-tag parameters

$cacheContentFlag  : bool

Set internally if cached content is fetched from the database.

$cacheExpires  : int

Set to the expire time of cached content

$cacheTimeOutDefault  : int

Is set to the time-to-live time of cached pages. Default is 60*60*24, which is 24 hours.

$contentType  : string

Content type HTTP header being sent in the request.

$context  : Context

The context for keeping the current state, mostly related to current page information, backend user / frontend user access, workspaceId

$debugInformationHeader  : string

If debug mode is enabled, this contains the information if a page is fetched from cache, and sent as HTTP Response Header.

$isClientCachable  : bool

Set if cache headers allowing caching are sent.

$language  : SiteLanguage

$languageService  : LanguageService

Internal calculations for labels

$locks  : array<string|int, array<string|int, LockingStrategyInterface>>

$loginAllowedInBranch  : bool

Shows whether logins are allowed in branch

$loginAllowedInBranch_mode  : string

Shows specific mode (all or groups)

$no_cacheBeforePageGen  : bool

This flag is set before the page is generated IF $this->no_cache is set. If this flag is set after the page content was generated, $this->no_cache is forced to be set.

$originalMountPointPage  : array<string|int, mixed>|null

Gets set when we are processing a page of type mounpoint with enabled overlay in getPageAndRootline() Used later in checkPageForMountpointRedirect() to determine the final target URL where the user should be redirected to.

$originalShortcutPage  : array<string|int, mixed>|null

Gets set when we are processing a page of type shortcut in the early stages of the request when we do not know about languages yet, used later in the request to determine the correct shortcut in case a translation changes the shortcut target

$pageAccessFailureHistory  : array<string|int, mixed>

Array containing a history of why a requested page was not accessible.

$pageArguments  : PageArguments

$pageCache  : FrontendInterface

The page cache object, use this to save pages to the cache and to retrieve them again

$pageCacheTags  : array<string|int, mixed>

$pageRenderer  : PageRenderer

$pagesTSconfig  : array<string|int, mixed>|string

May be set to the pagesTSconfig

$requestedId  : int

Originally requested id from the initial $_GET variable

$site  : SiteInterface

$uniqueCounter  : int

Used to generate page-unique keys. Point is that uniqid() functions is very slow, so a unikey key is made based on this, see function uniqueHash()

$uniqueString  : string

Methods

__construct()  : mixed

Since TYPO3 v10.0, TSFE is composed out of - Context - Site - SiteLanguage - PageArguments (containing ID, Type, cHash and MP arguments)

__get()  : mixed

Gets the value of the property of the given name if tagged.

__isset()  : bool

Checks if the property of the given name is set.

__set()  : mixed

Sets the property of the given name if tagged.

__unset()  : mixed

Unsets the property of the given name if tagged.

addCacheTags()  : mixed

Adds tags to this page's cache entry, you can then f.e. remove cache entries by tag

applyHttpHeadersToResponse()  : ResponseInterface

Add HTTP headers to the response object.

baseUrlWrap()  : string

Prefixing the input URL with ->baseUrl If ->baseUrl is set and the input url is not absolute in some way.

calculateLinkVars()  : mixed

Calculates and sets the internal linkVars based upon the current request parameters and the setting "config.linkVars".

checkEnableFields()  : bool

Checks page record for enableFields Returns TRUE if enableFields does not disable the page record.

checkIfLoginAllowedInBranch()  : bool

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

checkPageGroupAccess()  : bool

Check group access against a page record

checkPagerecordForIncludeSection()  : bool

Checks if the current page of the root line is visible.

clear_preview()  : mixed

Clears the preview-flags, sets sim_exec_time to current time.

clearPageCacheContent()  : mixed

Clears cache content (for $this->newHash)

convOutputCharset()  : string

Converts input string from utf-8 to metaCharset IF the two charsets are different.

determineId()  : mixed

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.

doWorkspacePreview()  : bool

Returns TRUE if workspace preview is enabled

generatePage_postProcessing()  : mixed

Does processing of the content after the page content was generated.

generatePage_preProcessing()  : mixed

Does some processing BEFORE the page content is generated / built.

generatePageTitle()  : string

Generate the page title, can be called multiple times, as PageTitleProvider might have been modified by an uncached plugin etc.

get_cache_timeout()  : int

Get the cache timeout for the current page.

getConfigArray()  : mixed

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

getContext()  : Context

getFromCache()  : mixed

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

getFromCache_queryRow()  : array<string|int, mixed>

Returning the cached version of page with hash = newHash

getGlobalInstance()  : TypoScriptFrontendController

Return the global instance of this class.

getLanguage()  : SiteLanguage

getPageAccessFailureReasons()  : array<string|int, mixed>

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

getPageArguments()  : PageArguments

getPageCacheTags()  : array<string|int, mixed>

getPagesTSconfig()  : array<string|int, mixed>

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

getRedirectUriForMountPoint()  : string|null

Returns URI of target page, if the current page is an overlaid mountpoint.

getRedirectUriForShortcut()  : string|null

Returns URI of target page, if the current page is a Shortcut.

getRequestedId()  : int

Fetches the originally requested id, falls back to $this->id

getSite()  : SiteInterface

headerNoCache()  : bool

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.

initUserGroups()  : mixed

Initializes the front-end user groups.

INTincScript()  : mixed

Processes the INTinclude-scripts

INTincScript_loadJSCode()  : mixed

Loads the JavaScript/CSS code for INTincScript, if there are non-cacheable content objects it prepares the placeholders, otherwise populates options directly.

isBackendUserLoggedIn()  : bool

Checks if a backend user is logged in

isGeneratePage()  : bool

Returns TRUE if the page should be generated.

isINTincScript()  : bool

Determines if there are any INTincScripts to include = "non-cacheable" parts

isStaticCacheble()  : bool

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

isUserOrGroupSet()  : bool

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

logDeprecatedTyposcript()  : mixed

Logs access to deprecated TypoScript objects and properties.

newCObj()  : mixed

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

preparePageContentGeneration()  : mixed

Sets up TypoScript "config." options and set properties in $TSFE.

releaseLocks()  : mixed

Release pending locks

set_cache_timeout_default()  : mixed

Sets the cache-timeout in seconds

set_no_cache()  : mixed

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

setContentType()  : mixed

sL()  : string

Split Label function for front-end applications.

uniqueHash()  : string

Returns a unique md5 hash.

whichWorkspace()  : int

Returns the uid of the current workspace

acquireLock()  : mixed

Acquire a page specific lock

applyPreviewSettings()  : string|null

Evaluates admin panel or workspace settings to see if visibility settings like - Preview Aspect: isPreview - Visibility Aspect: includeHiddenPages - Visibility Aspect: includeHiddenContent - $simUserGroup should be applied to the current object.

calculatePageCacheTimeout()  : int

Calculates page cache timeout according to the records with starttime/endtime on the page.

checkRootlineForIncludeSection()  : bool

Checks if visibility of the page is blocked upwards in the root line.

checkTranslatedShortcut()  : mixed

Checks whether a translated shortcut page has a different shortcut target than the original language page.

createHashBase()  : string

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

determineIdIsHiddenPage()  : bool

Checks if the page is hidden in the active workspace.

disableCache()  : mixed

Disables caching of the current page.

fetch_the_id()  : mixed

Resolves the page id and sets up several related properties.

getAdditionalHeaders()  : array<string|int, mixed>

Send additional headers from config.additionalHeaders

getBackendUser()  : FrontendBackendUserAuthentication|null

Returns the current BE user.

getCacheHeaders()  : array<string|int, mixed>

Get cache headers good for client/reverse proxy caching.

getCurrentPageCacheConfiguration()  : array<string|int, mixed>

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

getFirstTimeValueForRecord()  : int

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

getHash()  : string

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

getLockHash()  : string

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

getPageAndRootline()  : mixed

Loads the page and root line records based on $this->id

getPageAndRootlineWithDomain()  : mixed

Gets ->page and ->rootline information based on ->id. ->id may change during this operation.

getRelevantParametersForCachingFromPageArguments()  : array<string|int, mixed>

Fetches the arguments that are relevant for creating the hash base from the given PageArguments object.

getTimeTracker()  : TimeTracker

getUriToCurrentPageForRedirect()  : string

Instantiate \TYPO3\CMS\Frontend\ContentObject to generate the correct target URL

getWebsiteTitle()  : string

initCaches()  : mixed

Initializes the caching system.

initializeSearchWordData()  : mixed

Fills the sWordList property and builds the regular expression in TSFE that can be used to split strings by the submitted search words.

initPageRenderer()  : mixed

Initializes the page renderer object

isAllowedLinkVarValue()  : bool

Checks if the value defined in "config.linkVars" contains an allowed value.

isInPreviewMode()  : bool

logPageAccessFailure()  : void

Log the page access failure with additional request information

populatePageDataFromCache()  : void

This method properly sets the values given from the pages cache into the corresponding TSFE variables. The counterpart is setPageCacheContent() where all relevant information is fetched.

prepareDebugInformationForCachedPage()  : void

printTitle()  : string

Compiles the content for the page <title> tag.

processNonCacheableContentPartsAndSubstituteContentMarkers()  : mixed

Processes the INTinclude-scripts and substitute in content.

realPageCacheContent()  : mixed

Set cache content to $this->content

recursivelyReplaceIntPlaceholdersInContent()  : mixed

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.

releaseLock()  : mixed

Release a page specific lock

resolveContentPid()  : int

Check the value of "content_from_pid" of the current page record, and see if the current request should actually show content from another page.

resolveTranslatedPageId()  : mixed

If $this->id contains a translated page record, this needs to be resolved to the default language in order for all rootline functionality and access restrictions to be in place further on.

setAbsRefPrefix()  : mixed

Converts relative paths in the HTML source to absolute paths for fileadmin/, typo3conf/ext/ and media/ folders.

setOutputLanguage()  : mixed

Sets all internal measures what language the page should be rendered.

setPageArguments()  : void

setPageCacheContent()  : mixed

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

setRegisterValueForSysLastChanged()  : void

Set the SYS_LASTCHANGED register value, is also called when a translated page is in use, so the register reflects the state of the translated page, not the page in the default language.

setSysLastChanged()  : mixed

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.

settingLanguage()  : mixed

Setting the language key that will be used by the current page.

splitLinkVarsString()  : array<string|int, mixed>

Split the link vars string by "," but not if the "," is inside of braces

unsetBackendUser()  : void

updateRootLinesWithTranslations()  : mixed

Updating content of the two rootLines IF the language key is set!