annotate core/lib/Drupal/Core/Session/WriteSafeSessionHandler.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents af1871eacc83
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Core\Session;
Chris@0 4
Chris@0 5 /**
Chris@18 6 * Wraps the session handler to prevent writes when not necessary or allowed.
Chris@0 7 */
Chris@0 8 class WriteSafeSessionHandler implements \SessionHandlerInterface, WriteSafeSessionHandlerInterface {
Chris@0 9
Chris@0 10 /**
Chris@0 11 * @var \SessionHandlerInterface
Chris@0 12 */
Chris@0 13 protected $wrappedSessionHandler;
Chris@0 14
Chris@0 15 /**
Chris@0 16 * Whether or not the session is enabled for writing.
Chris@0 17 *
Chris@0 18 * @var bool
Chris@0 19 */
Chris@0 20 protected $sessionWritable;
Chris@0 21
Chris@0 22 /**
Chris@18 23 * The read sessions.
Chris@18 24 *
Chris@18 25 * @var array
Chris@18 26 * Session data keyed by the session ID.
Chris@18 27 */
Chris@18 28 private $readSessions;
Chris@18 29
Chris@18 30 /**
Chris@0 31 * Constructs a new write safe session handler.
Chris@0 32 *
Chris@0 33 * @param \SessionHandlerInterface $wrapped_session_handler
Chris@0 34 * The underlying session handler.
Chris@0 35 * @param bool $session_writable
Chris@0 36 * Whether or not the session should be initially writable.
Chris@0 37 */
Chris@0 38 public function __construct(\SessionHandlerInterface $wrapped_session_handler, $session_writable = TRUE) {
Chris@0 39 $this->wrappedSessionHandler = $wrapped_session_handler;
Chris@0 40 $this->sessionWritable = $session_writable;
Chris@0 41 }
Chris@0 42
Chris@0 43 /**
Chris@0 44 * {@inheritdoc}
Chris@0 45 */
Chris@0 46 public function close() {
Chris@0 47 return $this->wrappedSessionHandler->close();
Chris@0 48 }
Chris@0 49
Chris@0 50 /**
Chris@0 51 * {@inheritdoc}
Chris@0 52 */
Chris@0 53 public function destroy($session_id) {
Chris@0 54 return $this->wrappedSessionHandler->destroy($session_id);
Chris@0 55 }
Chris@0 56
Chris@0 57 /**
Chris@0 58 * {@inheritdoc}
Chris@0 59 */
Chris@0 60 public function gc($max_lifetime) {
Chris@0 61 return $this->wrappedSessionHandler->gc($max_lifetime);
Chris@0 62 }
Chris@0 63
Chris@0 64 /**
Chris@0 65 * {@inheritdoc}
Chris@0 66 */
Chris@0 67 public function open($save_path, $session_id) {
Chris@0 68 return $this->wrappedSessionHandler->open($save_path, $session_id);
Chris@0 69 }
Chris@0 70
Chris@0 71 /**
Chris@0 72 * {@inheritdoc}
Chris@0 73 */
Chris@0 74 public function read($session_id) {
Chris@18 75 $value = $this->wrappedSessionHandler->read($session_id);
Chris@18 76 $this->readSessions[$session_id] = $value;
Chris@18 77 return $value;
Chris@0 78 }
Chris@0 79
Chris@0 80 /**
Chris@0 81 * {@inheritdoc}
Chris@0 82 */
Chris@0 83 public function write($session_id, $session_data) {
Chris@18 84 // Only write the session when it has been modified.
Chris@18 85 if (isset($this->readSessions[$session_id]) && $this->readSessions[$session_id] === $session_data) {
Chris@18 86 return TRUE;
Chris@18 87 }
Chris@0 88 if ($this->isSessionWritable()) {
Chris@0 89 return $this->wrappedSessionHandler->write($session_id, $session_data);
Chris@0 90 }
Chris@18 91 return TRUE;
Chris@0 92 }
Chris@0 93
Chris@0 94 /**
Chris@0 95 * {@inheritdoc}
Chris@0 96 */
Chris@0 97 public function setSessionWritable($flag) {
Chris@0 98 $this->sessionWritable = (bool) $flag;
Chris@0 99 }
Chris@0 100
Chris@0 101 /**
Chris@0 102 * {@inheritdoc}
Chris@0 103 */
Chris@0 104 public function isSessionWritable() {
Chris@0 105 return $this->sessionWritable;
Chris@0 106 }
Chris@0 107
Chris@0 108 }