TypoScriptFrontendController implements LoggerAwareInterface uses LoggerAwareTrait, PublicPropertyDeprecationTrait

Main controller class of the TypoScript based frontend.

Table of Contents

Interfaces

LoggerAwareInterface

Properties

$absRefPrefix  : string

Absolute Reference prefix

$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.

$applicationData  : array<string|int, mixed>

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

$cObj  : ContentObjectRenderer

Page content render object

$config  : array<string, mixed>

A central data array consisting of various keys, initialized and processed at various places in the class.

$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

$fe_user  : FrontendUserAuthentication

The frontend user

$id  : int

The page id (int)

$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.

$lock  : ResourceMutex|null

$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

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

TypoScript configuration of the page-object.

$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<int, array<string, mixed>>

Rootline of page records all the way to the root.

$sys_page  : PageRepository|string

sys_page-object, pagefunctions

$tmpl  : TemplateService

The TypoScript template object. Used to parse the TypoScript template

$baseUrl  : string

The base URL set for the page header.

$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.

$deprecatedPublicProperties  : array<string|int, mixed>

$extTarget  : string

Default external target

$fileTarget  : string

Default file link target

$intTarget  : string

Default internal target

$language  : SiteLanguage

$languageService  : LanguageService|null

Internal calculations for labels

$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 mountpoint 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, used later in the request to resolve the shortcut and redirect again.

$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>

$pageContentWasLoadedFromCache  : bool

Set if cached content was fetched from the cache.

$pageNotFound  : int

Is set to > 0 if the page could not be resolved. This will then result in early returns when resolving the page.

$pageRenderer  : PageRenderer|null

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

May be set to the pagesTSconfig

$requestedId  : int

Originally requested id from PageArguments

$site  : Site

$spamProtectEmailAddresses  : int

If set, typolink() function encrypts email addresses.

$type  : int|string

The type (read-only)

$uniqueCounter  : int

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

$uniqueString  : string

$xhtmlDoctype  : string

Doctype to use

$xhtmlVersion  : int

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.

clearPageCacheContent()  : mixed

Clears cache content (for $this->newHash)

determineId()  : ResponseInterface|null

Resolves the page id and sets up several related properties.

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.

getContext()  : Context

getFromCache()  : ServerRequestInterface

This is a central and quite early method called by PrepareTypoScriptFrontendRendering middleware: This code is *always* executed for *every* frontend call if a general page rendering has to be done, if there is no early redirect or eid call or similar.

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

Returns the originally requested page uid when TSFE was instantiated initially.

getSite()  : Site

initUserGroups()  : mixed

Initializes the front-end user groups.

INTincScript()  : void

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 content 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()  : void

Release the page specific lock.

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

checkRootlineForIncludeSection()  : bool

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

createHashBase()  : string

This creates a hash used as page cache entry identifier and as page generation lock.

disableCache()  : mixed

Disables caching of the current page.

evaluatePageNotFound()  : void

If $this->pageNotFound is set, then throw an exception to stop further page generation process

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.

getPageAndRootline()  : mixed

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

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.

initPageRenderer()  : mixed

Initializes the page renderer object

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.

printTitle()  : string

Compiles the content for the page <title> tag.

processNonCacheableContentPartsAndSubstituteContentMarkers()  : mixed

Processes the INTinclude-scripts and substitute in 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.

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.

setAbsRefPrefix()  : mixed

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

setPageArguments()  : void

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

Sets cache content; Inserts the content string into the 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

Setting the SYS_LASTCHANGED value in the pagerecord: This value will thus be set to the highest tstamp of records rendered on the page.

settingLanguage()  : mixed

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

shouldAcquireCacheData()  : bool

Detecting if shift-reload has been clicked.

updateRootLinesWithTranslations()  : mixed

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

        Both language and version overlays are applied to these page records:
        All "data" fields are set to language / version overlay values, *except* uid and
        pid, which are the default-language and live-version ids.

        When page uid 5 is called in this example:
        [0] Project name
        |- [2] An organizational page, probably with is_siteroot=1 and a site config
           |- [3] Site root with a sys_template having "root" flag set
              |- [5] Here you are

        This rootLine is:
        [0] => [uid = 3, pid = 2, title = Site root with a sys_template having "root" flag set, ...]
        [1] => [uid = 5, pid = 3, title = Here you are, ...]