Overview

Namespaces

  • Evenement
  • None
  • PHP
  • Psr
    • Http
      • Message
  • Ratchet
    • Http
    • RFC6455
      • Handshake
      • Messaging
    • Server
    • Session
      • Serialize
      • Storage
        • Proxy
    • Wamp
    • WebSocket
  • React
    • EventLoop
      • Tick
      • Timer
    • Socket
    • Stream
  • Symfony
    • Component
      • HttpFoundation
        • Session
          • Attribute
          • Flash
          • Storage
            • Handler
            • Proxy
      • Routing
        • Annotation
        • Exception
        • Generator
          • Dumper
        • Loader
          • DependencyInjection
        • Matcher
          • Dumper
        • Tests
          • Annotation
          • Fixtures
            • AnnotatedClasses
            • OtherAnnotatedClasses
          • Generator
            • Dumper
          • Loader
          • Matcher
            • Dumper

Classes

  • VirtualSessionStorage
  • Overview
  • Namespace
  • Class
  • Tree

Class VirtualSessionStorage

This provides a base class for session attribute storage.

Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage implements Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface
Extended by Ratchet\Session\Storage\VirtualSessionStorage
Namespace: Ratchet\Session\Storage
Author: Drak <drak@zikula.org>
Located at Ratchet/Session/Storage/VirtualSessionStorage.php
Methods summary
public
# __construct( SessionHandlerInterface $handler, string $sessionId, Ratchet\Session\Serialize\HandlerInterface $serializer )

Parameters

$handler
SessionHandlerInterface
$handler
$sessionId
string
$sessionId The ID of the session to retrieve
$serializer
Ratchet\Session\Serialize\HandlerInterface
$serializer

Overrides

Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage::__construct()
public boolean
# start( )

Starts the session.

Starts the session.

Returns

boolean
True if started

Throws

RuntimeException
If something goes wrong starting the session.

Overrides

Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage::start()
public boolean
# regenerate( boolean $destroy = false, integer $lifetime = null )

Regenerates id that represents this storage.

Regenerates id that represents this storage.

Parameters

$destroy
boolean
$destroy Destroy session when regenerating?
$lifetime
integer
$lifetime Sets the cookie lifetime for the session cookie. A null value will leave the system settings unchanged, 0 sets the cookie to expire with browser session. Time is in seconds, and is not a Unix timestamp.

Returns

boolean
True if session regenerated, false if error

Throws

RuntimeException
If an error occurs while regenerating this storage

Overrides

Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage::regenerate()
public
# save( )

Force the session to be saved and closed.

Force the session to be saved and closed.

Throws

RuntimeException
If the session is saved without being started, or if the session is already closed.

Overrides

Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage::save()
public
# setSaveHandler( AbstractProxy|NativeSessionHandler|SessionHandlerInterface|null $saveHandler = null )

Registers session save handler as a PHP session handler.

Registers session save handler as a PHP session handler.

Parameters

$saveHandler
AbstractProxy|NativeSessionHandler|SessionHandlerInterface|null
$saveHandler

Throws

InvalidArgumentException

Overrides

Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage::setSaveHandler()
Methods inherited from Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage
clear(), getBag(), getId(), getMetadataBag(), getName(), getSaveHandler(), isStarted(), loadSession(), registerBag(), setId(), setMetadataBag(), setName(), setOptions()
Properties summary
protected Ratchet\Session\Serialize\HandlerInterface $_serializer
#
Properties inherited from Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage
$bags, $closed, $metadataBag, $saveHandler, $started
Ratchet API documentation generated by ApiGen 2.8.0