vendor/symfony/http-foundation/Session/Session.php line 261

  1. use Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface;
  2. use Symfony\Component\HttpFoundation\Session\Storage\MetadataBag;
  3. use Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage;
  4. use Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface;
  6. // Help opcache.preload discover always-needed symbols
  7. class_exists(AttributeBag::class);
  8. class_exists(FlashBag::class);
  9. class_exists(SessionBagProxy::class);
  11. /**
  12. * @author Fabien Potencier <fabien@symfony.com>
  13. * @author Drak <drak@zikula.org>
  14. *
  15. * @implements \IteratorAggregate<string, mixed>
  16. */
  17. class Session implements FlashBagAwareSessionInterface, \IteratorAggregate, \Countable
  18. {
  19. protected $storage;
  21. private string $flashName;
  22. private string $attributeName;
  23. private array $data = [];
  24. private int $usageIndex = 0;
  25. private ?\Closure $usageReporter;
  27. public function __construct(?SessionStorageInterface $storage = null, ?AttributeBagInterface $attributes = null, ?FlashBagInterface $flashes = null, ?callable $usageReporter = null)
  28. {
  29. $this->storage = $storage ?? new NativeSessionStorage();
  30. $this->usageReporter = null === $usageReporter ? null : $usageReporter(...);
  32. $attributes ??= new AttributeBag();
  33. $this->attributeName = $attributes->getName();
  34. $this->registerBag($attributes);
  36. $flashes ??= new FlashBag();
  37. $this->flashName = $flashes->getName();
  38. $this->registerBag($flashes);
  39. }
  41. public function start(): bool
  42. {
  43. return $this->storage->start();
  44. }
  46. public function has(string $name): bool
  47. {
  48. return $this->getAttributeBag()->has($name);
  49. }
  51. public function get(string $name, mixed $default = null): mixed
  52. {
  53. return $this->getAttributeBag()->get($name, $default);
  54. }
  56. /**
  57. * @return void
  58. */
  59. public function set(string $name, mixed $value)
  60. {
  61. $this->getAttributeBag()->set($name, $value);
  62. }
  64. public function all(): array
  65. {
  66. return $this->getAttributeBag()->all();
  67. }
  69. /**
  70. * @return void
  71. */
  72. public function replace(array $attributes)
  73. {
  74. $this->getAttributeBag()->replace($attributes);
  75. }
  77. public function remove(string $name): mixed
  78. {
  79. return $this->getAttributeBag()->remove($name);
  80. }
  82. /**
  83. * @return void
  84. */
  85. public function clear()
  86. {
  87. $this->getAttributeBag()->clear();
  88. }
  90. public function isStarted(): bool
  91. {
  92. return $this->storage->isStarted();
  93. }
  95. /**
  96. * Returns an iterator for attributes.
  97. *
  98. * @return \ArrayIterator<string, mixed>
  99. */
  100. public function getIterator(): \ArrayIterator
  101. {
  102. return new \ArrayIterator($this->getAttributeBag()->all());
  103. }
  105. /**
  106. * Returns the number of attributes.
  107. */
  108. public function count(): int
  109. {
  110. return \count($this->getAttributeBag()->all());
  111. }
  113. public function &getUsageIndex(): int
  114. {
  115. return $this->usageIndex;
  116. }
  118. /**
  119. * @internal
  120. */
  121. public function isEmpty(): bool
  122. {
  123. if ($this->isStarted()) {
  124. ++$this->usageIndex;
  125. if ($this->usageReporter && 0 <= $this->usageIndex) {
  126. ($this->usageReporter)();
  127. }
  128. }
  129. foreach ($this->data as &$data) {
  130. if (!empty($data)) {
  131. return false;
  132. }
  133. }
  135. return true;
  136. }
  138. public function invalidate(?int $lifetime = null): bool
  139. {
  140. $this->storage->clear();
  142. return $this->migrate(true, $lifetime);
  143. }
  145. public function migrate(bool $destroy = false, ?int $lifetime = null): bool
  146. {
  147. return $this->storage->regenerate($destroy, $lifetime);
  148. }
  150. /**
  151. * @return void
  152. */
  153. public function save()
  154. {
  155. $this->storage->save();
  156. }
  158. public function getId(): string
  159. {
  160. return $this->storage->getId();
  161. }
  163. /**
  164. * @return void
  165. */
  166. public function setId(string $id)
  167. {
  168. if ($this->storage->getId() !== $id) {
  169. $this->storage->setId($id);
  170. }
  171. }
  173. public function getName(): string
  174. {
  175. return $this->storage->getName();
  176. }
  178. /**
  179. * @return void
  180. */
  181. public function setName(string $name)
  182. {
  183. $this->storage->setName($name);
  184. }
  186. public function getMetadataBag(): MetadataBag
  187. {
  188. ++$this->usageIndex;
  189. if ($this->usageReporter && 0 <= $this->usageIndex) {
  190. ($this->usageReporter)();
  191. }
  193. return $this->storage->getMetadataBag();
  194. }
  196. /**
  197. * @return void
  198. */
  199. public function registerBag(SessionBagInterface $bag)
  200. {
  201. $this->storage->registerBag(new SessionBagProxy($bag, $this->data, $this->usageIndex, $this->usageReporter));
  202. }
  204. public function getBag(string $name): SessionBagInterface
  205. {
  206. $bag = $this->storage->getBag($name);
  208. return method_exists($bag, 'getBag') ? $bag->getBag() : $bag;
  209. }
  211. /**
  212. * Gets the flashbag interface.
  213. */
  214. public function getFlashBag(): FlashBagInterface
  215. {
  216. return $this->getBag($this->flashName);
  217. }
  219. /**
  220. * Gets the attributebag interface.
  221. *
  222. * Note that this method was added to help with IDE autocompletion.
  223. */
  224. private function getAttributeBag(): AttributeBagInterface
  225. {
  226. return $this->getBag($this->attributeName);
  227. }
  228. }