interface WriteSafeSessionHandlerInterface

Same name in other branches
  1. 9 core/lib/Drupal/Core/Session/WriteSafeSessionHandlerInterface.php \Drupal\Core\Session\WriteSafeSessionHandlerInterface
  2. 8.9.x core/lib/Drupal/Core/Session/WriteSafeSessionHandlerInterface.php \Drupal\Core\Session\WriteSafeSessionHandlerInterface
  3. 10 core/lib/Drupal/Core/Session/WriteSafeSessionHandlerInterface.php \Drupal\Core\Session\WriteSafeSessionHandlerInterface

Provides an interface for session handlers where writing can be disabled.

Hierarchy

Expanded class hierarchy of WriteSafeSessionHandlerInterface

All classes that implement WriteSafeSessionHandlerInterface

File

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

Namespace

Drupal\Core\Session
View source 
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();

}

Members

Title Modifiers Object type Summary Overrides
WriteSafeSessionHandlerInterface::isSessionWritable public function Returns whether or not a session may be written to storage. 1
WriteSafeSessionHandlerInterface::setSessionWritable public function Sets whether or not a session may be written to storage. 1

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