TYPO3\CMS\Extbase\Mvc\Controller\AbstractController Class Reference

Inheritance diagram for TYPO3\CMS\Extbase\Mvc\Controller\AbstractController:

Public Member Functions
	injectSignalSlotDispatcher (\TYPO3\CMS\Extbase\SignalSlot\Dispatcher $signalSlotDispatcher)
	injectValidatorResolver (\TYPO3\CMS\Extbase\Validation\ValidatorResolver $validatorResolver)
	getControllerContext ()
	__construct ()
	injectConfigurationManager (ConfigurationManagerInterface $configurationManager)
	injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
	addFlashMessage ($messageBody, $messageTitle='', $severity=\TYPO3\CMS\Core\Messaging\AbstractMessage::OK, $storeInSession=true)
	canProcessRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request)
	processRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response)
	forward ($actionName, $controllerName=null, $extensionName=null, array $arguments=null)
	throwStatus ($statusCode, $statusMessage=null, $content=null)

Protected Member Functions
	redirect ($actionName, $controllerName=null, $extensionName=null, array $arguments=null, $pageUid=null, $delay=0, $statusCode=303)
	redirectToUri ($uri, $delay=0, $statusCode=303)
	addBaseUriIfNecessary ($uri)

Protected Attributes
	$signalSlotDispatcher
	$objectManager
	$uriBuilder
	$extensionName
	$settings
	$request
	$response
	$validatorResolver
	$arguments
	$supportedRequestTypes = [\TYPO3\CMS\Extbase\Mvc\Request::class]
	$controllerContext
	$configurationManager

Detailed Description

An abstract base class for Controllers

Definition at line 27 of file AbstractController.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::__construct

(

)

Constructs the controller.

Definition at line 131 of file AbstractController.php.

Member Function Documentation

addBaseUriIfNecessary()

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::addBaseUriIfNecessary (   $uri )

protected

Adds the base uri if not already in place.

Parameters

string

$uri

The URI

Returns

string

Definition at line 367 of file AbstractController.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\redirectToUri().

addFlashMessage()

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::addFlashMessage	(		$messageBody,
			$messageTitle = '',
			$severity = \TYPO3\CMS\Core\Messaging\AbstractMessage::OK,
			$storeInSession = true
	)

Creates a Message object and adds it to the FlashMessageQueue.

Parameters

string	$messageBody	The message
string	$messageTitle	Optional message title
int	$severity	Optional severity, must be one of constants
bool	$storeInSession	Optional, defines whether the message should be stored in the session (default) or not

Returns

void

Exceptions

Definition at line 181 of file AbstractController.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Extensionmanager\Controller\ListController\addComposerModeNotification(), TYPO3\CMS\Extbase\Mvc\Controller\ActionController\addErrorFlashMessage(), TYPO3\CMS\Beuser\Controller\PermissionController\editAction(), TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\extractAction(), TYPO3\CMS\Documentation\Controller\DocumentController\fetchAction(), TYPO3\CMS\Beuser\Controller\PermissionController\initializeView(), TYPO3\CMS\Extensionmanager\Controller\DownloadController\installDistributionAction(), TYPO3\CMS\Extensionmanager\Controller\ActionController\removeExtensionAction(), TYPO3\CMS\Extensionmanager\Controller\ListController\terAction(), TYPO3\CMS\Beuser\Controller\BackendUserController\terminateBackendUserSessionAction(), TYPO3\CMS\Extensionmanager\Controller\ActionController\toggleExtensionInstallationStateAction(), and TYPO3\CMS\Extensionmanager\Controller\DownloadController\updateExtensionAction().

canProcessRequest()

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::canProcessRequest

(

\TYPO3\CMS\Extbase\Mvc\RequestInterface

$request

)

Checks if the current request type is supported by the controller.

If your controller only supports certain request types, either replace / modify the supportedRequestTypes property or override this method.

Parameters

\TYPO3\CMS\Extbase\Mvc\RequestInterface

$request

The current request

Returns

bool TRUE if this request type is supported, otherwise FALSE

Implements TYPO3\CMS\Extbase\Mvc\Controller\ControllerInterface.

Definition at line 204 of file AbstractController.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Controller\ActionController\processRequest(), and TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\processRequest().

forward()

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::forward	(		$actionName,
			$controllerName = null,
			$extensionName = null,
		array	$arguments = null
	)

Forwards the request to another action and / or controller.

Request is directly transferred to the other action / controller without the need for a new request.

Parameters

string	$actionName	Name of the action to forward to
string	$controllerName	Unqualified object name of the controller to forward to. If not specified, the current controller is used.
string	$extensionName	Name of the extension containing the controller to forward to. If not specified, the current extension is assumed.
array	$arguments	Arguments to pass to the target action

Returns

void

Exceptions

StopActionException

See also

redirect()

Definition at line 276 of file AbstractController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\$arguments, and TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\$extensionName.

Referenced by TYPO3\CMS\Beuser\Controller\BackendUserController\addToCompareListAction(), TYPO3\CMS\Form\Controller\FrontendController\confirmationAction(), TYPO3\CMS\Cshmanual\Controller\HelpController\detailAction(), TYPO3\CMS\Form\Controller\FrontendController\dispatchConfirmationButtonClickAction(), TYPO3\CMS\Install\Controller\BackendModuleController\enableInstallToolAction(), TYPO3\CMS\Extbase\Mvc\Controller\ActionController\forwardToReferringRequest(), OliverHader\IrreTutorial\Controller\QueueController\indexAction(), TYPO3\CMS\Install\Controller\BackendModuleController\indexAction(), TYPO3\CMS\Filelist\Controller\FileListController\initializeIndexAction(), TYPO3\CMS\Extensionmanager\Controller\DownloadController\installDistributionAction(), TYPO3\CMS\Extensionmanager\Controller\ActionController\installExtensionWithoutSystemDependencyCheckAction(), TYPO3\CMS\Extensionmanager\Controller\DownloadController\installExtensionWithoutSystemDependencyCheckAction(), OliverHader\IrreTutorial\Controller\AbstractController\process(), OliverHader\IrreTutorial\Controller\QueueController\processAction(), TYPO3\CMS\Beuser\Controller\BackendUserController\removeFromCompareListAction(), TYPO3\CMS\Filelist\Controller\FileListController\searchAction(), TYPO3\CMS\Form\Controller\FrontendController\skipForeignFormProcessing(), and TYPO3\CMS\Beuser\Controller\BackendUserController\terminateBackendUserSessionAction().

getControllerContext()

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::getControllerContext

(

)

Returns

ControllerContext

Definition at line 118 of file AbstractController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\$controllerContext.

injectConfigurationManager()

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::injectConfigurationManager

(

ConfigurationManagerInterface

$configurationManager

)

Parameters

ConfigurationManagerInterface

$configurationManager

Returns

void

Definition at line 151 of file AbstractController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\$configurationManager, and TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface\CONFIGURATION_TYPE_SETTINGS.

injectObjectManager()

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::injectObjectManager

(

\TYPO3\CMS\Extbase\Object\ObjectManagerInterface

$objectManager

)

Injects the object manager

Parameters

\TYPO3\CMS\Extbase\Object\ObjectManagerInterface

$objectManager

Returns

void

Definition at line 163 of file AbstractController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\$objectManager.

injectSignalSlotDispatcher()

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::injectSignalSlotDispatcher

(

\TYPO3\CMS\Extbase\SignalSlot\Dispatcher

$signalSlotDispatcher

)

Parameters

\TYPO3\CMS\Extbase\SignalSlot\Dispatcher

$signalSlotDispatcher

Definition at line 86 of file AbstractController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\$signalSlotDispatcher.

injectValidatorResolver()

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::injectValidatorResolver

(

\TYPO3\CMS\Extbase\Validation\ValidatorResolver

$validatorResolver

)

Parameters

\TYPO3\CMS\Extbase\Validation\ValidatorResolver

$validatorResolver

Definition at line 94 of file AbstractController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\$validatorResolver.

processRequest()

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::processRequest	(	\TYPO3\CMS\Extbase\Mvc\RequestInterface	$request,
		\TYPO3\CMS\Extbase\Mvc\ResponseInterface	$response
	)

Processes a general request. The result can be 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

Returns

void

Exceptions

UnsupportedRequestTypeException

if the controller doesn't support the current request type

Implements TYPO3\CMS\Extbase\Mvc\Controller\ControllerInterface.

Definition at line 223 of file AbstractController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\$controllerContext, TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\$request, TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\$response, and TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\canProcessRequest().

redirect()

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::redirect (   $actionName,   $controllerName = null,   $extensionName = null, array  $arguments = null,   $pageUid = null,   $delay = 0,   $statusCode = 303  )

protected

Redirects the request to another action and / or controller.

Redirect will be sent to the client which then performs another request to the new URI.

NOTE: This method only supports web requests and will thrown an exception if used with other request types.

Parameters

string	$actionName	Name of the action to forward to
string	$controllerName	Unqualified object name of the controller to forward to. If not specified, the current controller is used.
string	$extensionName	Name of the extension containing the controller to forward to. If not specified, the current extension is assumed.
array	$arguments	Arguments to pass to the target action
int	$pageUid	Target page uid. If NULL, the current page uid is used
int	$delay	(optional) The delay in seconds. Default is no delay.
int	$statusCode	(optional) The HTTP status code for the redirect. Default is "303 See Other

Returns

void

Exceptions

UnsupportedRequestTypeException	If the request is not a web request
StopActionException

See also

forward()

Definition at line 315 of file AbstractController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\$arguments, TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\$extensionName, and TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\redirectToUri().

Referenced by OliverHader\IrreTutorial\Controller\ContentController\createAction(), OliverHader\IrreTutorial\Controller\ContentController\deleteAction(), TYPO3\CMS\IndexedSearch\Controller\AdministrationController\deleteIndexedItemAction(), TYPO3\CMS\Reports\Controller\ReportController\detailAction(), TYPO3\CMS\Documentation\Controller\DocumentController\downloadAction(), TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\extractAction(), TYPO3\CMS\Documentation\Controller\DocumentController\fetchAction(), TYPO3\CMS\IndexedSearch\Controller\SearchController\initialize(), TYPO3\CMS\Reports\Controller\ReportController\initializeAction(), TYPO3\CMS\Extensionmanager\Controller\ConfigurationController\injectExtensionRepository(), TYPO3\CMS\Extensionmanager\Controller\DownloadController\installDistributionAction(), TYPO3\CMS\Workspaces\Controller\ReviewController\registerButtons(), TYPO3\CMS\Extensionmanager\Controller\ActionController\reloadExtensionDataAction(), TYPO3\CMS\Extensionmanager\Controller\ConfigurationController\saveAndCloseAction(), TYPO3\CMS\IndexedSearch\Controller\AdministrationController\saveStopwordsKeywordsAction(), TYPO3\CMS\IndexedSearch\Controller\AdministrationController\statisticDetailsAction(), TYPO3\CMS\Extensionmanager\Controller\ActionController\toggleExtensionInstallationStateAction(), and OliverHader\IrreTutorial\Controller\ContentController\updateAction().

redirectToUri()

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::redirectToUri (   $uri,   $delay = 0,   $statusCode = 303  )

protected

Redirects the web request to another uri.

NOTE: This method only supports web requests and will thrown an exception if used with other request types.

Parameters

mixed	$uri	A string representation of a URI
int	$delay	(optional) The delay in seconds. Default is no delay.
int	$statusCode	(optional) The HTTP status code for the redirect. Default is "303 See Other

Exceptions

UnsupportedRequestTypeException	If the request is not a web request
StopActionException

Definition at line 343 of file AbstractController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\addBaseUriIfNecessary().

Referenced by TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\redirect(), and TYPO3\CMS\Beuser\Controller\PermissionController\updateAction().

throwStatus()

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::throwStatus	(		$statusCode,
			$statusMessage = null,
			$content = null
	)

Sends the specified HTTP status immediately.

NOTE: This method only supports web requests and will thrown an exception if used with other request types.

Parameters

int	$statusCode	The HTTP status code
string	$statusMessage	A custom HTTP status message
string	$content	Body content which further explains the status

Exceptions

UnsupportedRequestTypeException	If the request is not a web request
StopActionException

Definition at line 384 of file AbstractController.php.

Member Data Documentation

$arguments

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::$arguments

protected

Definition at line 81 of file AbstractController.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\forward(), OliverHader\IrreTutorial\Controller\AbstractController\getRuntimeIdentifier(), ExtbaseTeam\BlogExample\Controller\BlogController\getRuntimeIdentifier(), ExtbaseTeam\BlogExample\Controller\ContentController\getRuntimeIdentifier(), TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\redirect(), and TYPO3\CMS\Extensionmanager\Controller\AbstractController\translate().

$configurationManager

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::$configurationManager

protected

Definition at line 126 of file AbstractController.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\injectConfigurationManager().

$controllerContext

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::$controllerContext

protected

Definition at line 112 of file AbstractController.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\getControllerContext(), and TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\processRequest().

$extensionName

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::$extensionName

protected

Definition at line 47 of file AbstractController.php.

Referenced by TYPO3\CMS\Cshmanual\Controller\HelpController\detailAction(), TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\forward(), TYPO3\CMS\Beuser\Controller\BackendUserActionController\generateMenu(), TYPO3\CMS\Extbase\Tests\Fixture\DummyController\getExtensionName(), TYPO3\CMS\Recycler\Controller\RecyclerModuleController\indexAction(), TYPO3\CMS\Beuser\Controller\PermissionController\initializeView(), TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\redirect(), and TYPO3\CMS\Viewpage\Controller\ViewModuleController\registerButtons().

$objectManager

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::$objectManager

protected

Definition at line 37 of file AbstractController.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Controller\ActionController\getActionMethodParameters(), and TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\injectObjectManager().

$request

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::$request

protected

Definition at line 63 of file AbstractController.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\processRequest().

$response

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::$response

protected

Definition at line 71 of file AbstractController.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\processRequest().

$settings

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::$settings

protected

Definition at line 55 of file AbstractController.php.

$signalSlotDispatcher

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::$signalSlotDispatcher

protected

Definition at line 32 of file AbstractController.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\injectSignalSlotDispatcher().

$supportedRequestTypes

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::$supportedRequestTypes = [\TYPO3\CMS\Extbase\Mvc\Request::class]

protected

Definition at line 106 of file AbstractController.php.

$uriBuilder

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::$uriBuilder

protected

Definition at line 42 of file AbstractController.php.

Referenced by TYPO3\CMS\Lang\Controller\LanguageController\deactivateLanguageAction(), TYPO3\CMS\Extensionmanager\Controller\ConfigurationController\emitAfterExtensionConfigurationWriteSignal(), TYPO3\CMS\Extensionmanager\Controller\AbstractModuleController\generateMenu(), TYPO3\CMS\Beuser\Controller\BackendUserActionController\generateMenu(), TYPO3\CMS\IndexedSearch\Controller\AdministrationController\generateMenu(), TYPO3\CMS\Extensionmanager\Controller\AbstractModuleController\getHref(), TYPO3\CMS\Beuser\Controller\BackendUserActionController\getHref(), TYPO3\CMS\IndexedSearch\Controller\AdministrationController\getHref(), TYPO3\CMS\Workspaces\Controller\PreviewController\initializeAction(), TYPO3\CMS\IndexedSearch\Controller\SearchController\linkPage(), TYPO3\CMS\Extensionmanager\Controller\DistributionController\showAction(), and TYPO3\CMS\Extensionmanager\Controller\ListController\showAllVersionsAction().

$validatorResolver

TYPO3\CMS\Extbase\Mvc\Controller\AbstractController::$validatorResolver

protected

Definition at line 76 of file AbstractController.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\injectValidatorResolver(), and TYPO3\CMS\Form\Controller\FrontendController\prepareValidations().