1. interface
  2. Symfony
  3. \
  4. Component
  5. \
  6. HttpFoundation
  7. \
  8. Session
  9. \
  10. Attribute
  11. \
  12. AttributeBagInterface

AttributeBagInterface

interface AttributeBagInterface implementsSessionBagInterface

Attributes store.

Methods

string
getName()

Gets this bag's name.

from SessionBagInterface
void
initialize(array$array)

Initializes the Bag.

from SessionBagInterface
string
getStorageKey()

Gets the storage key for this bag.

from SessionBagInterface
mixed
clear()

Clears out data from bag.

from SessionBagInterface
bool
has(string$name)

Checks if an attribute is defined.

mixed
get(string$name,mixed$default =null)

Returns an attribute.

void
set(string$name,mixed$value)

Sets an attribute.

array
all()

Returns attributes.

void
replace(array$attributes)

No description

mixed
remove(string$name)

Removes an attribute.

Details

string getName()

Gets this bag's name.

Return Value

string

void initialize(array$array)

Initializes the Bag.

Parameters

array $array

Return Value

void

string getStorageKey()

Gets the storage key for this bag.

Return Value

string

mixed clear()

Clears out data from bag.

Return Value

mixed Whatever data was contained

bool has(string$name)

Checks if an attribute is defined.

Parameters

string $name

Return Value

bool

mixed get(string$name,mixed$default =null)

Returns an attribute.

Parameters

string $name
mixed $default

Return Value

mixed

void set(string$name,mixed$value)

Sets an attribute.

Parameters

string $name
mixed $value

Return Value

void

array all()

Returns attributes.

Return Value

array mixed>

void replace(array$attributes)

Parameters

array $attributes

Return Value

void

mixed remove(string$name)

Removes an attribute.

Parameters

string $name

Return Value

mixed The removed value or null when it does not exist