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

  1. private array $data = [];
  2. private int $usageIndex = 0;
  3. private ?\Closure $usageReporter;
  5. public function __construct(?SessionStorageInterface $storage = null, ?AttributeBagInterface $attributes = null, ?FlashBagInterface $flashes = null, ?callable $usageReporter = null)
  6. {
  7. $this->storage = $storage ?? new NativeSessionStorage();
  8. $this->usageReporter = null === $usageReporter ? null : $usageReporter(...);
  10. $attributes ??= new AttributeBag();
  11. $this->attributeName = $attributes->getName();
  12. $this->registerBag($attributes);
  14. $flashes ??= new FlashBag();
  15. $this->flashName = $flashes->getName();
  16. $this->registerBag($flashes);
  17. }
  19. public function start(): bool
  20. {
  21. return $this->storage->start();
  22. }
  24. public function has(string $name): bool
  25. {
  26. return $this->getAttributeBag()->has($name);
  27. }
  29. public function get(string $name, mixed $default = null): mixed
  30. {
  31. return $this->getAttributeBag()->get($name, $default);
  32. }
  34. /**
  35. * @return void
  36. */
  37. public function set(string $name, mixed $value)
  38. {
  39. $this->getAttributeBag()->set($name, $value);
  40. }
  42. public function all(): array
  43. {
  44. return $this->getAttributeBag()->all();
  45. }
  47. /**
  48. * @return void
  49. */
  50. public function replace(array $attributes)
  51. {
  52. $this->getAttributeBag()->replace($attributes);
  53. }
  55. public function remove(string $name): mixed
  56. {
  57. return $this->getAttributeBag()->remove($name);
  58. }
  60. /**
  61. * @return void
  62. */
  63. public function clear()
  64. {
  65. $this->getAttributeBag()->clear();
  66. }
  68. public function isStarted(): bool
  69. {
  70. return $this->storage->isStarted();
  71. }
  73. /**
  74. * Returns an iterator for attributes.
  75. *
  76. * @return \ArrayIterator<string, mixed>
  77. */
  78. public function getIterator(): \ArrayIterator
  79. {
  80. return new \ArrayIterator($this->getAttributeBag()->all());
  81. }
  83. /**
  84. * Returns the number of attributes.
  85. */
  86. public function count(): int
  87. {
  88. return \count($this->getAttributeBag()->all());
  89. }
  91. public function &getUsageIndex(): int
  92. {
  93. return $this->usageIndex;
  94. }
  96. /**
  97. * @internal
  98. */
  99. public function isEmpty(): bool
  100. {
  101. if ($this->isStarted()) {
  102. ++$this->usageIndex;
  103. if ($this->usageReporter && 0 <= $this->usageIndex) {
  104. ($this->usageReporter)();
  105. }
  106. }
  107. foreach ($this->data as &$data) {
  108. if (!empty($data)) {
  109. return false;
  110. }
  111. }
  113. return true;
  114. }
  116. public function invalidate(?int $lifetime = null): bool
  117. {
  118. $this->storage->clear();
  120. return $this->migrate(true, $lifetime);
  121. }
  123. public function migrate(bool $destroy = false, ?int $lifetime = null): bool
  124. {
  125. return $this->storage->regenerate($destroy, $lifetime);
  126. }
  128. /**
  129. * @return void
  130. */
  131. public function save()
  132. {
  133. $this->storage->save();
  134. }
  136. public function getId(): string
  137. {
  138. return $this->storage->getId();
  139. }
  141. /**
  142. * @return void
  143. */
  144. public function setId(string $id)
  145. {
  146. if ($this->storage->getId() !== $id) {
  147. $this->storage->setId($id);
  148. }
  149. }
  151. public function getName(): string
  152. {
  153. return $this->storage->getName();
  154. }
  156. /**
  157. * @return void
  158. */
  159. public function setName(string $name)
  160. {
  161. $this->storage->setName($name);
  162. }
  164. public function getMetadataBag(): MetadataBag
  165. {
  166. ++$this->usageIndex;
  167. if ($this->usageReporter && 0 <= $this->usageIndex) {
  168. ($this->usageReporter)();
  169. }
  171. return $this->storage->getMetadataBag();
  172. }
  174. /**
  175. * @return void
  176. */
  177. public function registerBag(SessionBagInterface $bag)
  178. {
  179. $this->storage->registerBag(new SessionBagProxy($bag, $this->data, $this->usageIndex, $this->usageReporter));
  180. }
  182. public function getBag(string $name): SessionBagInterface
  183. {
  184. $bag = $this->storage->getBag($name);
  186. return method_exists($bag, 'getBag') ? $bag->getBag() : $bag;
  187. }
  189. /**
  190. * Gets the flashbag interface.
  191. */
  192. public function getFlashBag(): FlashBagInterface
  193. {
  194. return $this->getBag($this->flashName);
  195. }
  197. /**
  198. * Gets the attributebag interface.
  199. *
  200. * Note that this method was added to help with IDE autocompletion.
  201. */
  202. private function getAttributeBag(): AttributeBagInterface
  203. {
  204. return $this->getBag($this->attributeName);
  205. }
  206. }