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

  • MetadataBag
  • MockArraySessionStorage
  • MockFileSessionStorage
  • NativeSessionStorage
  • PhpBridgeSessionStorage

Interfaces

  • SessionStorageInterface
  • Overview
  • Namespace
  • Class
  • Tree

Class MetadataBag

Metadata container.

Adds metadata to the session.

Symfony\Component\HttpFoundation\Session\Storage\MetadataBag implements Symfony\Component\HttpFoundation\Session\SessionBagInterface
Namespace: Symfony\Component\HttpFoundation\Session\Storage
Author: Drak <drak@zikula.org>
Located at Storage/MetadataBag.php
Methods summary
public
# __construct( string $storageKey = '_sf2_meta', integer $updateThreshold = 0 )

Constructor.

Constructor.

Parameters

$storageKey
string
$storageKey The key used to store bag in the session
$updateThreshold
integer
$updateThreshold The time to wait between two UPDATED updates
public
# initialize( array & $array )

Initializes the Bag.

Initializes the Bag.

Parameters

$array
array
$array

Implementation of

Symfony\Component\HttpFoundation\Session\SessionBagInterface::initialize()
public integer
# getLifetime( )

Gets the lifetime that the session cookie was set with.

Gets the lifetime that the session cookie was set with.

Returns

integer
public
# stampNew( integer $lifetime = null )

Stamps a new session's metadata.

Stamps a new session's metadata.

Parameters

$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.
public string
# getStorageKey( )

Gets the storage key for this bag.

Gets the storage key for this bag.

Returns

string

Implementation of

Symfony\Component\HttpFoundation\Session\SessionBagInterface::getStorageKey()
public integer
# getCreated( )

Gets the created timestamp metadata.

Gets the created timestamp metadata.

Returns

integer
Unix timestamp
public integer
# getLastUsed( )

Gets the last used metadata.

Gets the last used metadata.

Returns

integer
Unix timestamp
public mixed
# clear( )

Clears out data from bag.

Clears out data from bag.

Returns

mixed
Whatever data was contained

Implementation of

Symfony\Component\HttpFoundation\Session\SessionBagInterface::clear()
public string
# getName( )

Gets this bag's name.

Gets this bag's name.

Returns

string

Implementation of

Symfony\Component\HttpFoundation\Session\SessionBagInterface::getName()
public
# setName( string $name )

Sets name.

Sets name.

Parameters

$name
string
$name
Constants summary
string CREATED 'c'
#
string UPDATED 'u'
#
string LIFETIME 'l'
#
Properties summary
protected array $meta array(self::CREATED => 0, self::UPDATED => 0, self::LIFETIME => 0)
#
Ratchet API documentation generated by ApiGen 2.8.0