class PhpBridgeSessionStorage
Allows session to be started by PHP and managed by Symfony.
@author Drak <drak@zikula.org>
Hierarchy
- class \Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage implements \Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface
- class \Symfony\Component\HttpFoundation\Session\Storage\PhpBridgeSessionStorage extends \Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage
Expanded class hierarchy of PhpBridgeSessionStorage
File
-
vendor/
symfony/ http-foundation/ Session/ Storage/ PhpBridgeSessionStorage.php, line 21
Namespace
Symfony\Component\HttpFoundation\Session\StorageView source
class PhpBridgeSessionStorage extends NativeSessionStorage {
public function __construct(AbstractProxy|\SessionHandlerInterface|null $handler = null, ?MetadataBag $metaBag = null) {
if (!\extension_loaded('session')) {
throw new \LogicException('PHP extension "session" is required.');
}
$this->setMetadataBag($metaBag);
$this->setSaveHandler($handler);
}
public function start() : bool {
if ($this->started) {
return true;
}
$this->loadSession();
return true;
}
public function clear() : void {
// clear out the bags and nothing else that may be set
// since the purpose of this driver is to share a handler
foreach ($this->bags as $bag) {
$bag->clear();
}
// reconnect the bags to the session
$this->loadSession();
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
NativeSessionStorage::$bags | protected | property | |||
NativeSessionStorage::$closed | protected | property | |||
NativeSessionStorage::$metadataBag | protected | property | |||
NativeSessionStorage::$saveHandler | protected | property | |||
NativeSessionStorage::$started | protected | property | |||
NativeSessionStorage::getBag | public | function | Gets a SessionBagInterface by name. | Overrides SessionStorageInterface::getBag | |
NativeSessionStorage::getId | public | function | Returns the session ID. | Overrides SessionStorageInterface::getId | |
NativeSessionStorage::getMetadataBag | public | function | Gets the MetadataBag. | Overrides SessionStorageInterface::getMetadataBag | |
NativeSessionStorage::getName | public | function | Returns the session name. | Overrides SessionStorageInterface::getName | |
NativeSessionStorage::getSaveHandler | public | function | Gets the save handler instance. | ||
NativeSessionStorage::isStarted | public | function | Checks if the session is started. | Overrides SessionStorageInterface::isStarted | |
NativeSessionStorage::loadSession | protected | function | Load the session with attributes. | ||
NativeSessionStorage::regenerate | public | function | Regenerates id that represents this storage. | Overrides SessionStorageInterface::regenerate | 1 |
NativeSessionStorage::registerBag | public | function | Registers a SessionBagInterface for use. | Overrides SessionStorageInterface::registerBag | |
NativeSessionStorage::save | public | function | Force the session to be saved and closed. | Overrides SessionStorageInterface::save | 1 |
NativeSessionStorage::setId | public | function | Sets the session ID. | Overrides SessionStorageInterface::setId | |
NativeSessionStorage::setMetadataBag | public | function | |||
NativeSessionStorage::setName | public | function | Sets the session name. | Overrides SessionStorageInterface::setName | |
NativeSessionStorage::setOptions | public | function | Sets session.* ini variables. | ||
NativeSessionStorage::setSaveHandler | public | function | Registers session save handler as a PHP session handler. | ||
PhpBridgeSessionStorage::clear | public | function | Clear all session data in memory. | Overrides NativeSessionStorage::clear | |
PhpBridgeSessionStorage::start | public | function | Starts the session. | Overrides NativeSessionStorage::start | |
PhpBridgeSessionStorage::__construct | public | function | Depending on how you want the storage driver to behave you probably want to override this constructor entirely. |
Overrides NativeSessionStorage::__construct |