interface WriteSafeSessionHandlerInterface in Drupal 9

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

Hierarchy

• interface \Drupal\Core\Session\WriteSafeSessionHandlerInterface

File

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

Namespace

Drupal\Core\Session

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

Name	Modifiers	Type	Description	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