PHP 클래스 Neos\Flow\Mvc\ActionRequest

상속: implements Neos\Flow\Mvc\RequestInterface
파일 보기 프로젝트 열기: neos/flow-development-collection 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$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 Neos\Flow\Security\Cryptography\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 ActionRequest | Request 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 ActionRequest Cached pointer to a request referring to this one (if any)
$rootRequest object Cached pointer to the root request (usually an HTTP request)

공개 메소드들

메소드 설명
__clone ( ) Resets the dispatched status to FALSE
__construct ( ActionRequest | Request $parentRequest ) 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 ( ) : Request 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 ( ) : ActionRequest Returns the top level ActionRequest: the one just below the HTTP request
getParentRequest ( ) : ActionRequest | Request Returns the parent request
getPluginArguments ( ) : array Returns an array of plugin argument configurations
getReferringRequest ( ) : ActionRequest 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

보호된 메소드들

메소드 설명
emitRequestDispatched ( ActionRequest $request ) : void Emits a signal when a Request has been dispatched

메소드 상세

__clone() 공개 메소드

Resets the dispatched status to FALSE
public __clone ( )

__construct() 공개 메소드

Constructs this action request
public __construct ( ActionRequest | Request $parentRequest )
$parentRequest ActionRequest | Request Either an HTTP request or another ActionRequest

__sleep() 공개 메소드

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.
public __sleep ( ) : array
리턴 array

emitRequestDispatched() 보호된 메소드

The action request is not proxyable, so the signal is dispatched manually here. The safeguard allows unit tests without the dispatcher dependency.
protected emitRequestDispatched ( ActionRequest $request ) : void
$request ActionRequest
리턴 void

getArgument() 공개 메소드

Returns the value of the specified argument
public getArgument ( string $argumentName ) : string
$argumentName string Name of the argument
리턴 string Value of the argument

getArgumentNamespace() 공개 메소드

Returns the argument namespace, if any.
public getArgumentNamespace ( ) : string
리턴 string

getArguments() 공개 메소드

Returns an Array of arguments and their values
public getArguments ( ) : array
리턴 array Array of arguments and their values (which may be arguments and values as well)

getControllerActionName() 공개 메소드

Returns the name of the action the controller is supposed to execute.
public getControllerActionName ( ) : string
리턴 string Action name

getControllerName() 공개 메소드

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)
public getControllerName ( ) : string
리턴 string Name of the controller

getControllerObjectName() 공개 메소드

Returns the object name of the controller defined by the package key and controller name
public getControllerObjectName ( ) : string
리턴 string The controller's Object Name

getControllerPackageKey() 공개 메소드

Returns the package key of the specified controller.
public getControllerPackageKey ( ) : string
리턴 string The package key

getControllerSubpackageKey() 공개 메소드

If there is no subpackage key set, the method returns NULL.
public getControllerSubpackageKey ( ) : string
리턴 string The subpackage key

getFormat() 공개 메소드

Returns the requested representation format
public getFormat ( ) : string
리턴 string The desired format, something like "html", "xml", "png", "json" or the like.

getHttpRequest() 공개 메소드

Returns the top level request: the HTTP request object
public getHttpRequest ( ) : Request
리턴 Neos\Flow\Http\Request

getInternalArgument() 공개 메소드

Internal arguments are set via setArgument(). In order to be handled as an internal argument, its name must start with two underscores.
public getInternalArgument ( string $argumentName ) : string
$argumentName string Name of the argument, for example "__fooBar"
리턴 string Value of the argument, or NULL if not set.

getInternalArguments() 공개 메소드

Returns the internal arguments of the request, that is, all arguments whose name starts with two underscores.
public getInternalArguments ( ) : array
리턴 array

getMainRequest() 공개 메소드

Returns the top level ActionRequest: the one just below the HTTP request
public getMainRequest ( ) : ActionRequest
리턴 ActionRequest

getParentRequest() 공개 메소드

Returns the parent request
public getParentRequest ( ) : ActionRequest | Request
리턴 ActionRequest | Request

getPluginArguments() 공개 메소드

Returns an array of plugin argument configurations
public getPluginArguments ( ) : array
리턴 array

getReferringRequest() 공개 메소드

The referring request is not set or determined automatically but must be explicitly set through the corresponding internal argument "__referrer". This mechanism is used by Flow's form and validation mechanisms.
public getReferringRequest ( ) : ActionRequest
리턴 ActionRequest the referring request, or NULL if no referrer found

hasArgument() 공개 메소드

Checks if an argument of the given name exists (is set)
public hasArgument ( string $argumentName ) : boolean
$argumentName string Name of the argument to check
리턴 boolean TRUE if the argument is set, otherwise FALSE

isDispatched() 공개 메소드

The dispatcher will try to dispatch the request again if it has not been addressed yet.
public isDispatched ( ) : boolean
리턴 boolean TRUE if this request has been dispatched successfully

isMainRequest() 공개 메소드

Checks if this request is the uppermost ActionRequest, just one below the HTTP request.
public isMainRequest ( ) : boolean
리턴 boolean

setArgument() 공개 메소드

Sets the value of the specified argument
public setArgument ( string $argumentName, mixed $value ) : void
$argumentName string Name of the argument to set
$value mixed The new value
리턴 void

setArgumentNamespace() 공개 메소드

This doesn't affect the actual behavior of argument handling within this classes' methods but is used in other parts of Flow and its libraries to render argument names which don't conflict with each other.
public setArgumentNamespace ( string $namespace ) : void
$namespace string Argument namespace
리턴 void

setArguments() 공개 메소드

The arguments array will be reset therefore any arguments which existed before will be overwritten!
public setArguments ( array $arguments ) : void
$arguments array An array of argument names and their values
리턴 void

setControllerActionName() 공개 메소드

Note that the action name must start with a lower case letter and is case sensitive.
public setControllerActionName ( string $actionName ) : void
$actionName string Name of the action to execute by the controller
리턴 void

setControllerName() 공개 메소드

Note: This is not the object name of the controller! Examples: "Standard", "Account", ...
public setControllerName ( string $controllerName ) : void
$controllerName string Name of the controller
리턴 void

setControllerObjectName() 공개 메소드

Explicitly sets the object name of the controller
public setControllerObjectName ( string $unknownCasedControllerObjectName ) : void
$unknownCasedControllerObjectName string The fully qualified controller object name
리턴 void

setControllerPackageKey() 공개 메소드

This function tries to determine the correct case for the given package key. If the Package Manager does not know the specified package, the package key cannot be verified or corrected and is stored as is.
public setControllerPackageKey ( string $packageKey ) : void
$packageKey string The package key
리턴 void

setControllerSubpackageKey() 공개 메소드

Sets the subpackage key of the controller.
public setControllerSubpackageKey ( string $subpackageKey ) : void
$subpackageKey string The subpackage key.
리턴 void

setDispatched() 공개 메소드

Sets the dispatched flag
public setDispatched ( boolean $flag ) : void
$flag boolean If this request has been dispatched
리턴 void

setFormat() 공개 메소드

Sets the requested representation format
public setFormat ( string $format ) : void
$format string The desired format, something like "html", "xml", "png", "json" or the like. Can even be something like "rss.xml".
리턴 void

프로퍼티 상세

$argumentNamespace 보호되어 있는 프로퍼티

An optional namespace for arguments of this request. Used, for example, in plugins and widgets.
protected string $argumentNamespace
리턴 string

$arguments 보호되어 있는 프로퍼티

The arguments for this request. They must be only simple types, no objects allowed.
protected array $arguments
리턴 array

$controllerActionName 보호되어 있는 프로퍼티

Name of the action the controller is supposed to take.
protected string $controllerActionName
리턴 string

$controllerName 보호되어 있는 프로퍼티

Object name of the controller which is supposed to handle this request.
protected string $controllerName
리턴 string

$controllerPackageKey 보호되어 있는 프로퍼티

Package key of the controller which is supposed to handle this request.
protected string $controllerPackageKey
리턴 string

$controllerSubpackageKey 보호되어 있는 프로퍼티

Subpackage key of the controller which is supposed to handle this request.
protected string $controllerSubpackageKey
리턴 string

$dispatched 보호되어 있는 프로퍼티

If this request has been changed and needs to be dispatched again
protected bool $dispatched
리턴 boolean

$format 보호되어 있는 프로퍼티

The requested representation format
protected string $format
리턴 string

$hashService 보호되어 있는 프로퍼티

protected HashService,Neos\Flow\Security\Cryptography $hashService
리턴 Neos\Flow\Security\Cryptography\HashService

$internalArguments 보호되어 있는 프로퍼티

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.
protected array $internalArguments
리턴 array

$objectManager 보호되어 있는 프로퍼티

protected ObjectManagerInterface,Neos\Flow\ObjectManagement $objectManager
리턴 Neos\Flow\ObjectManagement\ObjectManagerInterface

$packageManager 보호되어 있는 프로퍼티

protected PackageManagerInterface,Neos\Flow\Package $packageManager
리턴 Neos\Flow\Package\PackageManagerInterface

$parentRequest 보호되어 있는 프로퍼티

The parent request – either another ActionRequest or Http Request
protected ActionRequest,Neos\Flow\Mvc|Request,Neos\Flow\Http $parentRequest
리턴 ActionRequest | Request

$pluginArguments 보호되어 있는 프로퍼티

Arguments and configuration for plugins – including widgets – which are sub controllers to the controller referred to by this request.
protected array $pluginArguments
리턴 array

$referringRequest 보호되어 있는 프로퍼티

Cached pointer to a request referring to this one (if any)
protected ActionRequest,Neos\Flow\Mvc $referringRequest
리턴 ActionRequest

$rootRequest 보호되어 있는 프로퍼티

Cached pointer to the root request (usually an HTTP request)
protected object $rootRequest
리턴 object