PHP Class Neos\Flow\Http\Component\ComponentContext

An instance of this class will be passed to each component of the chain allowing them to read/write parameters to/from it. Besides handling of the chain is interrupted as soon as the "cancelled" flag is set. The instance will be created before the bootstrap, so AOP/DI proxying is not possible.
Show file Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Property Type Description
$httpRequest Neos\Flow\Http\Request The current HTTP request
$httpResponse Neos\Flow\Http\Response The current HTTP response
$parameters array Two-dimensional array storing an parameter dictionary (containing variables that can be read/written by all components) The first dimension is the fully qualified Component name, the second dimension is the identifier for the parameter.

Public Methods

Method Description
__construct ( Request $httpRequest, Response $httpResponse )
getHttpRequest ( ) : Request
getHttpResponse ( ) : Response
getParameter ( string $componentClassName, string $parameterName ) : mixed
replaceHttpRequest ( Request $httpRequest ) : void
replaceHttpResponse ( Response $httpResponse ) : void
setParameter ( string $componentClassName, string $parameterName, mixed $value )

Method Details

__construct() public method

public __construct ( Request $httpRequest, Response $httpResponse )
$httpRequest Neos\Flow\Http\Request
$httpResponse Neos\Flow\Http\Response

getHttpRequest() public method

public getHttpRequest ( ) : Request
return Neos\Flow\Http\Request

getHttpResponse() public method

public getHttpResponse ( ) : Response
return Neos\Flow\Http\Response

getParameter() public method

public getParameter ( string $componentClassName, string $parameterName ) : mixed
$componentClassName string
$parameterName string
return mixed

replaceHttpRequest() public method

public replaceHttpRequest ( Request $httpRequest ) : void
$httpRequest Neos\Flow\Http\Request
return void

replaceHttpResponse() public method

public replaceHttpResponse ( Response $httpResponse ) : void
$httpResponse Neos\Flow\Http\Response
return void

setParameter() public method

public setParameter ( string $componentClassName, string $parameterName, mixed $value )
$componentClassName string
$parameterName string
$value mixed

Property Details

$httpRequest protected property

The current HTTP request
protected Request,Neos\Flow\Http $httpRequest
return Neos\Flow\Http\Request

$httpResponse protected property

The current HTTP response
protected Response,Neos\Flow\Http $httpResponse
return Neos\Flow\Http\Response

$parameters protected property

Two-dimensional array storing an parameter dictionary (containing variables that can be read/written by all components) The first dimension is the fully qualified Component name, the second dimension is the identifier for the parameter.
protected array $parameters
return array