annotate core/lib/Drupal/Core/Session/WriteSafeSessionHandlerInterface.php @ 0:4c8ae668cc8c

Initial import (non-working)
author Chris Cannam
date Wed, 29 Nov 2017 16:09:58 +0000
parents
children 129ea1e6d783
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Core\Session;
Chris@0 4
Chris@0 5 /**
Chris@0 6 * Provides an interface for session handlers where writing can be disabled.
Chris@0 7 */
Chris@0 8 interface WriteSafeSessionHandlerInterface {
Chris@0 9
Chris@0 10 /**
Chris@0 11 * Sets whether or not a session may be written to storage.
Chris@0 12 *
Chris@0 13 * It is not possible to enforce writing of the session data. This method is
Chris@0 14 * only capable of forcibly disabling that session data is written to storage.
Chris@0 15 *
Chris@0 16 * @param bool $flag
Chris@0 17 * TRUE if the session the session is allowed to be written, FALSE
Chris@0 18 * otherwise.
Chris@0 19 */
Chris@0 20 public function setSessionWritable($flag);
Chris@0 21
Chris@0 22 /**
Chris@0 23 * Returns whether or not a session may be written to storage.
Chris@0 24 *
Chris@0 25 * @return bool
Chris@0 26 * TRUE if the session the session is allowed to be written, FALSE
Chris@0 27 * otherwise.
Chris@0 28 */
Chris@0 29 public function isSessionWritable();
Chris@0 30
Chris@0 31 }