CObjectViewHelper extends AbstractViewHelper uses CompileWithContentArgumentAndRenderStatic

ViewHelper

This class is the implementation of a Fluid ViewHelper.

View this class in the TYPO3 ViewHelper reference: <f: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 :typoscript:lib.someLibObject.

Specify cObject data & current value

::

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

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

Inline notation

::

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

Rendered :typoscript:lib.customHeader. Data will be available in TypoScript.

Accessing the data in TypoScript

.. code-block:: 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 accessible with :typoscript:.field in TypoScript. If only a single value is passed or the currentValueKey is specified, :typoscript:.current = 1 can be used in the TypoScript.

Table of Contents

Properties

$escapeChildren  : bool
Disable escaping of child nodes' output
$escapeOutput  : bool
Disable escaping of this node's output
$tsfeBackup  : TypoScriptFrontendController

Methods

initializeArguments()  : mixed
Initialize arguments.
renderStatic()  : mixed
Renders the TypoScript object in the given TypoScript setup path.
getConfigurationManager()  : ConfigurationManagerInterface
getContentObjectRenderer()  : ContentObjectRenderer
renderContentObject()  : string
Renders single content object and increases time tracker stack pointer
resetFrontendEnvironment()  : mixed
Resets $GLOBALS['TSFE'] if it was previously changed by simulateFrontendEnvironment()
simulateFrontendEnvironment()  : mixed
\TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer->cObjGetSingle() relies on $GLOBALS['TSFE']

Properties

$escapeChildren

Disable escaping of child nodes' output

protected bool $escapeChildren = false

$escapeOutput

Disable escaping of this node's output

protected bool $escapeOutput = false

Methods

initializeArguments()

Initialize arguments.

public initializeArguments() : mixed
Tags
throws
Exception

renderStatic()

Renders the TypoScript object in the given TypoScript setup path.

public static renderStatic(array<string|int, mixed> $arguments, Closure $renderChildrenClosure, RenderingContextInterface $renderingContext) : mixed
Parameters
$arguments : array<string|int, mixed>
$renderChildrenClosure : Closure
$renderingContext : RenderingContextInterface
Tags
throws
Exception

renderContentObject()

Renders single content object and increases time tracker stack pointer

protected static renderContentObject(ContentObjectRenderer $contentObjectRenderer, array<string|int, mixed> $setup, string $typoscriptObjectPath, string $lastSegment) : string
Parameters
$contentObjectRenderer : ContentObjectRenderer
$setup : array<string|int, mixed>
$typoscriptObjectPath : string
$lastSegment : string
Return values
string

resetFrontendEnvironment()

Resets $GLOBALS['TSFE'] if it was previously changed by simulateFrontendEnvironment()

protected static resetFrontendEnvironment() : mixed
Tags
see
simulateFrontendEnvironment()

simulateFrontendEnvironment()

\TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer->cObjGetSingle() relies on $GLOBALS['TSFE']

protected static simulateFrontendEnvironment() : mixed

        
On this page

Search results