Attention
TYPO3 v10 has reached end-of-life as of April 30th 2023 and is no longer being maintained. Use the version switcher on the top left of this page to select documentation for a supported version of TYPO3.
Need more time before upgrading? You can purchase Extended Long Term Support (ELTS) for TYPO3 v10 here: TYPO3 ELTS.
Appendix A – PHP include scripts¶
Including your script¶
This section should give you some pointers on what you can process in your script and which functions and variables you can access.
Your script is included inside the class "ContentObjectRenderer" in the
typo3/sysext/frontend/Classes/ContentObject/ContentObjectRenderer.php
script. Thereby your file is a part of this object
(ContentObjectRenderer). This is why you must return all
content in the variable "$content" and any TypoScript configuration is
available from the array "$conf" (it may not be set at all though, so
check it with is_array()!)
$content¶
Contains the content, which was passed to the object, if any. All content, which you want to return, must be in this variable!
Remember, don't output anything (but debug code) directly in your script!
$conf¶
The array $conf contains the configuration for the USER cObject. Try debug($conf) to see the content printed out for debugging!
White spaces¶
Because nothing is sent off to the browser before everything is
rendered and returned to \TYPO3\CMS\Frontend\Http\RequestHandler
(which originally set off the rendering process), you must ensure
that there's no whitespace before and after your <?php...?> tags
in your include or library scripts!
$GLOBALS['TSFE']->set_no_cache()¶
Call the function $GLOBALS['TSFE']->set_no_cache(), if you want to
disable caching of the page. Call this during development only! And
call it, if the content you create may not be cached.
Note: If you make a syntax error in your script that keeps PHP
from executing it, then the $GLOBALS['TSFE']->set_no_cache()
function is not executed and the page is cached! So in these
situations, correct the error, clear the page-cache and try again.
This is true only for USER and not for USER_INT, which is
rendered after the cached page!
Example:¶
$GLOBALS['TSFE']->set_no_cache();
$this->cObjGetSingle(value, properties[, TSkey = '__'])¶
Gets a content object from the $conf array. $TSkey is an optional string label used for the internal debugging tracking.
Example:¶
$content = $this->cObjGetSingle($conf['image'], $conf['image.'], 'My Image 2');
This would return any IMAGE cObject at the property "image" of the $conf array for the include script!
$this->stdWrap(value, properties)¶
Hands the content in "value" to the stdWrap function, which will process it according to the configuration of the array "properties".
Example:¶
$content = $this->stdWrap($content, $conf['stdWrap.']);
This will stdWrap the content with the properties of ".stdWrap" of the $conf array!
Internal variables in the main frontend object, TSFE¶
There are some variables in the global object, TSFE (TypoScript
Frontend), you might need to know about. These ARE ALL READ-ONLY!
(Read: Don't change them!) See the class TypoScriptFrontendController
for the full descriptions.
Important
In previous versions, the properties gr_list, loginUser and beUserLogin where
used for context specific information. Since TYPO3 v9 these variables have been
replaced by the TYPO3 Context API.
If you for instance want to access the variable "id", you can do so by
writing: $GLOBALS['TSFE']->id
Variable
id
PHP-Type
integer
Description
The page id
Variable
type
PHP-Type
integer
Description
The type
Variable
page
PHP-Type
array
Description
The page record
Variable
fe_user
PHP-Type
object
Description
The current front-end user.
User record in $GLOBALS['TSFE']->fe_user->user, if any login.
Variable
rootLine
PHP-Type
array
Description
The rootLine (all the way to tree root, not only the current site!).
Current site root line is in $GLOBALS['TSFE']->tmpl->rootLine
Variable
sys_page
PHP-Type
object
Description
The object with page functions (object) See
typo3/sysext/core/Classes/Domain/Repository/PageRepository.php.
Global variables¶
Variable
BE_USER
PHP-Type
object
Description
The backend user object (if any).
Default
not set
Variable
TYPO3_CONF_VARS
PHP-Type
array
Description
TYPO3 Configuration.
Variable
TSFE
PHP-Type
object
Description
Main frontend object.