NamespacedAttributeBag
class NamespacedAttributeBag extends AttributeBag
Этот класс предоставляет структурированное хранилище атрибутов сессии, используя символ разделителя для именования.
Свойства
| protected | $attributes | из 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 |
| array | resolveAttributePath(string $name, bool $writeContext = false) Разрешает путь в свойстве attributes и возвращает его по ссылке. | |
| string | resolveKey(string $name) Разрешает ключ из имени. |
Подробности
__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 | Количество атрибутов |
protected array resolveAttributePath(string $name, bool $writeContext = false)
Разрешает путь в свойстве attributes и возвращает его по ссылке.
Этот метод позволяет использовать структурированное именование атрибутов сессии.
Параметры
| string | $name | Имя ключа |
| bool | $writeContext | Контекст записи, по умолчанию false |
Возвращаемое значение
| array |
protected string resolveKey(string $name)
Разрешает ключ из имени.
Это последняя часть строки, разделенной точками.
Параметры
| string | $name |
Возвращаемое значение
| string |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/HttpFoundation/Session/Attribute/NamespacedAttributeBag.html