NoSessionOpen.php

Same filename in other branches
  1. 8.9.x core/lib/Drupal/Core/PageCache/RequestPolicy/NoSessionOpen.php
  2. 10 core/lib/Drupal/Core/PageCache/RequestPolicy/NoSessionOpen.php
  3. 11.x core/lib/Drupal/Core/PageCache/RequestPolicy/NoSessionOpen.php

Namespace

Drupal\Core\PageCache\RequestPolicy

File

core/lib/Drupal/Core/PageCache/RequestPolicy/NoSessionOpen.php

View source
<?php

namespace Drupal\Core\PageCache\RequestPolicy;

use Drupal\Core\PageCache\RequestPolicyInterface;
use Drupal\Core\Session\SessionConfigurationInterface;
use Symfony\Component\HttpFoundation\Request;

/**
 * A policy allowing delivery of cached pages when there is no session open.
 *
 * Do not serve cached pages to authenticated users, or to anonymous users when
 * the user's session is non-empty. The user's session may contain status
 * messages from a form submission, the contents of a shopping cart, or other
 * user-specific content that should not be cached and displayed to other users.
 */
class NoSessionOpen implements RequestPolicyInterface {
    
    /**
     * The session configuration.
     *
     * @var \Drupal\Core\Session\SessionConfigurationInterface
     */
    protected $sessionConfiguration;
    
    /**
     * Constructs a new page cache session policy.
     *
     * @param \Drupal\Core\Session\SessionConfigurationInterface $session_configuration
     *   The session configuration.
     */
    public function __construct(SessionConfigurationInterface $session_configuration) {
        $this->sessionConfiguration = $session_configuration;
    }
    
    /**
     * {@inheritdoc}
     */
    public function check(Request $request) {
        if (!$this->sessionConfiguration
            ->hasSession($request)) {
            return static::ALLOW;
        }
    }

}

Classes

Title Deprecated Summary
NoSessionOpen A policy allowing delivery of cached pages when there is no session open.

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