<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\HttpFoundation\Session;
use Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag;
use Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface;
use Symfony\Component\HttpFoundation\Session\Flash\FlashBag;
use Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface;
use Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage;
use Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface;
/**
* @author Fabien Potencier <fabien@symfony.com>
* @author Drak <drak@zikula.org>
*/
class Session implements SessionInterface, \IteratorAggregate, \Countable {
protected $storage;
private $flashName;
private $attributeName;
private $data = [];
private $usageIndex = 0;
/**
* @param SessionStorageInterface $storage A SessionStorageInterface instance
* @param AttributeBagInterface $attributes An AttributeBagInterface instance, (defaults null for default AttributeBag)
* @param FlashBagInterface $flashes A FlashBagInterface instance (defaults null for default FlashBag)
*/
public function __construct(SessionStorageInterface $storage = null, AttributeBagInterface $attributes = null, FlashBagInterface $flashes = null) {
$this->storage = $storage ?: new NativeSessionStorage();
$attributes = $attributes ?: new AttributeBag();
$this->attributeName = $attributes->getName();
$this->registerBag($attributes);
$flashes = $flashes ?: new FlashBag();
$this->flashName = $flashes->getName();
$this->registerBag($flashes);
}
/**
* {@inheritdoc}
*/
public function start() {
return $this->storage->start();
}
/**
* {@inheritdoc}
*/
public function has($name) {
return $this->getAttributeBag()->has($name);
}
/**
* {@inheritdoc}
*/
public function get($name, $default = null) {
return $this->getAttributeBag()->get($name, $default);
}
/**
* {@inheritdoc}
*/
public function set($name, $value) {
$this->getAttributeBag()->set($name, $value);
}
/**
* {@inheritdoc}
*/
public function all() {
return $this->getAttributeBag()->all();
}
/**
* {@inheritdoc}
*/
public function replace(array $attributes) {
$this->getAttributeBag()->replace($attributes);
}
/**
* {@inheritdoc}
*/
public function remove($name) {
return $this->getAttributeBag()->remove($name);
}
/**
* {@inheritdoc}
*/
public function clear() {
$this->getAttributeBag()->clear();
}
/**
* {@inheritdoc}
*/
public function isStarted() {
return $this->storage->isStarted();
}
/**
* Returns an iterator for attributes.
*
* @return \ArrayIterator An \ArrayIterator instance
*/
public function getIterator() {
return new \ArrayIterator($this->getAttributeBag()->all());
}
/**
* Returns the number of attributes.
*
* @return int The number of attributes
*/
public function count() {
return \count($this->getAttributeBag()->all());
}
/**
* @return int
*
* @internal
*/
public function getUsageIndex() {
return $this->usageIndex;
}
/**
* @return bool
*
* @internal
*/
public function isEmpty() {
if ($this->isStarted()) {
++$this->usageIndex;
}
foreach ($this->data as &$data) {
if (!empty($data)) {
return false;
}
}
return true;
}
/**
* {@inheritdoc}
*/
public function invalidate($lifetime = null) {
$this->storage->clear();
return $this->migrate(true, $lifetime);
}
/**
* {@inheritdoc}
*/
public function migrate($destroy = false, $lifetime = null) {
return $this->storage->regenerate($destroy, $lifetime);
}
/**
* {@inheritdoc}
*/
public function save() {
$this->storage->save();
}
/**
* {@inheritdoc}
*/
public function getId() {
return $this->storage->getId();
}
/**
* {@inheritdoc}
*/
public function setId($id) {
if ($this->storage->getId() !== $id) {
$this->storage->setId($id);
}
}
/**
* {@inheritdoc}
*/
public function getName() {
return $this->storage->getName();
}
/**
* {@inheritdoc}
*/
public function setName($name) {
$this->storage->setName($name);
}
/**
* {@inheritdoc}
*/
public function getMetadataBag() {
++$this->usageIndex;
return $this->storage->getMetadataBag();
}
/**
* {@inheritdoc}
*/
public function registerBag(SessionBagInterface $bag) {
$this->storage->registerBag(new SessionBagProxy($bag, $this->data, $this->usageIndex));
}
/**
* {@inheritdoc}
*/
public function getBag($name) {
$bag = $this->storage->getBag($name);
return method_exists($bag, 'getBag') ? $bag->getBag() : $bag;
}
/**
* Gets the flashbag interface.
*
* @return FlashBagInterface
*/
public function getFlashBag() {
return $this->getBag($this->flashName);
}
/**
* Gets the attributebag interface.
*
* Note that this method was added to help with IDE autocompletion.
*
* @return AttributeBagInterface
*/
private function getAttributeBag() {
return $this->getBag($this->attributeName);
}
}