• Home
• Neos
• Flow
• Mvc
• Controller
• ActionController

PHP Class Neos\Flow\Mvc\Controller\ActionController

The action specified in the given ActionRequest is dispatched to a method in the concrete controller whose name ends with "*Action". If no matching action method is found, the action specified in $errorMethodName is invoked. This controller also takes care of mapping arguments found in the ActionRequest to the corresponding method arguments of the action method. It also invokes validation for these arguments by invoking the Property Mapper. By defining media types in $supportedMediaTypes, content negotiation based on the browser's Accept header and additional routing configuration is used to determine the output format the controller should return. Depending on the action being called, a fitting view - determined by configuration - will be selected. By specifying patterns, custom view classes or an alternative controller / action to template path mapping can be defined. Show file Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Property	Type	Description
$actionMethodName	string	Name of the action method
$defaultViewImplementation	string
$defaultViewObjectName	string	The default view object to use if none of the resolved views can render a response for the current request.
$errorMethodName	string	Name of the special error action method which is called in case of errors
$mvcPropertyMappingConfigurationService	MvcPropertyMappingConfigurationService
$objectManager	Neos\Flow\ObjectManagement\ObjectManagerInterface
$reflectionService	Neos\Flow\Reflection\ReflectionService
$settings	array
$systemLogger	Neos\Flow\Log\SystemLoggerInterface
$view	Neos\Flow\Mvc\View\ViewInterface	The current view, as resolved by resolveView()
$viewConfigurationManager	Neos\Flow\Mvc\ViewConfigurationManager
$viewFormatToObjectNameMap	array	Example: array('html' => 'MyCompany\MyApp\MyHtmlView', 'json' => 'MyCompany\...
$viewObjectNamePattern	string	Pattern after which the view object name is built if no format-specific view could be resolved.

Public Methods

Method	Description
getActionIgnoredValidationArguments ( Neos\Flow\ObjectManagement\ObjectManagerInterface $objectManager ) : array
getActionMethodParameters ( Neos\Flow\ObjectManagement\ObjectManagerInterface $objectManager ) : array	Returns a map of action method names and their parameters.
getActionValidateAnnotationData ( Neos\Flow\ObjectManagement\ObjectManagerInterface $objectManager ) : array	Returns a map of action method names and their validation parameters.
getActionValidationGroups ( Neos\Flow\ObjectManagement\ObjectManagerInterface $objectManager ) : array	Returns a map of action method names and their validation groups.
getPublicActionMethods ( Neos\Flow\ObjectManagement\ObjectManagerInterface $objectManager ) : array
injectSettings ( array $settings ) : void
processRequest ( Neos\Flow\Mvc\RequestInterface $request, Neos\Flow\Mvc\ResponseInterface $response ) : void	Handles a request. The result output is returned by altering the given response.

Protected Methods

Method	Description
addErrorFlashMessage ( ) : void	If an error occurred during this request, this adds a flash message describing the error to the flash message container.
callActionMethod ( ) : void	Calls the specified action method and passes the arguments.
errorAction ( ) : string	A special action which is called if the originally intended action could not be called, for example if the arguments were not valid.
forwardToReferringRequest ( ) : void	If information on the request before the current request was sent, this method forwards back to the originating request. This effectively ends processing of the current request, so do not call this method before you have finished the necessary business logic!
getErrorFlashMessage ( ) : Neos\Error\Messages\Message	A template method for displaying custom error flash messages, or to display no flash message at all on errors. Override this to customize the flash message in your action controller.
getFlattenedValidationErrorMessage ( ) : string	Returns a string containing all validation errors separated by PHP_EOL.
getInformationNeededForInitializeActionMethodValidators ( ) : array	This is a helper method purely used to make initializeActionMethodValidators() testable without mocking static methods.
handleTargetNotFoundError ( ) : void	Checks if the arguments validation result contain errors of type TargetNotFoundError and throws a TargetNotFoundException if that's the case for a top-level object.
initializeAction ( ) : void	Initializes the controller before invoking an action method.
initializeActionMethodArguments ( ) : void	Implementation of the arguments initialization in the action controller: Automatically registers arguments of the current action
initializeActionMethodValidators ( ) : void	Adds the needed validators to the Arguments:
initializeView ( Neos\Flow\Mvc\View\ViewInterface $view ) : void	Initializes the view before invoking an action method.
resolveActionMethodName ( ) : string	Resolves and checks the current action method name
resolveView ( ) : Neos\Flow\Mvc\View\ViewInterface	Prepares a view for the current action and stores it in $this->view.
resolveViewObjectName ( ) : mixed	Determines the fully qualified view object name.

Method Details

Property Details