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

  • AutoExpireFlashBag
  • FlashBag

Interfaces

  • FlashBagInterface
  • Overview
  • Namespace
  • Class
  • Tree

Class AutoExpireFlashBag

AutoExpireFlashBag flash message container.

Symfony\Component\HttpFoundation\Session\Flash\AutoExpireFlashBag implements Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface
Namespace: Symfony\Component\HttpFoundation\Session\Flash
Author: Drak <drak@zikula.org>
Located at Flash/AutoExpireFlashBag.php
Methods summary
public
# __construct( string $storageKey = '_sf2_flashes' )

Constructor.

Constructor.

Parameters

$storageKey
string
$storageKey The key used to store flashes in the session
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( mixed $name )
public
# initialize( array & $flashes )

Initializes the Bag.

Initializes the Bag.

Parameters

$flashes
array
$array

Implementation of

Symfony\Component\HttpFoundation\Session\SessionBagInterface::initialize()
public
# add( string $type, string $message )

Adds a flash message for type.

Adds a flash message for type.

Parameters

$type
string
$type
$message
string
$message

Implementation of

Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface::add()
public array
# peek( string $type, array $default = array() )

Gets flash messages for a given type.

Gets flash messages for a given type.

Parameters

$type
string
$type Message category type
$default
array
$default Default value if $type does not exist

Returns

array

Implementation of

Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface::peek()
public array
# peekAll( )

Gets all flash messages.

Gets all flash messages.

Returns

array

Implementation of

Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface::peekAll()
public array
# get( string $type, array $default = array() )

Gets and clears flash from the stack.

Gets and clears flash from the stack.

Parameters

$type
string
$type
$default
array
$default Default value if $type does not exist

Returns

array

Implementation of

Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface::get()
public array
# all( )

Gets and clears flashes from the stack.

Gets and clears flashes from the stack.

Returns

array

Implementation of

Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface::all()
public
# setAll( array $messages )

Sets all flash messages.

Sets all flash messages.

Parameters

$messages
array
$messages

Implementation of

Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface::setAll()
public
# set( string $type, string|array $messages )

Registers a message for a given type.

Registers a message for a given type.

Parameters

$type
string
$type
$messages
string|array
$message

Implementation of

Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface::set()
public boolean
# has( string $type )

Has flash messages for a given type?

Has flash messages for a given type?

Parameters

$type
string
$type

Returns

boolean

Implementation of

Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface::has()
public array
# keys( )

Returns a list of all defined types.

Returns a list of all defined types.

Returns

array

Implementation of

Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface::keys()
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 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()
Ratchet API documentation generated by ApiGen 2.8.0