Property | Type | Description | |
---|---|---|---|
$argumentNamespace | string | An optional namespace for arguments of this request. Used, for example, in plugins and widgets. | |
$arguments | array | The arguments for this request. They must be only simple types, no objects allowed. | |
$controllerActionName | string | Name of the action the controller is supposed to take. | |
$controllerName | string | Object name of the controller which is supposed to handle this request. | |
$controllerPackageKey | string | Package key of the controller which is supposed to handle this request. | |
$controllerSubpackageKey | string | Subpackage key of the controller which is supposed to handle this request. | |
$dispatched | boolean | If this request has been changed and needs to be dispatched again | |
$format | string | The requested representation format | |
$hashService | |||
$internalArguments | array | All framework-internal arguments start with double underscore (__), and are only used from within the framework. Not for user consumption. Internal Arguments can be objects, in contrast to public arguments. | |
$objectManager | Neos\Flow\ObjectManagement\ObjectManagerInterface | ||
$packageManager | Neos\Flow\Package\PackageManagerInterface | ||
$parentRequest | The parent request – either another ActionRequest or Http Request | ||
$pluginArguments | array | Arguments and configuration for plugins – including widgets – which are sub controllers to the controller referred to by this request. | |
$referringRequest | Cached pointer to a request referring to this one (if any) | ||
$rootRequest | object | Cached pointer to the root request (usually an HTTP request) |
Method | Description | |
---|---|---|
__clone ( ) | Resets the dispatched status to FALSE | |
__construct ( |
Constructs this action request | |
__sleep ( ) : array | We provide our own __sleep method, where we serialize all properties *except* the parentRequest if it is a HTTP request -- as this one contains $_SERVER etc. | |
getArgument ( string $argumentName ) : string | Returns the value of the specified argument | |
getArgumentNamespace ( ) : string | Returns the argument namespace, if any. | |
getArguments ( ) : array | Returns an Array of arguments and their values | |
getControllerActionName ( ) : string | Returns the name of the action the controller is supposed to execute. | |
getControllerName ( ) : string | Returns the object name of the controller supposed to handle this request, if one was set already (if not, the name of the default controller is returned) | |
getControllerObjectName ( ) : string | Returns the object name of the controller defined by the package key and controller name | |
getControllerPackageKey ( ) : string | Returns the package key of the specified controller. | |
getControllerSubpackageKey ( ) : string | Returns the subpackage key of the specified controller. | |
getFormat ( ) : string | Returns the requested representation format | |
getHttpRequest ( ) : |
Returns the top level request: the HTTP request object | |
getInternalArgument ( string $argumentName ) : string | Returns the value of the specified internal argument. | |
getInternalArguments ( ) : array | Returns the internal arguments of the request, that is, all arguments whose name starts with two underscores. | |
getMainRequest ( ) : |
Returns the top level ActionRequest: the one just below the HTTP request | |
getParentRequest ( ) : |
Returns the parent request | |
getPluginArguments ( ) : array | Returns an array of plugin argument configurations | |
getReferringRequest ( ) : |
Returns an ActionRequest which referred to this request, if any. | |
hasArgument ( string $argumentName ) : boolean | Checks if an argument of the given name exists (is set) | |
isDispatched ( ) : boolean | If this request has been dispatched and addressed by the responsible controller and the response is ready to be sent. | |
isMainRequest ( ) : boolean | Checks if this request is the uppermost ActionRequest, just one below the HTTP request. | |
setArgument ( string $argumentName, mixed $value ) : void | Sets the value of the specified argument | |
setArgumentNamespace ( string $namespace ) : void | Sets a namespace for the arguments of this request. | |
setArguments ( array $arguments ) : void | Sets the specified arguments. | |
setControllerActionName ( string $actionName ) : void | Sets the name of the action contained in this request. | |
setControllerName ( string $controllerName ) : void | Sets the name of the controller which is supposed to handle the request. | |
setControllerObjectName ( string $unknownCasedControllerObjectName ) : void | Explicitly sets the object name of the controller | |
setControllerPackageKey ( string $packageKey ) : void | Sets the package key of the controller. | |
setControllerSubpackageKey ( string $subpackageKey ) : void | Sets the subpackage key of the controller. | |
setDispatched ( boolean $flag ) : void | Sets the dispatched flag | |
setFormat ( string $format ) : void | Sets the requested representation format |
Method | Description | |
---|---|---|
emitRequestDispatched ( |
Emits a signal when a Request has been dispatched |
public __construct ( |
||
$parentRequest | Either an HTTP request or another ActionRequest |
protected emitRequestDispatched ( |
||
$request | ||
return | void |
public getArgument ( string $argumentName ) : string | ||
$argumentName | string | Name of the argument |
return | string | Value of the argument |
public getArgumentNamespace ( ) : string | ||
return | string |
public getArguments ( ) : array | ||
return | array | Array of arguments and their values (which may be arguments and values as well) |
public getControllerActionName ( ) : string | ||
return | string | Action name |
public getControllerName ( ) : string | ||
return | string | Name of the controller |
public getControllerObjectName ( ) : string | ||
return | string | The controller's Object Name |
public getControllerPackageKey ( ) : string | ||
return | string | The package key |
public getControllerSubpackageKey ( ) : string | ||
return | string | The subpackage key |
public getHttpRequest ( ) : |
||
return |
public getInternalArgument ( string $argumentName ) : string | ||
$argumentName | string | Name of the argument, for example "__fooBar" |
return | string | Value of the argument, or NULL if not set. |
public getInternalArguments ( ) : array | ||
return | array |
public getMainRequest ( ) : |
||
return |
public getParentRequest ( ) : |
||
return |
public getPluginArguments ( ) : array | ||
return | array |
public getReferringRequest ( ) : |
||
return | the referring request, or NULL if no referrer found |
public hasArgument ( string $argumentName ) : boolean | ||
$argumentName | string | Name of the argument to check |
return | boolean | TRUE if the argument is set, otherwise FALSE |
public isDispatched ( ) : boolean | ||
return | boolean | TRUE if this request has been dispatched successfully |
public isMainRequest ( ) : boolean | ||
return | boolean |
public setArgumentNamespace ( string $namespace ) : void | ||
$namespace | string | Argument namespace |
return | void |
public setArguments ( array $arguments ) : void | ||
$arguments | array | An array of argument names and their values |
return | void |
public setControllerActionName ( string $actionName ) : void | ||
$actionName | string | Name of the action to execute by the controller |
return | void |
public setControllerName ( string $controllerName ) : void | ||
$controllerName | string | Name of the controller |
return | void |
public setControllerObjectName ( string $unknownCasedControllerObjectName ) : void | ||
$unknownCasedControllerObjectName | string | The fully qualified controller object name |
return | void |
public setControllerPackageKey ( string $packageKey ) : void | ||
$packageKey | string | The package key |
return | void |
public setControllerSubpackageKey ( string $subpackageKey ) : void | ||
$subpackageKey | string | The subpackage key. |
return | void |
public setDispatched ( boolean $flag ) : void | ||
$flag | boolean | If this request has been dispatched |
return | void |
protected string $argumentNamespace | ||
return | string |
protected array $arguments | ||
return | array |
protected string $controllerActionName | ||
return | string |
protected string $controllerName | ||
return | string |
protected string $controllerPackageKey | ||
return | string |
protected string $controllerSubpackageKey | ||
return | string |
protected bool $dispatched | ||
return | boolean |
protected string $format | ||
return | string |
protected HashService,Neos\Flow\Security\Cryptography $hashService | ||
return |
protected array $internalArguments | ||
return | array |
protected ObjectManagerInterface,Neos\Flow\ObjectManagement $objectManager | ||
return | Neos\Flow\ObjectManagement\ObjectManagerInterface |
protected PackageManagerInterface,Neos\Flow\Package $packageManager | ||
return | Neos\Flow\Package\PackageManagerInterface |
protected ActionRequest,Neos\Flow\Mvc|Request,Neos\Flow\Http $parentRequest | ||
return |
protected array $pluginArguments | ||
return | array |
protected ActionRequest,Neos\Flow\Mvc $referringRequest | ||
return |
protected object $rootRequest | ||
return | object |