Data / getText¶

cObj¶

cObj ¶

For CONTENT and RECORDS cObjects that are returned by a select query, this returns the row number (1,2,3,...) of the current cObject record.

parentRecordNumber is the only key available.

lib.foo.data = cObj : parentRecordNumber

context¶

context ¶

Access values from context API (see). If a property is an array, it is converted into a comma-separated list.

Syntax:

TypoScript Syntax

lib.foo.data = context:<aspectName>:<propertyName>

Copied!

page.10 = TEXT
page.10.data = context:workspace:id
page.10.wrap = You are in workspace: |

current¶

current ¶

current (gets the "current" value)

lib.foo.data = current

date¶

date ¶

Default

d/m Y

Can be used with a colon and date-conf.

lib.foo.data = date : d-m-y

DB¶

DB ¶

Syntax

DB : [table name] : [uid] : [field]

Value from database. Any record from a table in TCA can be selected here. Records marked as deleted will not return any value.

In contrast to other keys, colons are used here to get deeper into the structure, instead of pipes.

lib.foo.data = DB : tt_content:234:header

lib.foo.data.dataWrap = DB : tt_content:{GP : myContentId}:header

debug¶

debug ¶

Returns HTML-formatted content of the PHP variable defined by the keyword. Available keywords are rootLine, fullRootLine, data, register and page.

lib.foo.data = debug : rootLine

field¶

field ¶

Syntax

field : [field name from the current $cObj->data array in the cObject, multi-dimensional.]

This gives read access to the current value of an internal global variable determined by the given key.

• As default the $cObj->data array is $GLOBALS['TSFE']->page (record of the current page)
• In TMENU $cObj->data is set in a loop to the page-record for each menu item during its rendering process.
• In CONTENT / RECORDS $cObj->data is set to the actual record
• In GIFBUILDER $cObj->data is set to the data GIFBUILDER is supplied with.

lib.foo.data = field : header

lib.foo.data = field : fieldname|level1|level2

file¶

file ¶

Syntax

file : [uid] : [property]

Retrieves a property from a file object (FAL) by identifying it through its sys_file UID. Note that during execution of the FILES cObject, it is also possible to reference the current file with current as UID like file : current : size.

The following properties are available: name, uid, originalUid, size, sha1, extension, mimetype, contents, publicUrl, modification_date, creation_date

Furthermore when manipulating references (such as images in content elements or media in pages), additional properties are available (not all are available all the time, it depends on the setup of references of the FILES cObject): title, description, link, alternative.

Additionally, any data in the sys_file_metadata table can be accessed too.

See the FILES cObject for usage examples.

lib.foo.data = file : 17 : size

flexform¶

flexform ¶

Syntax

flexform : [field containing flexform data].[property of this flexform]

Access values from FlexForms, for example inside of tt_content record. In contrast to most parts, deeper levels are accessed through dots, not pipes.

lib.foo.data = flexform : pi_flexform:settings.categories

fullRootLine¶

fullRootLine ¶

Syntax

fullRootLine : [pointer, integer], [field name], ["slide"]

This property can be used to retrieve values from "above" the current page's root. Take the below page tree and assume that we are on the page "Here you are!". Using the levelfield property, it is possible to go up only to the page "Site root", because it is the root of a new (sub-)site. With fullRootLine it is possible to go all the way up to page tree root. The numbers between square brackets indicate to which page each value of pointer would point to:

- Page tree root [-2]
  |- 1. page before [-1]
    |- Site root (root template here!) [0]
      |- Here you are! [1]

A "slide" parameter can be added just as for the levelfield property.

lib.foo.data = fullRootLine : -1, title

getenv¶

getenv ¶

Value from PHP environment variables.

For a cached variation of this feature, please refer to getEnv.

lib.foo.data = getenv : HTTP_REFERER

getIndpEnv¶

getIndpEnv ¶

Syntax

getIndpEnv : <name>

Returns the value of a System Environment Variable denoted by name regardless of server OS, CGI/MODULE version etc. The result is identical to the $_SERVER variable in most cases. This method should be used instead of getEnv to get reliable values for all situations. The internal processing is handled by TYPO3\CMS\Core\Utility\GeneralUtility::getIndpEnv()

Available names:

Name	Definition	Example or result
_ARRAY	Return an array with all available key-value pairs for debugging purposes
HTTP_ACCEPT_LANGUAGE	language(s) accepted by client
HTTP_HOST	[host][:[port]]	example.org:8080
HTTP_REFERER	[scheme]://[host][:[port]][path]	https://example.org:8080/typo3/32/temp/phpcheck/index.php/arg1/arg2/arg3/?arg1,arg2,arg3&p1=parameter1&p2[key]=value
HTTP_USER_AGENT	client user agent
PATH_INFO	[path_info]	/arg1/arg2/arg3/
QUERY_STRING	[query]	arg1,arg2,arg3&p1=parameter1&p2[key]=value
REMOTE_ADDR	client IP
REMOTE_HOST	client host
REQUEST_URI	[path]?[query]	/typo3/32/temp/phpcheck/index.php/arg1/arg2/arg3/?arg1,arg2,arg3&p1=parameter1&p2[key]=value
SCRIPT_FILENAME	absolute filename of script
SCRIPT_NAME	[path_script]	/typo3/32/temp/phpcheck/[index.php]
TYPO3_DOCUMENT_ROOT	absolute path of root of documents
TYPO3_HOST_ONLY	[host]	example.org
TYPO3_PORT	[port]	8080
TYPO3_REQUEST_DIR	[scheme]://[host][:[port]][path_dir]
TYPO3_REQUEST_HOST	[scheme]://[host][:[port]]
TYPO3_REQUEST_SCRIPT	[scheme]://[host][:[port]][path_script]
TYPO3_REQUEST_URL	[scheme]://[host][:[port]][path]?[query]
TYPO3_REV_PROXY	TRUE if this session runs over a well known proxy
TYPO3_SITE_SCRIPT	[script / Speaking URL] of the TYPO3 website
TYPO3_SITE_URL	[scheme]://[host][:[port]][path_dir] of the TYPO3 website frontend
TYPO3_SSL	TRUE if this session uses SSL/TLS (https)

# get and output the client IP
page = PAGE
page.10 = TEXT
page.10.stdWrap.data = getIndpEnv : REMOTE_ADDR
page.10.stdWrap.htmlSpecialChars = 1

global¶

global ¶

Syntax

global : [variable]

Deprecated, use GP, TSFE or getenv.

GP¶

GP ¶

Syntax

GP : [Value from GET or POST method]

Get a variable from $_GET or $_POST where a variable, which exists in both arrays, is returned from $_POST.

lib.foo.data = GP : stuff

lib.foo.data = GP : stuff|bar

level¶

level ¶

Get the root line level of the current page.

lib.foo.data = level

levelfield¶

levelfield ¶

Syntax

levelfield : [pointer, integer], [field name], ["slide"]

Like leveltitle but the field do be fetched from the record is configurable.

lib.foo.data = levelfield : -1, tx_myextension_myfield, slide

$GLOBALS['TYPO3_CONF_VARS']['FE']['addRootLineFields'] .= ',tx_myextension_myfield';

levelmedia¶

levelmedia ¶

Syntax

levelmedia : [pointer, integer], ["slide"]

Get the media field of a page in the root-line.

• Use an absolute level with 0 or a positive integer.
• With a negative integer got x levels up
• The slide parameter slides until there is a non-empty value found.

leveltitle¶

leveltitle ¶

Syntax

leveltitle : [pointer, integer], ["slide"]

Get the title of a page in the root-line.

• Use an absolute level with 0 or a positive integer.
• With a negative integer got x levels up
• The slide parameter slides until there is a non-empty value found.

lib.foo.data = leveltitle : 1

lib.foo.data = leveltitle : -2, slide

leveluid¶

leveluid ¶

Syntax

leveluid : [pointer, integer]

Get the UID of a page in the root line.

• Use an absolute level with 0 or a positive integer.
• With a negative integer got x levels up

lib.foo.data = leveluid : 0

LLL¶

LLL ¶

Syntax

LLL: [fileref]:[labelkey]

Reference to a locallang label (XLIFF). Reference consists of [fileref]:[labelkey]

lib.foo.data = LLL : EXT:felogin/Resources/Private/Language/locallang.xlf:logout

page¶

page ¶

Syntax

page: [field in the current page record]

Get the specified field from the current page

lib.foo.data = page : title

pagelayout¶

pagelayout ¶

Get the current backend layout

lib.foo.data = pagelayout

parameters¶

parameters ¶

Syntax

parameters: [field name from the current $cObj->parameters array in the cObject.]

Get the content of a key in parameters array of the current cObject.

lib.foo.data = parameters : color

path¶

path ¶

Path to a file, possibly placed in an extension, returns empty if the file does not exist.

lib.foo.data = path : EXT:rsaauth/resources/rsaauth.js

page.headerData.10 = TEXT
page.headerData.10 {
    data = path : EXT:site/Resources/Public/Images/logo.png
    wrap = <a href="|">
}

register¶

register ¶

Syntax

register: [field name from the $GLOBALS['TSFE']->register]

See LOAD_REGISTER.

lib.foo.data = register : color

session¶

session ¶

Syntax

session : [key]

The key refers to the session key used to store the value.

lib.foo.data = session : shop_cart|itemCount

site¶

site ¶

Syntax

site : [key]

Accessing the current site configuration.

Possible keys:

attributes

Additional parameters configured for this site.

base

The base URL for this site.

baseVariants

The base variants for this site.

rootPageId

The root page ID of this site.

identifier

The identifier (name) of this site configuration.

websiteTitle

The website title of this site.

page.10 = TEXT
page.10.data = site:base
page.10.wrap = This is your base URL: |

page.10 = TEXT
page.10.data = site:customConfigKey.nested.value

siteLanguage¶

siteLanguage ¶

Syntax

siteLanguage : [key]

Accessing the current site language configuration.

Possible keys:

attributes

Additional parameters configured for this site language.

base

The base URL for this language.

direction

The direction for this language.

flagIdentifier

The flag key (like gb or fr) used to be used in the TYPO3 backend.

hreflang

The language tag for this language defined by RFC 1766 / 3066 for lang and hreflang attributes

languageId

The language mapped to the ID of the site language.

locale

The locale, like de_CH or en_GB.

navigationTitle

The label to be used within language menus.

title

The label to be used within TYPO3 to identify the language.

twoLetterIsoCode

The ISO-639-1 code for this language (two letters).

typo3Language

The prefix for TYPO3's language files (default for English), otherwise one of TYPO3's internal language keys. Previously configured via TypoScript config.language = fr.

websiteTitle

The website title for this language. No automatic fallback to the site:websiteTitle!

page.10 = TEXT
page.10.data = siteLanguage:navigationTitle
page.10.wrap = This is the title of the current site language: |

page.20 = TEXT
page.20.dataWrap = The current site language's locale is {siteLanguage:locale}

# Website title for the current language with fallback
# to the website title of the site configuration.
page.30 = TEXT
page.30.data = siteLanguage:websiteTitle // site:websiteTitle

TSFE¶

TSFE ¶

Syntax

TSFE: [value from the $GLOBALS['TSFE'] array, multi-dimensional]

Returns a value from TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController.

lib.foo.data = TSFE : fe_user|user|username