‪TYPO3CMS  9.5
TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper Class Reference
Inheritance diagram for TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper:
TYPO3\CMS\Fluid\ViewHelpers\Be\Widget\PaginateViewHelper TYPO3\CMS\Fluid\ViewHelpers\Widget\AutocompleteViewHelper TYPO3\CMS\Fluid\ViewHelpers\Widget\PaginateViewHelper

Public Member Functions

 injectAjaxWidgetContextHolder (\TYPO3\CMS\Fluid\Core\Widget\AjaxWidgetContextHolder $ajaxWidgetContextHolder)
 
 injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
 
 injectExtensionService (\TYPO3\CMS\Extbase\Service\ExtensionService $extensionService)
 
 initializeArguments ()
 
string initializeArgumentsAndRender ()
 
string evaluate (RenderingContextInterface $renderingContext)
 
ComponentInterface onClose (RenderingContextInterface $renderingContext)
 
 setChildNodes (array $childNodes)
 
string compile ($argumentsName, $closureName, &$initializationPhpCode, ViewHelperNode $node, TemplateCompiler $compiler)
 

Protected Member Functions

array getWidgetConfiguration ()
 
TYPO3 CMS Extbase Mvc ResponseInterface initiateSubRequest ()
 

Protected Attributes

TYPO3 CMS Fluid Core Widget AbstractWidgetController $controller
 
bool $ajaxWidget = false
 
TYPO3 CMS Extbase Object ObjectManagerInterface $objectManager
 
TYPO3 CMS Extbase Service ExtensionService $extensionService
 
bool $escapeOutput = false
 

Private Member Functions

 initializeWidgetContext ()
 
 passArgumentsToSubRequest (\TYPO3\CMS\Fluid\Core\Widget\WidgetRequest $subRequest)
 
string initializeWidgetIdentifier ()
 

Private Attributes

TYPO3 CMS Fluid Core Widget AjaxWidgetContextHolder $ajaxWidgetContextHolder
 
TYPO3 CMS Fluid Core Widget WidgetContext $widgetContext
 

Detailed Description

Definition at line 25 of file AbstractWidgetViewHelper.php.

Member Function Documentation

◆ compile()

string TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::compile (   $argumentsName,
  $closureName,
$initializationPhpCode,
ViewHelperNode  $node,
TemplateCompiler  $compiler 
)
Parameters
string$argumentsName
string$closureName
string$initializationPhpCode
ViewHelperNode$node
TemplateCompiler$compiler
Returns
‪string

Definition at line 265 of file AbstractWidgetViewHelper.php.

Referenced by TYPO3\CMS\Fluid\Tests\Unit\Core\Widget\AbstractWidgetViewHelperTest\compileDisablesTemplateCompiler().

◆ evaluate()

string TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::evaluate ( RenderingContextInterface  $renderingContext)

Initialize the arguments of the ViewHelper, and call the render() method of the ViewHelper.

Parameters
RenderingContextInterface$renderingContext
Returns
‪string the rendered ViewHelper.

Definition at line 124 of file AbstractWidgetViewHelper.php.

References TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper\initializeWidgetContext().

◆ getWidgetConfiguration()

array TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::getWidgetConfiguration ( )
protected

Generate the configuration for this widget. Override to adjust.

Returns
‪array

Definition at line 192 of file AbstractWidgetViewHelper.php.

Referenced by TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper\initializeWidgetContext().

◆ initializeArguments()

TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::initializeArguments ( )

◆ initializeArgumentsAndRender()

string TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::initializeArgumentsAndRender ( )

Initialize the arguments of the ViewHelper, and call the render() method of the ViewHelper.

Returns
‪string the rendered ViewHelper.

Definition at line 109 of file AbstractWidgetViewHelper.php.

References TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper\initializeWidgetContext().

◆ initializeWidgetContext()

◆ initializeWidgetIdentifier()

string TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::initializeWidgetIdentifier ( )
private

The widget identifier is unique on the current page, and is used in the URI as a namespace for the widget's arguments.

Returns
‪string the widget identifier for this widget
Todo:
‪clean up, and make it somehow more routing compatible.

Definition at line 248 of file AbstractWidgetViewHelper.php.

Referenced by TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper\initializeWidgetContext().

◆ initiateSubRequest()

TYPO3 CMS Extbase Mvc ResponseInterface TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::initiateSubRequest ( )
protected

Initiate a sub request to $this->controller. Make sure to fill $this->controller via Dependency Injection.

Returns
‪\TYPO3\CMS\Extbase\Mvc\ResponseInterface the response of this request.
Exceptions

Definition at line 204 of file AbstractWidgetViewHelper.php.

References TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper\passArgumentsToSubRequest().

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Be\Widget\PaginateViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Widget\AutocompleteViewHelper\render(), and TYPO3\CMS\Fluid\ViewHelpers\Widget\PaginateViewHelper\render().

◆ injectAjaxWidgetContextHolder()

TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::injectAjaxWidgetContextHolder ( \TYPO3\CMS\Fluid\Core\Widget\AjaxWidgetContextHolder  $ajaxWidgetContextHolder)
Parameters
\TYPO3\CMS\Fluid\Core\Widget\AjaxWidgetContextHolder$ajaxWidgetContextHolder

Definition at line 64 of file AbstractWidgetViewHelper.php.

References TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper\$ajaxWidgetContextHolder.

◆ injectExtensionService()

TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::injectExtensionService ( \TYPO3\CMS\Extbase\Service\ExtensionService  $extensionService)
Parameters
\TYPO3\CMS\Extbase\Service\ExtensionService$extensionService

Definition at line 83 of file AbstractWidgetViewHelper.php.

References TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper\$extensionService.

◆ injectObjectManager()

TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::injectObjectManager ( \TYPO3\CMS\Extbase\Object\ObjectManagerInterface  $objectManager)
Parameters
\TYPO3\CMS\Extbase\Object\ObjectManagerInterface$objectManager

Definition at line 73 of file AbstractWidgetViewHelper.php.

References TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper\$objectManager.

◆ onClose()

ComponentInterface TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::onClose ( RenderingContextInterface  $renderingContext)

Stores the syntax tree child nodes in the Widget Context, so they can be rendered with <f:widget.renderChildren> lateron.

Parameters
RenderingContextInterface$renderingContext
Returns
‪ComponentInterface

Definition at line 140 of file AbstractWidgetViewHelper.php.

◆ passArgumentsToSubRequest()

TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::passArgumentsToSubRequest ( \TYPO3\CMS\Fluid\Core\Widget\WidgetRequest  $subRequest)
private

Pass the arguments of the widget to the subrequest.

Parameters
\TYPO3\CMS\Fluid\Core\Widget\WidgetRequest$subRequest

Definition at line 228 of file AbstractWidgetViewHelper.php.

Referenced by TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper\initiateSubRequest().

◆ setChildNodes()

TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::setChildNodes ( array  $childNodes)

Stores the syntax tree child nodes in the Widget Context, so they can be rendered with <f:widget.renderChildren> lateron.

Parameters
array$childNodes‪The SyntaxTree Child nodes of this ViewHelper.

Definition at line 178 of file AbstractWidgetViewHelper.php.

Member Data Documentation

◆ $ajaxWidget

bool TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::$ajaxWidget = false
protected

If set to TRUE, it is an AJAX widget.

Definition at line 38 of file AbstractWidgetViewHelper.php.

◆ $ajaxWidgetContextHolder

TYPO3 CMS Fluid Core Widget AjaxWidgetContextHolder TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::$ajaxWidgetContextHolder
private

◆ $controller

TYPO3 CMS Fluid Core Widget AbstractWidgetController TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::$controller
protected

The Controller associated to this widget. This needs to be filled by the individual subclass by an inject method.

Definition at line 32 of file AbstractWidgetViewHelper.php.

◆ $escapeOutput

bool TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::$escapeOutput = false
protected

Definition at line 54 of file AbstractWidgetViewHelper.php.

◆ $extensionService

TYPO3 CMS Extbase Service ExtensionService TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::$extensionService
protected

◆ $objectManager

TYPO3 CMS Extbase Object ObjectManagerInterface TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::$objectManager
protected

◆ $widgetContext

TYPO3 CMS Fluid Core Widget WidgetContext TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::$widgetContext
private

Definition at line 58 of file AbstractWidgetViewHelper.php.