class TestMiddleware

Same name in other branches
  1. 9 core/modules/system/tests/modules/httpkernel_test/src/HttpKernel/TestMiddleware.php \Drupal\httpkernel_test\HttpKernel\TestMiddleware
  2. 8.9.x core/modules/system/tests/modules/httpkernel_test/src/HttpKernel/TestMiddleware.php \Drupal\httpkernel_test\HttpKernel\TestMiddleware
  3. 11.x core/modules/system/tests/modules/http_kernel_test/src/HttpKernel/TestMiddleware.php \Drupal\http_kernel_test\HttpKernel\TestMiddleware

Provides a test middleware.

Hierarchy

Expanded class hierarchy of TestMiddleware

1 string reference to 'TestMiddleware'
http_kernel_test.services.yml in core/modules/system/tests/modules/http_kernel_test/http_kernel_test.services.yml
core/modules/system/tests/modules/http_kernel_test/http_kernel_test.services.yml
2 services use TestMiddleware
http_kernel_test.test_middleware in core/modules/system/tests/modules/http_kernel_test/http_kernel_test.services.yml
Drupal\http_kernel_test\HttpKernel\TestMiddleware
http_kernel_test.test_middleware2 in core/modules/system/tests/modules/http_kernel_test/http_kernel_test.services.yml
Drupal\http_kernel_test\HttpKernel\TestMiddleware

File

core/modules/system/tests/modules/http_kernel_test/src/HttpKernel/TestMiddleware.php, line 12

Namespace

Drupal\http_kernel_test\HttpKernel
View source 
class TestMiddleware implements HttpKernelInterface {
    
    /**
     * The decorated kernel.
     *
     * @var \Symfony\Component\HttpKernel\HttpKernelInterface
     */
    protected $kernel;
    
    /**
     * An optional argument.
     *
     * @var mixed
     */
    protected $optionalArgument;
    
    /**
     * Constructs a new TestMiddleware object.
     *
     * @param \Symfony\Component\HttpKernel\HttpKernelInterface $kernel
     *   The decorated kernel.
     * @param mixed $optional_argument
     *   (optional) An optional argument.
     */
    public function __construct(HttpKernelInterface $kernel, $optional_argument = NULL) {
        $this->kernel = $kernel;
        $this->optionalArgument = $optional_argument;
    }
    
    /**
     * {@inheritdoc}
     */
    public function handle(Request $request, $type = self::MAIN_REQUEST, $catch = TRUE) : Response {
        $request->attributes
            ->set('_hello', 'world');
        if ($request->attributes
            ->has('_optional_argument')) {
            $request->attributes
                ->set('_previous_optional_argument', $request->attributes
                ->get('_optional_argument'));
        }
        elseif (isset($this->optionalArgument)) {
            $request->attributes
                ->set('_optional_argument', $this->optionalArgument);
        }
        return $this->kernel
            ->handle($request, $type, $catch);
    }

}

Members

Title Modifiers Object type Summary
TestMiddleware::$kernel protected property The decorated kernel.
TestMiddleware::$optionalArgument protected property An optional argument.
TestMiddleware::handle public function
TestMiddleware::__construct public function Constructs a new TestMiddleware object.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.