Интерфейс AttributeBagInterface
интерфейс AttributeBagInterface реализует SessionBagInterface
Хранилище атрибутов.
Методы
| string | getName() Возвращает имя этого хранилища. | из SessionBagInterface |
| initialize(array $array) Инициализирует хранилище. | из SessionBagInterface | |
| string | getStorageKey() Возвращает ключ хранения для этого хранилища. | из SessionBagInterface |
| mixed | clear() Очищает данные из хранилища. | из SessionBagInterface |
| bool | has(string $name) Проверяет, определён ли атрибут. | |
| mixed | get(string $name, mixed $default = null) Возвращает атрибут. | |
| set(string $name, mixed $value) Устанавливает атрибут. | ||
| array | all() Возвращает атрибуты. | |
| replace(array $attributes) Устанавливает атрибуты. | ||
| mixed | remove(string $name) Удаляет атрибут. |
Подробности
string getName()
Возвращает имя этого хранилища.
Возвращаемое значение
| string |
initialize(array $array)
Инициализирует хранилище.
Параметры
| array | $array |
string getStorageKey()
Возвращает ключ хранения для этого хранилища.
Возвращаемое значение
| string |
mixed clear()
Очищает данные из хранилища.
Возвращаемое значение
| mixed | Содержимое хранилища |
bool has(string $name)
Проверяет, определён ли атрибут.
Параметры
| string | $name | Имя атрибута |
Возвращаемое значение
| bool | true, если атрибут определён, иначе false |
mixed get(string $name, mixed $default = null)
Возвращает атрибут.
Параметры
| string | $name | Имя атрибута |
| mixed | $default | Значение по умолчанию, если не найдено |
Возвращаемое значение
| mixed |
set(string $name, mixed $value)
Устанавливает атрибут.
Параметры
| string | $name | |
| mixed | $value |
array all()
Возвращает атрибуты.
Возвращаемое значение
| array | Атрибуты |
replace(array $attributes)
Устанавливает атрибуты.
Параметры
| array | $attributes | Атрибуты |
mixed remove(string $name)
Удаляет атрибут.
Параметры
| string | $name |
Возвращаемое значение
| mixed | Удаленное значение или null, если оно не существует |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/HttpFoundation/Session/Attribute/AttributeBagInterface.html