WriteSafeSessionHandlerInterface.php

Same filename in other branches
  1. 8.9.x core/lib/Drupal/Core/Session/WriteSafeSessionHandlerInterface.php
  2. 10 core/lib/Drupal/Core/Session/WriteSafeSessionHandlerInterface.php
  3. 11.x core/lib/Drupal/Core/Session/WriteSafeSessionHandlerInterface.php

Namespace

Drupal\Core\Session

File

core/lib/Drupal/Core/Session/WriteSafeSessionHandlerInterface.php

View source
<?php

namespace Drupal\Core\Session;


/**
 * Provides an interface for session handlers where writing can be disabled.
 */
interface WriteSafeSessionHandlerInterface {
    
    /**
     * Sets whether or not a session may be written to storage.
     *
     * It is not possible to enforce writing of the session data. This method is
     * only capable of forcibly disabling that session data is written to storage.
     *
     * @param bool $flag
     *   TRUE if the session is allowed to be written, FALSE otherwise.
     */
    public function setSessionWritable($flag);
    
    /**
     * Returns whether or not a session may be written to storage.
     *
     * @return bool
     *   TRUE if the session is allowed to be written, FALSE otherwise.
     */
    public function isSessionWritable();

}

Interfaces

Title Deprecated Summary
WriteSafeSessionHandlerInterface Provides an interface for session handlers where writing can be disabled.

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