Session.
@author Fabien Potencier <fabien@symfony.com> @author Drak <drak@zikula.org>
@api
Expanded class hierarchy of Session
class Session implements SessionInterface, \IteratorAggregate, \Countable {
/**
* Storage driver.
*
* @var SessionStorageInterface
*/
protected $storage;
/**
* @var string
*/
private $flashName;
/**
* @var string
*/
private $attributeName;
/**
* Constructor.
*
* @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->storage
->getBag($this->attributeName)
->has($name);
}
/**
* {@inheritdoc}
*/
public function get($name, $default = null) {
return $this->storage
->getBag($this->attributeName)
->get($name, $default);
}
/**
* {@inheritdoc}
*/
public function set($name, $value) {
$this->storage
->getBag($this->attributeName)
->set($name, $value);
}
/**
* {@inheritdoc}
*/
public function all() {
return $this->storage
->getBag($this->attributeName)
->all();
}
/**
* {@inheritdoc}
*/
public function replace(array $attributes) {
$this->storage
->getBag($this->attributeName)
->replace($attributes);
}
/**
* {@inheritdoc}
*/
public function remove($name) {
return $this->storage
->getBag($this->attributeName)
->remove($name);
}
/**
* {@inheritdoc}
*/
public function clear() {
$this->storage
->getBag($this->attributeName)
->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->storage
->getBag($this->attributeName)
->all());
}
/**
* Returns the number of attributes.
*
* @return int The number of attributes
*/
public function count() {
return count($this->storage
->getBag($this->attributeName)
->all());
}
/**
* {@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) {
$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() {
return $this->storage
->getMetadataBag();
}
/**
* {@inheritdoc}
*/
public function registerBag(SessionBagInterface $bag) {
$this->storage
->registerBag($bag);
}
/**
* {@inheritdoc}
*/
public function getBag($name) {
return $this->storage
->getBag($name);
}
/**
* Gets the flashbag interface.
*
* @return FlashBagInterface
*/
public function getFlashBag() {
return $this
->getBag($this->flashName);
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Session:: |
private | property | ||
Session:: |
private | property | ||
Session:: |
protected | property | Storage driver. | |
Session:: |
public | function |
Returns attributes. Overrides SessionInterface:: |
|
Session:: |
public | function |
Clears all attributes. Overrides SessionInterface:: |
|
Session:: |
public | function | Returns the number of attributes. | |
Session:: |
public | function |
Returns an attribute. Overrides SessionInterface:: |
|
Session:: |
public | function |
Gets a bag instance by name. Overrides SessionInterface:: |
|
Session:: |
public | function | Gets the flashbag interface. | |
Session:: |
public | function |
Returns the session ID. Overrides SessionInterface:: |
|
Session:: |
public | function | Returns an iterator for attributes. | |
Session:: |
public | function |
Gets session meta. Overrides SessionInterface:: |
|
Session:: |
public | function |
Returns the session name. Overrides SessionInterface:: |
|
Session:: |
public | function |
Checks if an attribute is defined. Overrides SessionInterface:: |
|
Session:: |
public | function |
Invalidates the current session. Overrides SessionInterface:: |
|
Session:: |
public | function |
Checks if the session was started. Overrides SessionInterface:: |
|
Session:: |
public | function |
Migrates the current session to a new session id while maintaining all
session attributes. Overrides SessionInterface:: |
|
Session:: |
public | function |
Registers a SessionBagInterface with the session. Overrides SessionInterface:: |
|
Session:: |
public | function |
Removes an attribute. Overrides SessionInterface:: |
|
Session:: |
public | function |
Sets attributes. Overrides SessionInterface:: |
|
Session:: |
public | function |
Force the session to be saved and closed. Overrides SessionInterface:: |
|
Session:: |
public | function |
Sets an attribute. Overrides SessionInterface:: |
|
Session:: |
public | function |
Sets the session ID Overrides SessionInterface:: |
|
Session:: |
public | function |
Sets the session name. Overrides SessionInterface:: |
|
Session:: |
public | function |
Starts the session storage. Overrides SessionInterface:: |
|
Session:: |
public | function | Constructor. |