TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
AbstractWidgetViewHelper Class Reference
Inheritance diagram for AbstractWidgetViewHelper:
AbstractViewHelper PaginateViewHelper AutocompleteViewHelper 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)
 
 initializeArgumentsAndRender ()
 
 setChildNodes (array $childNodes)
 
 compile ($argumentsName, $closureName, &$initializationPhpCode, ViewHelperNode $node, TemplateCompiler $compiler)
 
- Public Member Functions inherited from 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 AbstractViewHelper
 callRenderMethod ()
 
 getLogger ()
 
 registerRenderMethodArguments ()
 

Protected Attributes

 $controller
 
 $ajaxWidget = false
 
 $objectManager
 
 $extensionService
 
 $escapeOutput = false
 
- Protected Attributes inherited from 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 (   $argumentsName,
  $closureName,
$initializationPhpCode,
ViewHelperNode  $node,
TemplateCompiler  $compiler 
)
Parameters
string$argumentsName
string$closureName
string$initializationPhpCode
ViewHelperNode$node
TemplateCompiler$compiler

Definition at line 223 of file AbstractWidgetViewHelper.php.

getWidgetConfiguration ( )
protected

Generate the configuration for this widget. Override to adjust.

Returns
array

Definition at line 151 of file AbstractWidgetViewHelper.php.

Referenced by AbstractWidgetViewHelper\initializeWidgetContext().

initializeArgumentsAndRender ( )

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

Returns
string the rendered ViewHelper.

Definition at line 99 of file AbstractWidgetViewHelper.php.

References AbstractViewHelper\callRenderMethod(), and AbstractWidgetViewHelper\initializeWidgetContext().

initializeWidgetContext ( )
private

Initialize the Widget Context, before the Render method is called.

Returns
void

Definition at line 112 of file AbstractWidgetViewHelper.php.

References AbstractWidgetViewHelper\getWidgetConfiguration(), and AbstractWidgetViewHelper\initializeWidgetIdentifier().

Referenced by AbstractWidgetViewHelper\initializeArgumentsAndRender().

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

Referenced by AbstractWidgetViewHelper\initializeWidgetContext().

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
TYPO3

Definition at line 164 of file AbstractWidgetViewHelper.php.

References AbstractWidgetViewHelper\passArgumentsToSubRequest().

Referenced by AutocompleteViewHelper\render(), and PaginateViewHelper\render().

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 AbstractWidgetViewHelper\$ajaxWidgetContextHolder.

injectExtensionService ( \TYPO3\CMS\Extbase\Service\ExtensionService  $extensionService)
Parameters
\TYPO3\CMS\Extbase\Service\ExtensionService$extensionService

Definition at line 89 of file AbstractWidgetViewHelper.php.

References AbstractWidgetViewHelper\$extensionService.

injectObjectManager ( \TYPO3\CMS\Extbase\Object\ObjectManagerInterface  $objectManager)
Parameters
\TYPO3\CMS\Extbase\Object\ObjectManagerInterface$objectManager
Returns
void

Definition at line 80 of file AbstractWidgetViewHelper.php.

References AbstractWidgetViewHelper\$objectManager.

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

Referenced by AbstractWidgetViewHelper\initiateSubRequest().

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

Definition at line 136 of file AbstractWidgetViewHelper.php.

Member Data Documentation

$ajaxWidget = false
protected

Definition at line 40 of file AbstractWidgetViewHelper.php.

$ajaxWidgetContextHolder
private
$controller
protected

Definition at line 32 of file AbstractWidgetViewHelper.php.

$escapeOutput = false
protected

Definition at line 60 of file AbstractWidgetViewHelper.php.

$extensionService
protected
$objectManager
protected
$widgetContext
private

Definition at line 65 of file AbstractWidgetViewHelper.php.