Attention

TYPO3 v9 has reached its end-of-life September 30th, 2021 and is not maintained by the community anymore. Looking for a stable version? Use the version switch on the top left.

You can order Extended Long Term Support (ELTS) here: TYPO3 ELTS.

cObject

This ViewHelper renders CObjects from the global TypoScript configuration.

Note

You have to ensure proper escaping (htmlspecialchars/intval/etc.) on your own!

Examples

Render lib object

<f:cObject typoscriptObjectPath="lib.someLibObject" />

Rendered :ts:`lib.someLibObject`.

Specify cObject data & current value

<f:cObject typoscriptObjectPath="lib.customHeader" data="{article}" currentValueKey="title" />

Rendered :ts:`lib.customHeader`. Data and current value will be available in TypoScript.

Inline notation

{article -> f:cObject(typoscriptObjectPath: 'lib.customHeader')}

Rendered :ts:`lib.customHeader`. Data will be available in TypoScript.

Accessing the data in TypoScript

lib.customHeader = COA
lib.customHeader {
    10 = TEXT
    10.field = author
    20 = TEXT
    20.current = 1
}

When passing an object with {data} the properties of the object are accessable with :ts:`.field` in TypoScript. If only a single value is passed or the currentValueKey is specified :ts:`.current = 1` can be used in the TypoScript.

Arguments

data

DataType

mixed

Required

false

Description

The data to be used for rendering the cObject. Can be an object, array or string. If this argument is not set, child nodes will be used

typoscriptObjectPath

DataType

string

Required

false

Description

The TypoScript setup path of the TypoScript object to render

currentValueKey

DataType

string

Required

false

Description

CurrentValueKey

table

DataType

string

Required

false

Description

The table name associated with "data" argument. Typically tt_content or one of your custom tables. This argument should be set if rendering a FILES cObject where file references are used, or if the data argument is a database record.