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

  • AttributeBag
  • NamespacedAttributeBag

Interfaces

  • AttributeBagInterface
  • Overview
  • Namespace
  • Class
  • Tree

Class NamespacedAttributeBag

This class provides structured storage of session attributes using a name spacing character in the key.

Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag implements Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface, IteratorAggregate, Countable
Extended by Symfony\Component\HttpFoundation\Session\Attribute\NamespacedAttributeBag
Namespace: Symfony\Component\HttpFoundation\Session\Attribute
Author: Drak drak@zikula.org
Located at Session/Attribute/NamespacedAttributeBag.php
Methods summary
public
# __construct( string $storageKey = '_sf2_attributes', string $namespaceCharacter = '/' )

Constructor.

Constructor.

Parameters

$storageKey
Session storage key.
$namespaceCharacter
Namespace character to use in keys.

Overrides

Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag::__construct()
public boolean
# has( string $name )

Checks if an attribute is defined.

Checks if an attribute is defined.

Parameters

$name
The attribute name

Returns

boolean
true if the attribute is defined, false otherwise

Overrides

Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag::has()
public mixed
# get( string $name, mixed $default = null )

Returns an attribute.

Returns an attribute.

Parameters

$name
The attribute name
$default
The default value if not found

Returns

mixed

Overrides

Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag::get()
public
# set( string $name, mixed $value )

Sets an attribute.

Sets an attribute.

Parameters

$name
$value

Overrides

Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag::set()
public mixed
# remove( string $name )

Removes an attribute.

Removes an attribute.

Parameters

$name

Returns

mixed
The removed value or null when it does not exist

Overrides

Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag::remove()
protected array &
# resolveAttributePath( string $name, boolean $writeContext = false )

Resolves a path in attributes property and returns it as a reference.

Resolves a path in attributes property and returns it as a reference.

This method allows structured namespacing of session attributes.

Parameters

$name
Key name
$writeContext
Write context, default false

Returns

array
protected string
# resolveKey( string $name )

Resolves the key from the name.

Resolves the key from the name.

This is the last part in a dot separated string.

Parameters

$name

Returns

string
Methods inherited from Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag
all(), clear(), count(), getIterator(), getName(), getStorageKey(), initialize(), replace(), setName()
Properties inherited from Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag
$attributes
Omnipay Fat Zebra / Paystream Gateway Module API Documentation API documentation generated by ApiGen