Overview

Namespaces

  • Composer
    • Autoload
  • Guzzle
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
        • Header
      • QueryAggregator
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Mock
    • Stream
  • Mockery
    • Adapter
      • Phpunit
    • CountValidator
    • Exception
    • Generator
      • StringManipulation
        • Pass
    • Loader
    • Matcher
  • None
  • Omnipay
    • Common
      • Exception
      • Message
    • Dummy
      • Message
    • Fatzebra
      • Message
  • PHP
  • Symfony
    • Component
      • EventDispatcher
        • Debug
        • DependencyInjection
        • Tests
          • Debug
          • DependencyInjection
      • HttpFoundation
        • File
          • Exception
          • MimeType
        • Session
          • Attribute
          • Flash
          • Storage
            • Handler
            • Proxy
        • Tests
          • File
            • MimeType
          • Session
            • Attribute
            • Flash
            • Storage
              • Handler
              • Proxy
      • Yaml
        • Exception
        • Tests

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 Session/Flash/AutoExpireFlashBag.php
Methods summary
public
# __construct( string $storageKey = '_sf2_flashes' )

Constructor.

Constructor.

Parameters

$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( $name )
public
# initialize( array & $flashes )

Initializes the Bag.

Initializes the Bag.

Parameters

$flashes
$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
$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
Message category type.
$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
$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.

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
$messages
$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

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()
Omnipay Fat Zebra / Paystream Gateway Module API Documentation API documentation generated by ApiGen