‪TYPO3CMS  9.5
Public Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Fluid\Core\Widget\WidgetContext Class Reference

Public Member Functions

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

Protected Attributes

string $widgetIdentifier
 
string $ajaxWidgetIdentifier
 
array $widgetConfiguration
 
string $controllerObjectName
 
TYPO3Fluid Fluid Core Parser SyntaxTree RootNode $viewHelperChildNodes
 
TYPO3Fluid Fluid Core Rendering RenderingContextInterface $viewHelperChildNodeRenderingContext
 
string $parentPluginNamespace
 
string $parentVendorName
 
string $parentExtensionName
 
string $parentPluginName
 
string $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()

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

Definition at line 283 of file WidgetContext.php.

◆ getAjaxWidgetIdentifier()

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

Definition at line 109 of file WidgetContext.php.

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

◆ getControllerObjectName()

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

Definition at line 241 of file WidgetContext.php.

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

◆ getParentExtensionName()

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

Returns the Extension name of the plugin that contains the widget

Returns
‪string

Definition at line 157 of file WidgetContext.php.

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

◆ getParentPluginName()

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

Returns the name of the plugin that contains the widget

Returns
‪string

Definition at line 197 of file WidgetContext.php.

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

◆ getParentPluginNamespace()

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

Returns the URI namespace of the plugin that contains the widget

Returns
‪string

Definition at line 137 of file WidgetContext.php.

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

◆ getParentVendorName()

string TYPO3\CMS\Fluid\Core\Widget\WidgetContext::getParentVendorName ( )

Returns the Vendor name of the plugin that contains the widget

Returns
‪string

Definition at line 177 of file WidgetContext.php.

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

◆ getViewHelperChildNodeRenderingContext()

TYPO3Fluid Fluid Core Rendering RenderingContextInterface TYPO3\CMS\Fluid\Core\Widget\WidgetContext::getViewHelperChildNodeRenderingContext ( )
Returns
‪\TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface

Definition at line 275 of file WidgetContext.php.

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

◆ getViewHelperChildNodes()

TYPO3Fluid Fluid Core Parser SyntaxTree RootNode TYPO3\CMS\Fluid\Core\Widget\WidgetContext::getViewHelperChildNodes ( )
Returns
‪\TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\RootNode

Definition at line 267 of file WidgetContext.php.

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

◆ getWidgetConfiguration()

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

Definition at line 225 of file WidgetContext.php.

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

◆ getWidgetIdentifier()

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

Definition at line 93 of file WidgetContext.php.

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

◆ getWidgetViewHelperClassName()

string 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 217 of file WidgetContext.php.

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

◆ setAjaxWidgetIdentifier()

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

Definition at line 117 of file WidgetContext.php.

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

Referenced by TYPO3\CMS\Fluid\Core\Widget\AjaxWidgetContextHolder\store().

◆ setControllerObjectName()

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

Definition at line 249 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

Definition at line 147 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

Definition at line 187 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

Definition at line 127 of file WidgetContext.php.

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

◆ setParentVendorName()

TYPO3\CMS\Fluid\Core\Widget\WidgetContext::setParentVendorName (   $parentVendorName)

Sets the Vendor name of the plugin that contains the widget

Parameters
string$parentVendorName

Definition at line 167 of file WidgetContext.php.

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

◆ setViewHelperChildNodes()

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

Definition at line 258 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

Definition at line 233 of file WidgetContext.php.

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

◆ setWidgetIdentifier()

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

Definition at line 101 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

Definition at line 207 of file WidgetContext.php.

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

Member Data Documentation

◆ $ajaxWidgetIdentifier

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

Per-User unique identifier of the widget, if it is an AJAX widget.

Definition at line 40 of file WidgetContext.php.

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

◆ $controllerObjectName

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

The fully qualified object name of the Controller which this widget uses.

Definition at line 53 of file WidgetContext.php.

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

◆ $parentExtensionName

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

Definition at line 80 of file WidgetContext.php.

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

◆ $parentPluginName

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

Definition at line 84 of file WidgetContext.php.

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

◆ $parentPluginNamespace

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

Definition at line 72 of file WidgetContext.php.

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

◆ $parentVendorName

string TYPO3\CMS\Fluid\Core\Widget\WidgetContext::$parentVendorName
protected

Definition at line 76 of file WidgetContext.php.

Referenced by TYPO3\CMS\Fluid\Core\Widget\WidgetContext\getParentVendorName(), and TYPO3\CMS\Fluid\Core\Widget\WidgetContext\setParentVendorName().

◆ $viewHelperChildNodeRenderingContext

TYPO3Fluid Fluid Core Rendering RenderingContextInterface TYPO3\CMS\Fluid\Core\Widget\WidgetContext::$viewHelperChildNodeRenderingContext
protected

The rendering context of the ViewHelperChildNodes. Only available inside non-AJAX requests.

Todo:
‪rename to something more meaningful.

Definition at line 68 of file WidgetContext.php.

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

◆ $viewHelperChildNodes

TYPO3Fluid Fluid Core Parser SyntaxTree RootNode TYPO3\CMS\Fluid\Core\Widget\WidgetContext::$viewHelperChildNodes
protected

The child nodes of the Widget ViewHelper. Only available inside non-AJAX requests.

Definition at line 60 of file WidgetContext.php.

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

◆ $widgetConfiguration

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

User-supplied widget configuration, available inside the widget controller as $this->widgetConfiguration.

Definition at line 47 of file WidgetContext.php.

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

◆ $widgetIdentifier

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

Uniquely identifies a Widget Instance on a certain page.

Definition at line 34 of file WidgetContext.php.

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

◆ $widgetViewHelperClassName

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

Definition at line 88 of file WidgetContext.php.

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