9.5/_abstract_widget_view_helper_8php_source.html

<?php

namespace ‪TYPO3\CMS\Fluid\Core\Widget;


/*

 * This file is part of the TYPO3 CMS project.

 *

 * It is free software; you can redistribute it and/or modify it under

 * the terms of the GNU General Public License, either version 2

 * of the License, or any later version.

 *

 * For the full copyright and license information, please read the

 * LICENSE.txt file that was distributed with this source code.

 *

 * The TYPO3 project - inspiring people to share!

 */


use TYPO3Fluid\Fluid\Component\ComponentInterface;

use TYPO3Fluid\Fluid\Core\Compiler\TemplateCompiler;

use TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\ViewHelperNode;

use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;

use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;


abstract class ‪AbstractWidgetViewHelper extends AbstractViewHelper

{

    protected ‪$controller;


    protected ‪$ajaxWidget = false;


    private ‪$ajaxWidgetContextHolder;


    protected ‪$objectManager;


    protected ‪$extensionService;


    protected ‪$escapeOutput = false;


    private ‪$widgetContext;


    public function ‪injectAjaxWidgetContextHolder(\‪TYPO3\CMS\Fluid\Core\Widget\‪AjaxWidgetContextHolder ‪$ajaxWidgetContextHolder)

    {

        $this->ajaxWidgetContextHolder = ‪$ajaxWidgetContextHolder;

    }


    public function ‪injectObjectManager(\‪TYPO3\CMS\‪Extbase\Object\ObjectManagerInterface ‪$objectManager)

    {

        $this->objectManager = ‪$objectManager;

        $this->widgetContext = $this->objectManager->get(\‪TYPO3\CMS\Fluid\Core\Widget\WidgetContext::class);

    }


    public function ‪injectExtensionService(\‪TYPO3\CMS\‪Extbase\Service\ExtensionService ‪$extensionService)

    {

        $this->extensionService = ‪$extensionService;

    }


    public function ‪initializeArguments()

    {

        $this->registerArgument(

            'customWidgetId',

            'string',

            'extend the widget identifier with a custom widget id',

            false,

            null

        );

    }


    public function ‪initializeArgumentsAndRender()

    {

        $this->validateArguments();

        $this->initialize();

        $this->‪initializeWidgetContext();

        return $this->callRenderMethod();

    }


    public function ‪evaluate(RenderingContextInterface $renderingContext)

    {

        $this->renderingContext = $renderingContext;

        $this->getArguments()->setRenderingContext($renderingContext);

        $this->‪initializeWidgetContext();

        return $this->callRenderMethod();

    }


    public function ‪onClose(RenderingContextInterface $renderingContext): ComponentInterface

    {

        $node = parent::onClose($renderingContext);

        $rootNode = $this->objectManager->get(\‪TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\RootNode::class);

        $rootNode->setChildren($this->getChildren());

        $this->widgetContext->setViewHelperChildNodes($rootNode, $renderingContext);

        return $node;

    }


    private function ‪initializeWidgetContext()

    {

        $this->widgetContext->setWidgetConfiguration($this->‪getWidgetConfiguration());

        $this->‪initializeWidgetIdentifier();

        $this->widgetContext->setControllerObjectName(get_class($this->controller));

        $vendorName = $this->renderingContext->getControllerContext()->getRequest()->getControllerVendorName();

        $extensionName = $this->renderingContext->getControllerContext()->getRequest()->getControllerExtensionName();

        $pluginName = $this->renderingContext->getControllerContext()->getRequest()->getPluginName();

        $this->widgetContext->setParentVendorName($vendorName);

        $this->widgetContext->setParentExtensionName($extensionName);

        $this->widgetContext->setParentPluginName($pluginName);

        $pluginNamespace = $this->extensionService->getPluginNamespace($extensionName, $pluginName);

        $this->widgetContext->setParentPluginNamespace($pluginNamespace);

        $this->widgetContext->setWidgetViewHelperClassName(static::class);

        if ($this->ajaxWidget === true) {

            $this->ajaxWidgetContextHolder->store($this->widgetContext);

        }

    }


    public function ‪setChildNodes(array $childNodes)

    {

        $rootNode = $this->objectManager->get(\‪TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\RootNode::class);

        foreach ($childNodes as $childNode) {

            $rootNode->addChildNode($childNode);

        }

        $this->widgetContext->setViewHelperChildNodes($rootNode, $this->renderingContext);

    }


    protected function ‪getWidgetConfiguration()

    {

        return $this->arguments;

    }


    protected function ‪initiateSubRequest()

    {

        if (!isset($this->controller) || !$this->controller instanceof \‪TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetController) {

            throw new \TYPO3\CMS\Fluid\Core\Widget\Exception\MissingControllerException(

                'initiateSubRequest() can not be called if there is no valid controller extending ' .

                'TYPO3\\CMS\\Fluid\\Core\\Widget\\AbstractWidgetController' .

                ' Got "' . ($this->controller ? get_class($this->controller) : gettype($this->controller)) .

                '" in class "' . static::class . '".',

                1289422564

            );

        }

        $subRequest = $this->objectManager->get(\‪TYPO3\CMS\Fluid\Core\Widget\WidgetRequest::class);

        $subRequest->setWidgetContext($this->widgetContext);

        $this->‪passArgumentsToSubRequest($subRequest);

        $subResponse = $this->objectManager->get(\‪TYPO3\CMS\‪Extbase\Mvc\Web\Response::class);

        $this->controller->processRequest($subRequest, $subResponse);

        return $subResponse;

    }


    private function ‪passArgumentsToSubRequest(\‪TYPO3\CMS\Fluid\Core\Widget\‪WidgetRequest $subRequest)

    {

        $arguments = $this->renderingContext->getControllerContext()->getRequest()->getArguments();

        $widgetIdentifier = $this->widgetContext->getWidgetIdentifier();

        if (isset($arguments[$widgetIdentifier])) {

            if (isset($arguments[$widgetIdentifier]['action'])) {

                $subRequest->setControllerActionName($arguments[$widgetIdentifier]['action']);

                unset($arguments[$widgetIdentifier]['action']);

            }

            $subRequest->setArguments($arguments[$widgetIdentifier]);

        }

    }


    private function ‪initializeWidgetIdentifier()

    {

        $viewHelperVariableContainer = $this->renderingContext->getViewHelperVariableContainer();

        $widgetCounter = $viewHelperVariableContainer->get(\‪TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::class, 'nextWidgetNumber', 0);

        $widgetIdentifier = '@widget_' . ((isset($this->arguments['customWidgetId']) && $this->arguments['customWidgetId'] !== null) ? $this->arguments['customWidgetId'] . '_' : '') . $widgetCounter;

        $viewHelperVariableContainer->addOrUpdate(\‪TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper::class, 'nextWidgetNumber', $widgetCounter + 1);

        $this->widgetContext->setWidgetIdentifier($widgetIdentifier);

    }


    public function ‪compile($argumentsName, $closureName, &$initializationPhpCode, ViewHelperNode $node, TemplateCompiler $compiler)

    {

        $compiler->disable();

        return '\'\'';

    }

}