TYPO3 CMS  TYPO3_6-2
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\Core\ViewHelper\Facets\ChildNodeAccessInterface Tx_Fluid_Core_Widget_AbstractWidgetViewHelper TYPO3\CMS\Fluid\ViewHelpers\Be\Widget\PaginateViewHelper TYPO3\CMS\Fluid\ViewHelpers\Widget\AutocompleteViewHelper TYPO3\CMS\Fluid\ViewHelpers\Widget\PaginateViewHelper Tx_Fluid_ViewHelpers_Widget_AutocompleteViewHelper Tx_Fluid_ViewHelpers_Widget_PaginateViewHelper

Public Member Functions

 injectAjaxWidgetContextHolder (\TYPO3\CMS\Fluid\Core\Widget\AjaxWidgetContextHolder $ajaxWidgetContextHolder)
 
 injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
 
 initializeArgumentsAndRender ()
 
 setChildNodes (array $childNodes)
 
- Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
 setArguments (array $arguments)
 
 setRenderingContext (\TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)
 
 injectReflectionService (\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService)
 
 isEscapingInterceptorEnabled ()
 
 setViewHelperNode (\TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\ViewHelperNode $node)
 
 setRenderChildrenClosure (\Closure $renderChildrenClosure)
 
 initializeArgumentsAndRender ()
 
 initialize ()
 
 renderChildren ()
 
 prepareArguments ()
 
 validateArguments ()
 
 initializeArguments ()
 
 compile ($argumentsVariableName, $renderChildrenClosureVariableName, &$initializationPhpCode, \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\AbstractNode $syntaxTreeNode, \TYPO3\CMS\Fluid\Core\Compiler\TemplateCompiler $templateCompiler)
 
 resetState ()
 

Protected Member Functions

 getWidgetConfiguration ()
 
 initiateSubRequest ()
 
- Protected Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
 registerArgument ($name, $type, $description, $required=FALSE, $defaultValue=NULL)
 
 overrideArgument ($name, $type, $description, $required=FALSE, $defaultValue=NULL)
 
 callRenderMethod ()
 
 buildRenderChildrenClosure ()
 
 hasArgument ($argumentName)
 

Protected Attributes

 $controller
 
 $ajaxWidget = FALSE
 
 $objectManager
 
 $extensionService
 
- Protected Attributes inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
 $arguments
 
 $templateVariableContainer
 
 $controllerContext
 
 $renderingContext
 
 $renderChildrenClosure = NULL
 
 $viewHelperVariableContainer
 
 $objectManager
 
 $escapingInterceptorEnabled = TRUE
 

Private Member Functions

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

Private Attributes

 $ajaxWidgetContextHolder
 
 $widgetContext
 

Additional Inherited Members

- Static Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
static renderStatic (array $arguments, \Closure $renderChildrenClosure, \TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)
 

Detailed Description

Definition at line 26 of file AbstractWidgetViewHelper.php.

Member Function Documentation

◆ getWidgetConfiguration()

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

Generate the configuration for this widget. Override to adjust.

Returns
array

Definition at line 138 of file AbstractWidgetViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\$arguments.

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

◆ initializeArgumentsAndRender()

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

◆ 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
void
Todo:
clean up, and make it somehow more routing compatible.

Definition at line 190 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.

Definition at line 149 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
Returns
void

Definition at line 71 of file AbstractWidgetViewHelper.php.

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

◆ injectObjectManager()

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

Definition at line 79 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
Returns
void

Definition at line 170 of file AbstractWidgetViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\$arguments.

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.
Returns
void

Implements TYPO3\CMS\Fluid\Core\ViewHelper\Facets\ChildNodeAccessInterface.

Definition at line 124 of file AbstractWidgetViewHelper.php.

Member Data Documentation

◆ $ajaxWidget

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

Definition at line 44 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 36 of file AbstractWidgetViewHelper.php.

◆ $extensionService

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

Definition at line 60 of file AbstractWidgetViewHelper.php.

◆ $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.