class WriteSafeSessionHandler in Drupal 9

Wraps the session handler to prevent writes when not necessary or allowed.

Hierarchy

• class \Drupal\Core\Session\WriteSafeSessionHandler implements \Drupal\Core\Session\SessionHandlerInterface, WriteSafeSessionHandlerInterface

1 file declares its use of WriteSafeSessionHandler

WriteSafeSessionHandlerTest.php in core/tests/Drupal/Tests/Core/Session/WriteSafeSessionHandlerTest.php

1 string reference to 'WriteSafeSessionHandler'

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

core/core.services.yml

1 service uses WriteSafeSessionHandler

session_handler.write_safe in core/core.services.yml

Drupal\Core\Session\WriteSafeSessionHandler

File

core/lib/Drupal/Core/Session/WriteSafeSessionHandler.php, line 8

Namespace

Drupal\Core\Session

class WriteSafeSessionHandler implements \SessionHandlerInterface, WriteSafeSessionHandlerInterface {

  /**
   * @var \SessionHandlerInterface
   */
  protected $wrappedSessionHandler;

  /**
   * Whether or not the session is enabled for writing.
   *
   * @var bool
   */
  protected $sessionWritable;

  /**
   * The read sessions.
   *
   * @var array
   *   Session data keyed by the session ID.
   */
  private $readSessions;

  /**
   * Constructs a new write safe session handler.
   *
   * @param \SessionHandlerInterface $wrapped_session_handler
   *   The underlying session handler.
   * @param bool $session_writable
   *   Whether or not the session should be initially writable.
   */
  public function __construct(\SessionHandlerInterface $wrapped_session_handler, $session_writable = TRUE) {
    $this->wrappedSessionHandler = $wrapped_session_handler;
    $this->sessionWritable = $session_writable;
  }

  /**
   * {@inheritdoc}
   */
  public function close() {
    return $this->wrappedSessionHandler
      ->close();
  }

  /**
   * {@inheritdoc}
   */
  public function destroy($session_id) {
    return $this->wrappedSessionHandler
      ->destroy($session_id);
  }

  /**
   * {@inheritdoc}
   */
  public function gc($max_lifetime) {
    return $this->wrappedSessionHandler
      ->gc($max_lifetime);
  }

  /**
   * {@inheritdoc}
   */
  public function open($save_path, $session_id) {
    return $this->wrappedSessionHandler
      ->open($save_path, $session_id);
  }

  /**
   * {@inheritdoc}
   */
  public function read($session_id) {
    $value = $this->wrappedSessionHandler
      ->read($session_id);
    $this->readSessions[$session_id] = $value;
    return $value;
  }

  /**
   * {@inheritdoc}
   */
  public function write($session_id, $session_data) {

    // Only write the session when it has been modified.
    if (isset($this->readSessions[$session_id]) && $this->readSessions[$session_id] === $session_data) {
      return TRUE;
    }
    if ($this
      ->isSessionWritable()) {
      return $this->wrappedSessionHandler
        ->write($session_id, $session_data);
    }
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function setSessionWritable($flag) {
    $this->sessionWritable = (bool) $flag;
  }

  /**
   * {@inheritdoc}
   */
  public function isSessionWritable() {
    return $this->sessionWritable;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
WriteSafeSessionHandler::$readSessions	private	property	The read sessions.
WriteSafeSessionHandler::$sessionWritable	protected	property	Whether or not the session is enabled for writing.
WriteSafeSessionHandler::$wrappedSessionHandler	protected	property
WriteSafeSessionHandler::close	public	function
WriteSafeSessionHandler::destroy	public	function
WriteSafeSessionHandler::gc	public	function
WriteSafeSessionHandler::isSessionWritable	public	function	Returns whether or not a session may be written to storage. Overrides WriteSafeSessionHandlerInterface::isSessionWritable
WriteSafeSessionHandler::open	public	function
WriteSafeSessionHandler::read	public	function
WriteSafeSessionHandler::setSessionWritable	public	function	Sets whether or not a session may be written to storage. Overrides WriteSafeSessionHandlerInterface::setSessionWritable
WriteSafeSessionHandler::write	public	function
WriteSafeSessionHandler::__construct	public	function	Constructs a new write safe session handler.