class Session in Drupal 9

Wrap session logic around a HTTP request.

Note, the session service is not injected into this class in order to prevent premature initialization of session storage (database). Instead the session service is retrieved from the container only when handling the request.

Hierarchy

• class \Drupal\Core\StackMiddleware\Session implements \Symfony\Component\HttpKernel\HttpKernelInterface uses \Symfony\Component\DependencyInjection\ContainerAwareTrait

4 string references to 'Session'

BigPipeTest::assertSessionCookieExists in core/modules/big_pipe/tests/src/Functional/BigPipeTest.php

Asserts whether a session cookie exists or not.

core.services.yml in core/core.services.yml

core/core.services.yml

language.schema.yml in core/modules/language/config/schema/language.schema.yml

core/modules/language/config/schema/language.schema.yml

SessionCacheContext::getLabel in core/lib/Drupal/Core/Cache/Context/SessionCacheContext.php

1 service uses Session

http_middleware.session in core/core.services.yml

Drupal\Core\StackMiddleware\Session

File

core/lib/Drupal/Core/StackMiddleware/Session.php, line 16

Namespace

Drupal\Core\StackMiddleware

class Session implements HttpKernelInterface {
  use ContainerAwareTrait;

  /**
   * The wrapped HTTP kernel.
   *
   * @var \Symfony\Component\HttpKernel\HttpKernelInterface
   */
  protected $httpKernel;

  /**
   * The session service name.
   *
   * @var string
   */
  protected $sessionServiceName;

  /**
   * Constructs a Session stack middleware object.
   *
   * @param \Symfony\Component\HttpKernel\HttpKernelInterface $http_kernel
   *   The decorated kernel.
   * @param string $service_name
   *   The name of the session service, defaults to "session".
   */
  public function __construct(HttpKernelInterface $http_kernel, $service_name = 'session') {
    $this->httpKernel = $http_kernel;
    $this->sessionServiceName = $service_name;
  }

  /**
   * {@inheritdoc}
   */
  public function handle(Request $request, $type = self::MASTER_REQUEST, $catch = TRUE) {
    if ($type === self::MASTER_REQUEST && PHP_SAPI !== 'cli') {
      $session = $this->container
        ->get($this->sessionServiceName);
      $session
        ->start();
      $request
        ->setSession($session);
    }
    $result = $this->httpKernel
      ->handle($request, $type, $catch);
    if ($type === self::MASTER_REQUEST && $request
      ->hasSession()) {
      $request
        ->getSession()
        ->save();
    }
    return $result;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Session::$httpKernel	protected	property	The wrapped HTTP kernel.
Session::$sessionServiceName	protected	property	The session service name.
Session::handle	public	function
Session::__construct	public	function	Constructs a Session stack middleware object.