Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface Interface Reference

Inheritance diagram for Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface:

Public Member Functions
	all ()
	all ()
	get ($name, $default=null)
	get ($name, $default=null)
	has ($name)
	has ($name)
	remove ($name)
	remove ($name)
	replace (array $attributes)
	replace (array $attributes)
	set ($name, $value)
	set ($name, $value)
Public Member Functions inherited from Symfony\Component\HttpFoundation\Session\SessionBagInterface
	clear ()
	clear ()
	getName ()
	getName ()
	getStorageKey ()
	getStorageKey ()
	initialize (array &$array)
	initialize (array &$array)

Detailed Description

Attributes store.

Author

Drak drak@.nosp@m.ziku.nosp@m.la.or.nosp@m.g

Definition at line 21 of file lib/vendor/symfony/http-foundation/Session/Attribute/AttributeBagInterface.php.

Member Function Documentation

all() [1/2]

Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface::all

(

)

Returns attributes.

Returns

array Attributes

Implemented in Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag, and Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag.

all() [2/2]

Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface::all

(

)

Returns attributes.

Returns

array

Implemented in Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag, and Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag.

get() [1/2]

Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface::get	(		$name,
			$default = null
	)

Returns an attribute.

Parameters

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

Returns

mixed

Implemented in Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag, Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag, Symfony\Component\HttpFoundation\Session\Attribute\NamespacedAttributeBag, and Symfony\Component\HttpFoundation\Session\Attribute\NamespacedAttributeBag.

get() [2/2]

Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface::get	(		$name,
			$default = null
	)

Returns an attribute.

Parameters

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

Returns

mixed

Implemented in Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag, Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag, Symfony\Component\HttpFoundation\Session\Attribute\NamespacedAttributeBag, and Symfony\Component\HttpFoundation\Session\Attribute\NamespacedAttributeBag.

has() [1/2]

Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface::has

(

$name

)

Checks if an attribute is defined.

Parameters

string

$name

The attribute name

Returns

bool true if the attribute is defined, false otherwise

Implemented in Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag, Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag, Symfony\Component\HttpFoundation\Session\Attribute\NamespacedAttributeBag, and Symfony\Component\HttpFoundation\Session\Attribute\NamespacedAttributeBag.

has() [2/2]

Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface::has

(

$name

)

Checks if an attribute is defined.

Parameters

string

$name

The attribute name

Returns

bool true if the attribute is defined, false otherwise

Implemented in Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag, Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag, Symfony\Component\HttpFoundation\Session\Attribute\NamespacedAttributeBag, and Symfony\Component\HttpFoundation\Session\Attribute\NamespacedAttributeBag.

remove() [1/2]

Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface::remove

(

$name

)

Removes an attribute.

Parameters

string

$name

Returns

mixed The removed value or null when it does not exist

Implemented in Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag, Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag, Symfony\Component\HttpFoundation\Session\Attribute\NamespacedAttributeBag, and Symfony\Component\HttpFoundation\Session\Attribute\NamespacedAttributeBag.

remove() [2/2]

Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface::remove

(

$name

)

Removes an attribute.

Parameters

string

$name

Returns

mixed The removed value or null when it does not exist

Implemented in Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag, Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag, Symfony\Component\HttpFoundation\Session\Attribute\NamespacedAttributeBag, and Symfony\Component\HttpFoundation\Session\Attribute\NamespacedAttributeBag.

replace() [1/2]

Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface::replace

(

array

$attributes

)

Implemented in Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag, and Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag.

replace() [2/2]

Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface::replace

(

array

$attributes

)

Sets attributes.

Parameters

array

$attributes

Attributes

Implemented in Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag, and Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag.

set() [1/2]

Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface::set	(		$name,
			$value
	)

Sets an attribute.

Parameters

string	$name
mixed	$value

Implemented in Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag, Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag, Symfony\Component\HttpFoundation\Session\Attribute\NamespacedAttributeBag, and Symfony\Component\HttpFoundation\Session\Attribute\NamespacedAttributeBag.

set() [2/2]

Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface::set	(		$name,
			$value
	)

Sets an attribute.

Parameters

string	$name
mixed	$value

Implemented in Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag, Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag, Symfony\Component\HttpFoundation\Session\Attribute\NamespacedAttributeBag, and Symfony\Component\HttpFoundation\Session\Attribute\NamespacedAttributeBag.

---

The documentation for this interface was generated from the following file:

• lib/vendor/symfony/http-foundation/Session/Attribute/AttributeBagInterface.php