TYPO3 CMS  TYPO3_6-2
Public Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Fluid\Core\Widget\WidgetContext Class Reference
Inheritance diagram for TYPO3\CMS\Fluid\Core\Widget\WidgetContext:
Tx_Fluid_Core_Widget_WidgetContext

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, \TYPO3\CMS\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 34 of file WidgetContext.php.

Member Function Documentation

◆ __sleep()

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::__sleep ( )
Returns
array

Definition at line 267 of file WidgetContext.php.

◆ getAjaxWidgetIdentifier()

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::getAjaxWidgetIdentifier ( )
Returns
string

Definition at line 122 of file WidgetContext.php.

References TYPO3\CMS\Fluid\Core\Widget\WidgetContext\$ajaxWidgetIdentifier.

◆ getControllerObjectName()

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::getControllerObjectName ( )
Returns
string

Definition at line 228 of file WidgetContext.php.

References TYPO3\CMS\Fluid\Core\Widget\WidgetContext\$controllerObjectName.

◆ getParentExtensionName()

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::getParentExtensionName ( )

Returns the Extension name of the plugin that contains the widget

Returns
string

Definition at line 168 of file WidgetContext.php.

References TYPO3\CMS\Fluid\Core\Widget\WidgetContext\$parentExtensionName.

◆ getParentPluginName()

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::getParentPluginName ( )

Returns the name of the plugin that contains the widget

Returns
string

Definition at line 187 of file WidgetContext.php.

References TYPO3\CMS\Fluid\Core\Widget\WidgetContext\$parentPluginName.

◆ getParentPluginNamespace()

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::getParentPluginNamespace ( )

Returns the URI namespace of the plugin that contains the widget

Returns
string

Definition at line 149 of file WidgetContext.php.

References TYPO3\CMS\Fluid\Core\Widget\WidgetContext\$parentPluginNamespace.

◆ getViewHelperChildNodeRenderingContext()

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::getViewHelperChildNodeRenderingContext ( )
Returns

Definition at line 260 of file WidgetContext.php.

References TYPO3\CMS\Fluid\Core\Widget\WidgetContext\$viewHelperChildNodeRenderingContext.

◆ getViewHelperChildNodes()

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::getViewHelperChildNodes ( )
Returns

Definition at line 253 of file WidgetContext.php.

References TYPO3\CMS\Fluid\Core\Widget\WidgetContext\$viewHelperChildNodes.

◆ getWidgetConfiguration()

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::getWidgetConfiguration ( )
Returns
array

Definition at line 213 of file WidgetContext.php.

References TYPO3\CMS\Fluid\Core\Widget\WidgetContext\$widgetConfiguration.

◆ getWidgetIdentifier()

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::getWidgetIdentifier ( )
Returns
string

Definition at line 107 of file WidgetContext.php.

References TYPO3\CMS\Fluid\Core\Widget\WidgetContext\$widgetIdentifier.

◆ getWidgetViewHelperClassName()

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::getWidgetViewHelperClassName ( )

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

Returns
string

Definition at line 206 of file WidgetContext.php.

References TYPO3\CMS\Fluid\Core\Widget\WidgetContext\$widgetViewHelperClassName.

◆ setAjaxWidgetIdentifier()

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::setAjaxWidgetIdentifier (   $ajaxWidgetIdentifier)
Parameters
string$ajaxWidgetIdentifier
Returns
void

Definition at line 130 of file WidgetContext.php.

References TYPO3\CMS\Fluid\Core\Widget\WidgetContext\$ajaxWidgetIdentifier.

◆ setControllerObjectName()

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::setControllerObjectName (   $controllerObjectName)
Parameters
string$controllerObjectName
Returns
void

Definition at line 236 of file WidgetContext.php.

References TYPO3\CMS\Fluid\Core\Widget\WidgetContext\$controllerObjectName.

◆ setParentExtensionName()

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::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 TYPO3\CMS\Fluid\Core\Widget\WidgetContext\$parentExtensionName.

◆ setParentPluginName()

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::setParentPluginName (   $parentPluginName)

Sets the name of the plugin that contains the widget

Parameters
string$parentPluginName
Returns
void

Definition at line 178 of file WidgetContext.php.

References TYPO3\CMS\Fluid\Core\Widget\WidgetContext\$parentPluginName.

◆ setParentPluginNamespace()

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::setParentPluginNamespace (   $parentPluginNamespace)

Sets the URI namespace of the plugin that contains the widget

Parameters
string$parentPluginNamespace
Returns
void

Definition at line 140 of file WidgetContext.php.

References TYPO3\CMS\Fluid\Core\Widget\WidgetContext\$parentPluginNamespace.

◆ setViewHelperChildNodes()

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

Definition at line 245 of file WidgetContext.php.

References TYPO3\CMS\Fluid\Core\Widget\WidgetContext\$viewHelperChildNodeRenderingContext, and TYPO3\CMS\Fluid\Core\Widget\WidgetContext\$viewHelperChildNodes.

◆ setWidgetConfiguration()

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::setWidgetConfiguration (   $widgetConfiguration)
Parameters
array$widgetConfiguration
Returns
void

Definition at line 221 of file WidgetContext.php.

References TYPO3\CMS\Fluid\Core\Widget\WidgetContext\$widgetConfiguration.

◆ setWidgetIdentifier()

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::setWidgetIdentifier (   $widgetIdentifier)
Parameters
string$widgetIdentifier
Returns
void

Definition at line 115 of file WidgetContext.php.

References TYPO3\CMS\Fluid\Core\Widget\WidgetContext\$widgetIdentifier.

◆ setWidgetViewHelperClassName()

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::setWidgetViewHelperClassName (   $widgetViewHelperClassName)

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

Parameters
string$widgetViewHelperClassName
Returns
void

Definition at line 197 of file WidgetContext.php.

References TYPO3\CMS\Fluid\Core\Widget\WidgetContext\$widgetViewHelperClassName.

Member Data Documentation

◆ $ajaxWidgetIdentifier

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::$ajaxWidgetIdentifier
protected

Definition at line 48 of file WidgetContext.php.

Referenced by TYPO3\CMS\Fluid\Core\Widget\WidgetContext\getAjaxWidgetIdentifier(), and TYPO3\CMS\Fluid\Core\Widget\WidgetContext\setAjaxWidgetIdentifier().

◆ $controllerObjectName

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::$controllerObjectName
protected

Definition at line 63 of file WidgetContext.php.

Referenced by TYPO3\CMS\Fluid\Core\Widget\WidgetContext\getControllerObjectName(), and TYPO3\CMS\Fluid\Core\Widget\WidgetContext\setControllerObjectName().

◆ $parentExtensionName

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::$parentExtensionName
protected

Definition at line 92 of file WidgetContext.php.

Referenced by TYPO3\CMS\Fluid\Core\Widget\WidgetContext\getParentExtensionName(), and TYPO3\CMS\Fluid\Core\Widget\WidgetContext\setParentExtensionName().

◆ $parentPluginName

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::$parentPluginName
protected

Definition at line 97 of file WidgetContext.php.

Referenced by TYPO3\CMS\Fluid\Core\Widget\WidgetContext\getParentPluginName(), and TYPO3\CMS\Fluid\Core\Widget\WidgetContext\setParentPluginName().

◆ $parentPluginNamespace

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::$parentPluginNamespace
protected

Definition at line 87 of file WidgetContext.php.

Referenced by TYPO3\CMS\Fluid\Core\Widget\WidgetContext\getParentPluginNamespace(), and TYPO3\CMS\Fluid\Core\Widget\WidgetContext\setParentPluginNamespace().

◆ $viewHelperChildNodeRenderingContext

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::$viewHelperChildNodeRenderingContext
protected

Definition at line 82 of file WidgetContext.php.

Referenced by TYPO3\CMS\Fluid\Core\Widget\WidgetContext\getViewHelperChildNodeRenderingContext(), and TYPO3\CMS\Fluid\Core\Widget\WidgetContext\setViewHelperChildNodes().

◆ $viewHelperChildNodes

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::$viewHelperChildNodes
protected

Definition at line 72 of file WidgetContext.php.

Referenced by TYPO3\CMS\Fluid\Core\Widget\WidgetContext\getViewHelperChildNodes(), and TYPO3\CMS\Fluid\Core\Widget\WidgetContext\setViewHelperChildNodes().

◆ $widgetConfiguration

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::$widgetConfiguration
protected

Definition at line 56 of file WidgetContext.php.

Referenced by TYPO3\CMS\Fluid\Core\Widget\WidgetContext\getWidgetConfiguration(), and TYPO3\CMS\Fluid\Core\Widget\WidgetContext\setWidgetConfiguration().

◆ $widgetIdentifier

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::$widgetIdentifier
protected

Definition at line 41 of file WidgetContext.php.

Referenced by TYPO3\CMS\Fluid\Core\Widget\WidgetContext\getWidgetIdentifier(), and TYPO3\CMS\Fluid\Core\Widget\WidgetContext\setWidgetIdentifier().

◆ $widgetViewHelperClassName

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::$widgetViewHelperClassName
protected

Definition at line 102 of file WidgetContext.php.

Referenced by TYPO3\CMS\Fluid\Core\Widget\WidgetContext\getWidgetViewHelperClassName(), and TYPO3\CMS\Fluid\Core\Widget\WidgetContext\setWidgetViewHelperClassName().