PHP Class Neos\FluidAdaptor\Core\Widget\WidgetContext

The WidgetContext can be fetched from the current request as internal argument __widgetContext, and is thus available throughout the whole sub-request of the widget. It is used internally by various ViewHelpers (like , , ), to get knowledge over the current widget's configuration. It is a purely internal class which should not be used outside of Fluid.
Show file Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Property Type Description
$ajaxWidgetConfiguration array User-supplied widget configuration, available inside the widget controller as $this->widgetConfiguration, if being inside an AJAX request
$ajaxWidgetIdentifier integer Per-User unique identifier of the widget, if it is an AJAX widget.
$controllerObjectName string The fully qualified object name of the Controller which this widget uses.
$nonAjaxWidgetConfiguration array User-supplied widget configuration, available inside the widget controller as $this->widgetConfiguration, if being inside a non-AJAX request
$viewHelperChildNodeRenderingContext TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface Only available inside non-AJAX requests.
$viewHelperChildNodes TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\RootNode Only available inside non-AJAX requests.
$widgetIdentifier string Uniquely idenfies a Widget Instance on a certain page.

Public Methods

Method Description
__sleep ( ) : array Serialize everything *except* the viewHelperChildNodes, viewHelperChildNodeRenderingContext and nonAjaxWidgetConfiguration
getAjaxWidgetIdentifier ( ) : integer
getControllerObjectName ( ) : string
getViewHelperChildNodeRenderingContext ( ) : TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface
getViewHelperChildNodes ( ) : TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\RootNode
getWidgetConfiguration ( ) : array
getWidgetIdentifier ( ) : string
setAjaxWidgetConfiguration ( array $ajaxWidgetConfiguration ) : void
setAjaxWidgetIdentifier ( integer $ajaxWidgetIdentifier ) : void
setControllerObjectName ( string $controllerObjectName ) : void
setNonAjaxWidgetConfiguration ( array $nonAjaxWidgetConfiguration ) : void
setViewHelperChildNodes ( TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\RootNode $viewHelperChildNodes, TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface $viewHelperChildNodeRenderingContext ) : void
setWidgetIdentifier ( string $widgetIdentifier ) : void

Method Details

__sleep() public method

Serialize everything *except* the viewHelperChildNodes, viewHelperChildNodeRenderingContext and nonAjaxWidgetConfiguration
public __sleep ( ) : array
return array

getAjaxWidgetIdentifier() public method

public getAjaxWidgetIdentifier ( ) : integer
return integer

getControllerObjectName() public method

public getControllerObjectName ( ) : string
return string

getViewHelperChildNodeRenderingContext() public method

public getViewHelperChildNodeRenderingContext ( ) : TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface
return TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface

getViewHelperChildNodes() public method

public getViewHelperChildNodes ( ) : TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\RootNode
return TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\RootNode

getWidgetConfiguration() public method

public getWidgetConfiguration ( ) : array
return array

getWidgetIdentifier() public method

public getWidgetIdentifier ( ) : string
return string

setAjaxWidgetConfiguration() public method

public setAjaxWidgetConfiguration ( array $ajaxWidgetConfiguration ) : void
$ajaxWidgetConfiguration array
return void

setAjaxWidgetIdentifier() public method

public setAjaxWidgetIdentifier ( integer $ajaxWidgetIdentifier ) : void
$ajaxWidgetIdentifier integer
return void

setControllerObjectName() public method

public setControllerObjectName ( string $controllerObjectName ) : void
$controllerObjectName string
return void

setNonAjaxWidgetConfiguration() public method

public setNonAjaxWidgetConfiguration ( array $nonAjaxWidgetConfiguration ) : void
$nonAjaxWidgetConfiguration array
return void

setViewHelperChildNodes() public method

public setViewHelperChildNodes ( TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\RootNode $viewHelperChildNodes, TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface $viewHelperChildNodeRenderingContext ) : void
$viewHelperChildNodes TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\RootNode
$viewHelperChildNodeRenderingContext TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface
return void

setWidgetIdentifier() public method

public setWidgetIdentifier ( string $widgetIdentifier ) : void
$widgetIdentifier string
return void

Property Details

$ajaxWidgetConfiguration protected property

User-supplied widget configuration, available inside the widget controller as $this->widgetConfiguration, if being inside an AJAX request
protected array $ajaxWidgetConfiguration
return array

$ajaxWidgetIdentifier protected property

Per-User unique identifier of the widget, if it is an AJAX widget.
protected int $ajaxWidgetIdentifier
return integer

$controllerObjectName protected property

The fully qualified object name of the Controller which this widget uses.
protected string $controllerObjectName
return string

$nonAjaxWidgetConfiguration protected property

User-supplied widget configuration, available inside the widget controller as $this->widgetConfiguration, if being inside a non-AJAX request
protected array $nonAjaxWidgetConfiguration
return array

$viewHelperChildNodeRenderingContext protected property

Only available inside non-AJAX requests.
protected RenderingContextInterface,TYPO3Fluid\Fluid\Core\Rendering $viewHelperChildNodeRenderingContext
return TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface

$viewHelperChildNodes protected property

Only available inside non-AJAX requests.
protected RootNode,TYPO3Fluid\Fluid\Core\Parser\SyntaxTree $viewHelperChildNodes
return TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\RootNode

$widgetIdentifier protected property

Uniquely idenfies a Widget Instance on a certain page.
protected string $widgetIdentifier
return string