TYPO3\CMS\Fluid\ViewHelpers\CObjectViewHelper Class Reference

Inheritance diagram for TYPO3\CMS\Fluid\ViewHelpers\CObjectViewHelper:

Public Member Functions
	initializeArguments ()
	resolveContentArgumentName ()

Static Public Member Functions
static	renderStatic (array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)

Static Protected Member Functions
static	renderContentObject (ContentObjectRenderer $contentObjectRenderer, array $setup, string $typoscriptObjectPath, string $lastSegment)
static	getConfigurationManager ()
static	getContentObjectRenderer (ServerRequestInterface $request)
static	simulateFrontendEnvironment ()
static	resetFrontendEnvironment (?TypoScriptFrontendController $tsfeBackup)

Protected Attributes
bool	$escapeChildren = false
bool	$escapeOutput = false

Detailed Description

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.

Definition at line 86 of file CObjectViewHelper.php.

Member Function Documentation

getConfigurationManager()

static TYPO3\CMS\Fluid\ViewHelpers\CObjectViewHelper::getConfigurationManager ( )

staticprotected

Definition at line 184 of file CObjectViewHelper.php.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\CObjectViewHelper\renderStatic().

getContentObjectRenderer()

static TYPO3\CMS\Fluid\ViewHelpers\CObjectViewHelper::getContentObjectRenderer ( ServerRequestInterface  $request )

staticprotected

Definition at line 190 of file CObjectViewHelper.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\CObjectViewHelper\renderStatic().

initializeArguments()

TYPO3\CMS\Fluid\ViewHelpers\CObjectViewHelper::initializeArguments

(

)

Definition at line 101 of file CObjectViewHelper.php.

renderContentObject()

static TYPO3\CMS\Fluid\ViewHelpers\CObjectViewHelper::renderContentObject ( ContentObjectRenderer  $contentObjectRenderer, array  $setup, string  $typoscriptObjectPath, string  $lastSegment  )

staticprotected

Renders single content object and increases time tracker stack pointer

Definition at line 169 of file CObjectViewHelper.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\cObjGetSingle().

Referenced by TYPO3\CMS\Fluid\ViewHelpers\CObjectViewHelper\renderStatic().

renderStatic()

static TYPO3\CMS\Fluid\ViewHelpers\CObjectViewHelper::renderStatic ( array  $arguments, \Closure  $renderChildrenClosure, RenderingContextInterface  $renderingContext  )

static

Renders the TypoScript object in the given TypoScript setup path.

Exceptions

Exception

Definition at line 114 of file CObjectViewHelper.php.

References $GLOBALS, TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface\CONFIGURATION_TYPE_FULL_TYPOSCRIPT, TYPO3\CMS\Fluid\ViewHelpers\CObjectViewHelper\getConfigurationManager(), TYPO3\CMS\Fluid\ViewHelpers\CObjectViewHelper\getContentObjectRenderer(), TYPO3\CMS\Fluid\ViewHelpers\CObjectViewHelper\renderContentObject(), TYPO3\CMS\Fluid\ViewHelpers\CObjectViewHelper\resetFrontendEnvironment(), TYPO3\CMS\Fluid\ViewHelpers\CObjectViewHelper\simulateFrontendEnvironment(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

resetFrontendEnvironment()

static TYPO3\CMS\Fluid\ViewHelpers\CObjectViewHelper::resetFrontendEnvironment ( ?TypoScriptFrontendController  $tsfeBackup )

staticprotected

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

Definition at line 221 of file CObjectViewHelper.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\CObjectViewHelper\renderStatic().

resolveContentArgumentName()

TYPO3\CMS\Fluid\ViewHelpers\CObjectViewHelper::resolveContentArgumentName

(

)

Explicitly set argument name to be used as content.

Definition at line 229 of file CObjectViewHelper.php.

simulateFrontendEnvironment()

static TYPO3\CMS\Fluid\ViewHelpers\CObjectViewHelper::simulateFrontendEnvironment ( )

staticprotected

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

Definition at line 210 of file CObjectViewHelper.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\CObjectViewHelper\renderStatic().

Member Data Documentation

$escapeChildren

bool TYPO3\CMS\Fluid\ViewHelpers\CObjectViewHelper::$escapeChildren = false

protected

Disable escaping of child nodes' output

Definition at line 93 of file CObjectViewHelper.php.

$escapeOutput

bool TYPO3\CMS\Fluid\ViewHelpers\CObjectViewHelper::$escapeOutput = false

protected

Disable escaping of this node's output

Definition at line 99 of file CObjectViewHelper.php.