‪TYPO3CMS  9.5
TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetController Class Reference
Inheritance diagram for TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetController:
TYPO3\CMS\Extbase\Mvc\Controller\ActionController TYPO3\CMS\Core\SingletonInterface TYPO3\CMS\Extbase\Mvc\Controller\AbstractController TYPO3\CMS\Extbase\Mvc\Controller\ControllerInterface TYPO3\CMS\Fluid\ViewHelpers\Be\Widget\Controller\PaginateController TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\AutocompleteController TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController

Public Member Functions

 processRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
 injectReflectionService (\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService)
 
 injectCacheService (\TYPO3\CMS\Extbase\Service\CacheService $cacheService)
 
 injectMvcPropertyMappingConfigurationService (\TYPO3\CMS\Extbase\Mvc\Controller\MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService)
 
 processRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
 injectSignalSlotDispatcher (\TYPO3\CMS\Extbase\SignalSlot\Dispatcher $signalSlotDispatcher)
 
 injectValidatorResolver (\TYPO3\CMS\Extbase\Validation\ValidatorResolver $validatorResolver)
 
ControllerContext getControllerContext ()
 
 __construct ()
 
 injectConfigurationManager (ConfigurationManagerInterface $configurationManager)
 
 injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
 
 addFlashMessage ($messageBody, $messageTitle='', $severity=\TYPO3\CMS\Core\Messaging\AbstractMessage::OK, $storeInSession=true)
 
bool canProcessRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request)
 
 forward ($actionName, $controllerName=null, $extensionName=null, array $arguments=null)
 
 throwStatus ($statusCode, $statusMessage=null, $content=null)
 
 initializeControllerArgumentsBaseValidators ()
 

Protected Member Functions

 setViewConfiguration (\TYPO3\CMS\Extbase\Mvc\View\ViewInterface $view)
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
 renderAssetsForRequest ($request)
 
 initializeActionMethodArguments ()
 
 initializeActionMethodValidators ()
 
string resolveActionMethodName ()
 
 callActionMethod ()
 
 emitBeforeCallActionMethodSignal (array $preparedArguments)
 
ViewInterface resolveView ()
 
 setViewConfiguration (ViewInterface $view)
 
array getViewProperty ($extbaseFrameworkConfiguration, $setting)
 
mixed resolveViewObjectName ()
 
 initializeView (ViewInterface $view)
 
 initializeAction ()
 
string errorAction ()
 
 clearCacheOnError ()
 
 addErrorFlashMessage ()
 
string getErrorFlashMessage ()
 
 forwardToReferringRequest ()
 
string getFlattenedValidationErrorMessage ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
TYPO3 CMS Extbase Mvc Controller ControllerContext buildControllerContext ()
 
 redirect ($actionName, $controllerName=null, $extensionName=null, array $arguments=null, $pageUid=null, $delay=0, $statusCode=303)
 
 redirectToUri ($uri, $delay=0, $statusCode=303)
 
string addBaseUriIfNecessary ($uri)
 
 mapRequestArgumentsToControllerArguments ()
 

Protected Attributes

array $supportedRequestTypes = array( \TYPO3\CMS\Fluid\Core\Widget\WidgetRequest::class )
 
array $widgetConfiguration
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
TYPO3 CMS Extbase Reflection ReflectionService $reflectionService
 
TYPO3 CMS Extbase Service CacheService $cacheService
 
ViewInterface $view
 
string $namespacesViewObjectNamePattern = '@vendor\@extension\View\@controller\@action@format'
 
array $viewFormatToObjectNameMap = array( )
 
string $defaultViewObjectName = \TYPO3\CMS\Fluid\View\TemplateView::class
 
string $actionMethodName = 'indexAction'
 
string $errorMethodName = 'errorAction'
 
TYPO3 CMS Extbase Mvc Controller MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService
 
TYPO3 CMS Extbase Mvc Request $request
 
TYPO3 CMS Extbase Mvc Response $response
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
TYPO3 CMS Extbase SignalSlot Dispatcher $signalSlotDispatcher
 
TYPO3 CMS Extbase Object ObjectManagerInterface $objectManager
 
TYPO3 CMS Extbase Mvc Web Routing UriBuilder $uriBuilder
 
string $extensionName
 
array $settings
 
TYPO3 CMS Extbase Mvc RequestInterface $request
 
TYPO3 CMS Extbase Mvc ResponseInterface $response
 
TYPO3 CMS Extbase Validation ValidatorResolver $validatorResolver
 
TYPO3 CMS Extbase Mvc Controller Arguments $arguments
 
array $supportedRequestTypes = array( \TYPO3\CMS\Extbase\Mvc\Request::class )
 
TYPO3 CMS Extbase Mvc Controller ControllerContext $controllerContext
 
ConfigurationManagerInterface $configurationManager
 

Additional Inherited Members

- ‪Static Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
static array getActionMethodParameters ($objectManager)
 

Detailed Description

This is the base class for all widget controllers. It is basically an ActionController and additionally has $this->widgetConfiguration set to the Configuration of the current Widget.

Definition at line 24 of file AbstractWidgetController.php.

Member Function Documentation

◆ processRequest()

TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetController::processRequest ( \TYPO3\CMS\Extbase\Mvc\RequestInterface  $request,
\TYPO3\CMS\Extbase\Mvc\ResponseInterface  $response 
)

Handles a request. The result output is returned by altering the given response.

Parameters
\TYPO3\CMS\Extbase\Mvc\RequestInterface$request‪The request object
\TYPO3\CMS\Extbase\Mvc\ResponseInterface$response‪The response, modified by this handler

Definition at line 42 of file AbstractWidgetController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\ActionController\$request, and TYPO3\CMS\Extbase\Mvc\Controller\ActionController\$response.

◆ setViewConfiguration()

TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetController::setViewConfiguration ( \TYPO3\CMS\Extbase\Mvc\View\ViewInterface  $view)
protected

Allows the widget template root path to be overridden via the framework configuration, e.g. plugin.tx_extension.view.widget.<WidgetViewHelperClassName>.templateRootPath

Parameters
\TYPO3\CMS\Extbase\Mvc\View\ViewInterface$view

Definition at line 54 of file AbstractWidgetController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\ActionController\$view.

Member Data Documentation

◆ $supportedRequestTypes

array TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetController::$supportedRequestTypes = array( \TYPO3\CMS\Fluid\Core\Widget\WidgetRequest::class )
protected

Definition at line 28 of file AbstractWidgetController.php.

◆ $widgetConfiguration

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

Configuration for this widget.

Definition at line 34 of file AbstractWidgetController.php.