TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
WidgetContext Class Reference

Public Member Functions

 getWidgetIdentifier ()
 
 setWidgetIdentifier ($widgetIdentifier)
 
 getAjaxWidgetIdentifier ()
 
 setAjaxWidgetIdentifier ($ajaxWidgetIdentifier)
 
 setParentPluginNamespace ($parentPluginNamespace)
 
 getParentPluginNamespace ()
 
 setParentExtensionName ($parentExtensionName)
 
 getParentExtensionName ()
 
 setParentPluginName ($parentPluginName)
 
 getParentPluginName ()
 
 setWidgetViewHelperClassName ($widgetViewHelperClassName)
 
 getWidgetViewHelperClassName ()
 
 getWidgetConfiguration ()
 
 setWidgetConfiguration ($widgetConfiguration)
 
 getControllerObjectName ()
 
 setControllerObjectName ($controllerObjectName)
 
 setViewHelperChildNodes (\TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\RootNode $viewHelperChildNodes,\TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface $viewHelperChildNodeRenderingContext)
 
 getViewHelperChildNodes ()
 
 getViewHelperChildNodeRenderingContext ()
 
 __sleep ()
 

Protected Attributes

 $widgetIdentifier
 
 $ajaxWidgetIdentifier
 
 $widgetConfiguration
 
 $controllerObjectName
 
 $viewHelperChildNodes
 
 $viewHelperChildNodeRenderingContext
 
 $parentPluginNamespace
 
 $parentExtensionName
 
 $parentPluginName
 
 $widgetViewHelperClassName
 

Detailed Description

The WidgetContext stores all information a widget needs to know about the environment.

The WidgetContext can be fetched from the current WidgetRequest, and is thus available throughout the whole sub-request of the widget. It is used internally by various ViewHelpers (like <f:widget.link>, <f:widget.uri>, <f:widget.renderChildren>), to get knowledge over the current widget's configuration.

It is a purely internal class which should not be used outside of Fluid.

Definition at line 28 of file WidgetContext.php.

Member Function Documentation

__sleep ( )
Returns
array

Definition at line 280 of file WidgetContext.php.

getAjaxWidgetIdentifier ( )
Returns
string

Definition at line 118 of file WidgetContext.php.

References WidgetContext\$ajaxWidgetIdentifier.

getControllerObjectName ( )
Returns
string

Definition at line 236 of file WidgetContext.php.

References WidgetContext\$controllerObjectName.

getParentExtensionName ( )

Returns the Extension name of the plugin that contains the widget

Returns
string

Definition at line 169 of file WidgetContext.php.

References WidgetContext\$parentExtensionName.

getParentPluginName ( )

Returns the name of the plugin that contains the widget

Returns
string

Definition at line 190 of file WidgetContext.php.

References WidgetContext\$parentPluginName.

getParentPluginNamespace ( )

Returns the URI namespace of the plugin that contains the widget

Returns
string

Definition at line 148 of file WidgetContext.php.

References WidgetContext\$parentPluginNamespace.

getViewHelperChildNodeRenderingContext ( )
Returns

Definition at line 272 of file WidgetContext.php.

References WidgetContext\$viewHelperChildNodeRenderingContext.

getViewHelperChildNodes ( )
Returns

Definition at line 264 of file WidgetContext.php.

References WidgetContext\$viewHelperChildNodes.

getWidgetConfiguration ( )
Returns
array

Definition at line 219 of file WidgetContext.php.

References WidgetContext\$widgetConfiguration.

getWidgetIdentifier ( )
Returns
string

Definition at line 101 of file WidgetContext.php.

References WidgetContext\$widgetIdentifier.

getWidgetViewHelperClassName ( )

Returns the fully qualified class name of the view helper this context belongs to

Returns
string

Definition at line 211 of file WidgetContext.php.

References WidgetContext\$widgetViewHelperClassName.

setAjaxWidgetIdentifier (   $ajaxWidgetIdentifier)
Parameters
string$ajaxWidgetIdentifier
Returns
void

Definition at line 127 of file WidgetContext.php.

References WidgetContext\$ajaxWidgetIdentifier.

setControllerObjectName (   $controllerObjectName)
Parameters
string$controllerObjectName
Returns
void

Definition at line 245 of file WidgetContext.php.

References WidgetContext\$controllerObjectName.

setParentExtensionName (   $parentExtensionName)

Sets the Extension name of the plugin that contains the widget

Parameters
string$parentExtensionName
Returns
void

Definition at line 159 of file WidgetContext.php.

References WidgetContext\$parentExtensionName.

setParentPluginName (   $parentPluginName)

Sets the name of the plugin that contains the widget

Parameters
string$parentPluginName
Returns
void

Definition at line 180 of file WidgetContext.php.

References WidgetContext\$parentPluginName.

setParentPluginNamespace (   $parentPluginNamespace)

Sets the URI namespace of the plugin that contains the widget

Parameters
string$parentPluginNamespace
Returns
void

Definition at line 138 of file WidgetContext.php.

References WidgetContext\$parentPluginNamespace.

setViewHelperChildNodes ( \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\RootNode  $viewHelperChildNodes,
\TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface  $viewHelperChildNodeRenderingContext 
)
Parameters
\TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\RootNode$viewHelperChildNodes
\TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface$viewHelperChildNodeRenderingContext
Returns
void

Definition at line 255 of file WidgetContext.php.

References WidgetContext\$viewHelperChildNodeRenderingContext, and WidgetContext\$viewHelperChildNodes.

setWidgetConfiguration (   $widgetConfiguration)
Parameters
array$widgetConfiguration
Returns
void

Definition at line 228 of file WidgetContext.php.

References WidgetContext\$widgetConfiguration.

setWidgetIdentifier (   $widgetIdentifier)
Parameters
string$widgetIdentifier
Returns
void

Definition at line 110 of file WidgetContext.php.

References WidgetContext\$widgetIdentifier.

setWidgetViewHelperClassName (   $widgetViewHelperClassName)

Sets the fully qualified class name of the view helper this context belongs to

Parameters
string$widgetViewHelperClassName
Returns
void

Definition at line 201 of file WidgetContext.php.

References WidgetContext\$widgetViewHelperClassName.

Member Data Documentation

$ajaxWidgetIdentifier
protected
$controllerObjectName
protected
$parentExtensionName
protected
$parentPluginName
protected
$parentPluginNamespace
protected
$viewHelperChildNodeRenderingContext
protected
$viewHelperChildNodes
protected
$widgetConfiguration
protected
$widgetIdentifier
protected
$widgetViewHelperClassName
protected