PHP Class Neos\Flow\Mvc\Controller\RestController

Inheritance: extends ActionController
Mostra file Open project: neos/flow-development-collection

Protected Properties

Property Type Description
$request Neos\Flow\Mvc\ActionRequest The current request
$resourceArgumentName string Name of the action method argument which acts as the resource for the RESTful controller. If an argument with the specified name is passed to the controller, the show, update and delete actions can be triggered automatically.
$response Neos\Flow\Http\Response The response which will be returned by this action controller

Protected Methods

Method Description
initializeCreateAction ( ) : void Allow creation of resources in createAction()
initializeUpdateAction ( ) : void Allow modification of resources in updateAction()
redirectToUri ( mixed $uri, integer $delay, integer $statusCode = 303 ) : void Redirects the web request to another uri.
resolveActionMethodName ( ) : string Determines the action method and assures that the method exists.

Method Details

initializeCreateAction() protected method

Allow creation of resources in createAction()
protected initializeCreateAction ( ) : void
return void

initializeUpdateAction() protected method

Allow modification of resources in updateAction()
protected initializeUpdateAction ( ) : void
return void

redirectToUri() protected method

NOTE: This method only supports web requests and will throw an exception if used with other request types.
protected redirectToUri ( mixed $uri, integer $delay, integer $statusCode = 303 ) : void
$uri mixed Either a string representation of a URI or a \Neos\Flow\Http\Uri object
$delay integer (optional) The delay in seconds. Default is no delay.
$statusCode integer (optional) The HTTP status code for the redirect. Default is "303 See Other"
return void

resolveActionMethodName() protected method

Determines the action method and assures that the method exists.
protected resolveActionMethodName ( ) : string
return string The action method name

Property Details

$request protected_oe property

The current request
protected ActionRequest,Neos\Flow\Mvc $request
return Neos\Flow\Mvc\ActionRequest

$resourceArgumentName protected_oe property

Name of the action method argument which acts as the resource for the RESTful controller. If an argument with the specified name is passed to the controller, the show, update and delete actions can be triggered automatically.
protected string $resourceArgumentName
return string

$response protected_oe property

The response which will be returned by this action controller
protected Response,Neos\Flow\Http $response
return Neos\Flow\Http\Response