NamespacedAttributeBag
class NamespacedAttributeBag extends AttributeBag
Этот класс предоставляет структурированное хранилище атрибутов сеанса с использованием символа именования в ключе.
Методы
| __construct(string $storageKey = '_sf2_attributes', string $namespaceCharacter = '/') | ||
| string | getName() Получает имя этого пакета. | из AttributeBag |
| setName($name) | из AttributeBag | |
| initialize(array $attributes) Инициализирует пакет. | из AttributeBag | |
| string | getStorageKey() Получает ключ хранения для этого пакета. | из AttributeBag |
| bool | has(string $name) Проверяет, определен ли атрибут. | |
| mixed | get(string $name, mixed $default = null) Возвращает атрибут. | |
| set(string $name, mixed $value) Устанавливает атрибут. | ||
| array | all() Возвращает атрибуты. | из AttributeBag |
| replace(array $attributes) Устанавливает атрибуты. | из AttributeBag | |
| mixed | remove(string $name) Удаляет атрибут. | |
| mixed | clear() Очищает данные из пакета. | из AttributeBag |
| ArrayIterator | getIterator() Возвращает итератор для атрибутов. | из AttributeBag |
| int | count() Возвращает количество атрибутов. | из AttributeBag |
Подробности
__construct(string $storageKey = '_sf2_attributes', string $namespaceCharacter = '/')
Параметры
| string | $storageKey | Ключ, используемый для хранения атрибутов в сеансе |
| string | $namespaceCharacter | Символ именования, используемый в ключах |
string getName()
Получает имя этого пакета.
Значение возврата
| string |
setName($name)
Параметры
| $name |
initialize(array $attributes)
Инициализирует пакет.
Параметры
| array | $attributes |
string getStorageKey()
Получает ключ хранения для этого пакета.
Значение возврата
| string |
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, если его не существует |
mixed clear()
Очищает данные из пакета.
Значение возврата
| mixed | Любые содержавшиеся данные |
ArrayIterator getIterator()
Возвращает итератор для атрибутов.
Значение возврата
| ArrayIterator | Объект \ArrayIterator |
int count()
Возвращает количество атрибутов.
Значение возврата
| int | Количество атрибутов |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.4/Symfony/Component/HttpFoundation/Session/Attribute/NamespacedAttributeBag.html