TYPO3 CMS  TYPO3_8-7
TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper Class Reference
Inheritance diagram for TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper:
TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper 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 ()
 
 initializeArgumentsAndRender ()
 
 setChildNodes (array $childNodes)
 
 compile ($argumentsName, $closureName, &$initializationPhpCode, ViewHelperNode $node, TemplateCompiler $compiler)
 
- Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
 setRenderingContext (\TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)
 
 injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
 
 injectReflectionService (\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService)
 
 prepareArguments ()
 

Protected Member Functions

 getWidgetConfiguration ()
 
 initiateSubRequest ()
 
- Protected Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
 callRenderMethod ()
 
 getLogger ()
 
 registerRenderMethodArguments ()
 

Protected Attributes

 $controller
 
 $ajaxWidget = false
 
 $objectManager
 
 $extensionService
 
 $escapeOutput = false
 
- Protected Attributes inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
 $controllerContext
 
 $objectManager
 

Private Member Functions

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

Private Attributes

 $ajaxWidgetContextHolder
 
 $widgetContext
 

Detailed Description

Definition at line 23 of file AbstractWidgetViewHelper.php.

Member Function Documentation

◆ compile()

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

Definition at line 234 of file AbstractWidgetViewHelper.php.

◆ getWidgetConfiguration()

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

Generate the configuration for this widget. Override to adjust.

Returns
array

Definition at line 162 of file AbstractWidgetViewHelper.php.

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

◆ initializeArguments()

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

Initialize arguments.

Definition at line 95 of file AbstractWidgetViewHelper.php.

◆ initializeArgumentsAndRender()

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 111 of file AbstractWidgetViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\callRenderMethod(), and TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper\initializeWidgetContext().

◆ initializeWidgetContext()

TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::initializeWidgetContext ( )
private

◆ initializeWidgetIdentifier()

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 219 of file AbstractWidgetViewHelper.php.

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

◆ initiateSubRequest()

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
the response of this request.
Exceptions

Definition at line 175 of file AbstractWidgetViewHelper.php.

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

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Widget\AutocompleteViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Be\Widget\PaginateViewHelper\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 70 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 87 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 78 of file AbstractWidgetViewHelper.php.

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

◆ 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 199 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$childNodesThe SyntaxTree Child nodes of this ViewHelper.

Definition at line 147 of file AbstractWidgetViewHelper.php.

Member Data Documentation

◆ $ajaxWidget

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

Definition at line 40 of file AbstractWidgetViewHelper.php.

◆ $ajaxWidgetContextHolder

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

◆ $controller

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

Definition at line 32 of file AbstractWidgetViewHelper.php.

◆ $escapeOutput

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

Definition at line 60 of file AbstractWidgetViewHelper.php.

◆ $extensionService

TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::$extensionService
protected

◆ $objectManager

TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::$objectManager
protected

◆ $widgetContext

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

Definition at line 65 of file AbstractWidgetViewHelper.php.