![]() |
TYPO3
7.6
|
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 = array(\TYPO3\CMS\Extbase\Mvc\Request::class) | |
$controllerContext | |
$configurationManager | |
An abstract base class for Controllers
Definition at line 27 of file extbase/Classes/Mvc/Controller/AbstractController.php.
__construct | ( | ) |
Constructs the controller.
Definition at line 131 of file extbase/Classes/Mvc/Controller/AbstractController.php.
|
protected |
Adds the base uri if not already in place.
string | $uri | The URI |
Definition at line 367 of file extbase/Classes/Mvc/Controller/AbstractController.php.
Referenced by AbstractController\redirectToUri().
addFlashMessage | ( | $messageBody, | |
$messageTitle = '' , |
|||
$severity = \TYPO3\CMS\Core\Messaging\AbstractMessage::OK , |
|||
$storeInSession = true |
|||
) |
Creates a Message object and adds it to the FlashMessageQueue.
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 |
\InvalidArgumentException | if the message body is no string |
Definition at line 181 of file extbase/Classes/Mvc/Controller/AbstractController.php.
Referenced by ListController\addComposerModeNotification(), ActionController\addErrorFlashMessage(), PermissionController\editAction(), UploadExtensionFileController\extractAction(), DocumentController\fetchAction(), DownloadController\installDistributionAction(), ActionController\removeExtensionAction(), BackendUserController\terminateBackendUserSessionAction(), ActionController\toggleExtensionInstallationStateAction(), and DownloadController\updateExtensionAction().
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.
\TYPO3\CMS\Extbase\Mvc\RequestInterface | $request | The current request |
Implements ControllerInterface.
Definition at line 204 of file extbase/Classes/Mvc/Controller/AbstractController.php.
Referenced by ActionController\processRequest(), and AbstractController\processRequest().
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.
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 |
StopActionException |
Definition at line 276 of file extbase/Classes/Mvc/Controller/AbstractController.php.
References AbstractController\$arguments, and AbstractController\$extensionName.
Referenced by BackendUserController\addToCompareListAction(), FrontendController\confirmationAction(), FrontendController\dispatchConfirmationButtonClickAction(), BackendModuleController\enableInstallToolAction(), ActionController\forwardToReferringRequest(), BackendModuleController\indexAction(), DownloadController\installDistributionAction(), ActionController\installExtensionWithoutSystemDependencyCheckAction(), DownloadController\installExtensionWithoutSystemDependencyCheckAction(), BackendUserController\removeFromCompareListAction(), FileListController\searchAction(), FrontendController\skipForeignFormProcessing(), and BackendUserController\terminateBackendUserSessionAction().
getControllerContext | ( | ) |
Definition at line 118 of file extbase/Classes/Mvc/Controller/AbstractController.php.
References AbstractController\$controllerContext.
injectConfigurationManager | ( | ConfigurationManagerInterface | $configurationManager | ) |
ConfigurationManagerInterface | $configurationManager |
Definition at line 151 of file extbase/Classes/Mvc/Controller/AbstractController.php.
References AbstractController\$configurationManager, and ConfigurationManagerInterface\CONFIGURATION_TYPE_SETTINGS.
injectObjectManager | ( | \TYPO3\CMS\Extbase\Object\ObjectManagerInterface | $objectManager | ) |
Injects the object manager
\TYPO3\CMS\Extbase\Object\ObjectManagerInterface | $objectManager |
Definition at line 163 of file extbase/Classes/Mvc/Controller/AbstractController.php.
References AbstractController\$objectManager.
injectSignalSlotDispatcher | ( | \TYPO3\CMS\Extbase\SignalSlot\Dispatcher | $signalSlotDispatcher | ) |
\TYPO3\CMS\Extbase\SignalSlot\Dispatcher | $signalSlotDispatcher |
Definition at line 86 of file extbase/Classes/Mvc/Controller/AbstractController.php.
References AbstractController\$signalSlotDispatcher.
injectValidatorResolver | ( | \TYPO3\CMS\Extbase\Validation\ValidatorResolver | $validatorResolver | ) |
\TYPO3\CMS\Extbase\Validation\ValidatorResolver | $validatorResolver |
Definition at line 94 of file extbase/Classes/Mvc/Controller/AbstractController.php.
References AbstractController\$validatorResolver.
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.
\TYPO3\CMS\Extbase\Mvc\RequestInterface | $request | The request object |
\TYPO3\CMS\Extbase\Mvc\ResponseInterface | $response | The response, modified by this handler |
UnsupportedRequestTypeException | if the controller doesn't support the current request type |
Implements ControllerInterface.
Definition at line 223 of file extbase/Classes/Mvc/Controller/AbstractController.php.
References AbstractController\$request, AbstractController\$response, and AbstractController\canProcessRequest().
|
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.
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 |
UnsupportedRequestTypeException | If the request is not a web request |
StopActionException |
Definition at line 315 of file extbase/Classes/Mvc/Controller/AbstractController.php.
References AbstractController\$arguments, AbstractController\$extensionName, and AbstractController\redirectToUri().
Referenced by AdministrationController\deleteIndexedItemAction(), ReportController\detailAction(), DocumentController\downloadAction(), UploadExtensionFileController\extractAction(), DocumentController\fetchAction(), ReportController\initializeAction(), DownloadController\installDistributionAction(), ConfigurationController\saveAndCloseAction(), AdministrationController\saveStopwordsKeywordsAction(), AdministrationController\statisticDetailsAction(), ActionController\toggleExtensionInstallationStateAction(), and PermissionController\updateAction().
|
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.
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 |
UnsupportedRequestTypeException | If the request is not a web request |
StopActionException |
Definition at line 343 of file extbase/Classes/Mvc/Controller/AbstractController.php.
References AbstractController\addBaseUriIfNecessary().
Referenced by AbstractController\redirect().
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.
int | $statusCode | The HTTP status code |
string | $statusMessage | A custom HTTP status message |
string | $content | Body content which further explains the status |
UnsupportedRequestTypeException | If the request is not a web request |
StopActionException |
Definition at line 384 of file extbase/Classes/Mvc/Controller/AbstractController.php.
|
protected |
Definition at line 81 of file extbase/Classes/Mvc/Controller/AbstractController.php.
Referenced by AbstractController\forward(), AbstractController\redirect(), and AbstractController\translate().
|
protected |
Definition at line 126 of file extbase/Classes/Mvc/Controller/AbstractController.php.
Referenced by AbstractController\injectConfigurationManager().
|
protected |
Definition at line 112 of file extbase/Classes/Mvc/Controller/AbstractController.php.
Referenced by AbstractController\getControllerContext().
|
protected |
Definition at line 47 of file extbase/Classes/Mvc/Controller/AbstractController.php.
Referenced by AbstractController\forward(), AbstractController\redirect(), and ViewModuleController\registerButtons().
|
protected |
Definition at line 37 of file extbase/Classes/Mvc/Controller/AbstractController.php.
Referenced by ActionController\getActionMethodParameters(), and AbstractController\injectObjectManager().
|
protected |
Definition at line 63 of file extbase/Classes/Mvc/Controller/AbstractController.php.
Referenced by AbstractController\processRequest().
|
protected |
Definition at line 71 of file extbase/Classes/Mvc/Controller/AbstractController.php.
Referenced by AbstractController\processRequest().
|
protected |
Definition at line 55 of file extbase/Classes/Mvc/Controller/AbstractController.php.
|
protected |
Definition at line 32 of file extbase/Classes/Mvc/Controller/AbstractController.php.
Referenced by AbstractController\injectSignalSlotDispatcher().
|
protected |
Definition at line 106 of file extbase/Classes/Mvc/Controller/AbstractController.php.
|
protected |
Definition at line 42 of file extbase/Classes/Mvc/Controller/AbstractController.php.
Referenced by AbstractModuleController\generateMenu(), BackendUserActionController\generateMenu(), AdministrationController\generateMenu(), AbstractModuleController\getHref(), BackendUserActionController\getHref(), AdministrationController\getHref(), SearchController\linkPage(), and DistributionController\showAction().
|
protected |
Definition at line 76 of file extbase/Classes/Mvc/Controller/AbstractController.php.
Referenced by AbstractController\injectValidatorResolver().