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

Interface FlashBagInterface

FlashBagInterface.

Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface implements Symfony\Component\HttpFoundation\Session\SessionBagInterface

Direct known implementers

Symfony\Component\HttpFoundation\Session\Flash\AutoExpireFlashBag, Symfony\Component\HttpFoundation\Session\Flash\FlashBag
Namespace: Symfony\Component\HttpFoundation\Session\Flash
Author: Drak <drak@zikula.org>
Located at Flash/FlashBagInterface.php
Methods summary
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
public
# set( string $type, string|array $message )

Registers a message for a given type.

Registers a message for a given type.

Parameters

$type
string
$type
$message
string|array
$message
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
public array
# peekAll( )

Gets all flash messages.

Gets all flash messages.

Returns

array
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
public array
# all( )

Gets and clears flashes from the stack.

Gets and clears flashes from the stack.

Returns

array
public
# setAll( array $messages )

Sets all flash messages.

Sets all flash messages.

Parameters

$messages
array
$messages
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
public array
# keys( )

Returns a list of all defined types.

Returns a list of all defined types.

Returns

array
Methods inherited from Symfony\Component\HttpFoundation\Session\SessionBagInterface
clear(), getName(), getStorageKey(), initialize()
Ratchet API documentation generated by ApiGen 2.8.0