ParameterBag
class ParameterBag implements IteratorAggregate, Countable
ParameterBag — контейнер для пар ключ/значение.
Методы
| __construct(array $parameters = array()) | ||
| массив | all() Возвращает параметры. | |
| массив | keys() Возвращает ключи параметров. | |
| replace(array $parameters = array()) Заменяет текущие параметры новым набором. | ||
| add(array $parameters = array()) Добавляет параметры. | ||
| смешанный тип | get(string $key, mixed $default = null, bool $deep = false) Возвращает параметр по имени. | |
| set(string $key, mixed $value) Устанавливает параметр по имени. | ||
| bool | has(string $key) Возвращает true, если параметр определён. | |
| remove(string $key) Удаляет параметр. | ||
| строка | getAlpha(string $key, string $default = '', bool $deep = false) Возвращает буквенные символы значения параметра. | |
| строка | getAlnum(string $key, string $default = '', bool $deep = false) Возвращает буквенные символы и цифры значения параметра. | |
| строка | getDigits(string $key, string $default = '', bool $deep = false) Возвращает цифры значения параметра. | |
| целое число | getInt(string $key, int $default, bool $deep = false) Возвращает значение параметра, преобразованное в целое число. | |
| bool | getBoolean(string $key, mixed $default = false, bool $deep = false) Возвращает значение параметра, преобразованное в булево значение. | |
| смешанный тип | filter(string $key, mixed $default = null, int $filter = FILTER_DEFAULT, mixed $options = array(), bool $deep = false) Фильтр ключа. | |
| ArrayIterator | getIterator() Возвращает итератор для параметров. | |
| целое число | count() Возвращает количество параметров. |
Подробности
__construct(array $parameters = array())
Параметры
| массив | $parameters | Массив параметров |
массив all()
Возвращает параметры.
Значение результата
| массив | Массив параметров |
массив keys()
Возвращает ключи параметров.
Значение результата
| массив | Массив ключей параметров |
replace(array $parameters = array())
Заменяет текущие параметры новым набором.
Параметры
| массив | $parameters | Массив параметров |
add(array $parameters = array())
Добавляет параметры.
Параметры
| массив | $parameters | Массив параметров |
смешанный тип get(string $key, mixed $default = null, bool $deep = false)
Возвращает параметр по имени.
Примечание: Поиск глубоких элементов устарел с версии 2.8, будет удалён в версии 3.0.
Параметры
| строка | $key | Ключ |
| смешанный тип | $default | Значение по умолчанию, если ключ параметра не существует |
| bool | $deep | Если true, путь, подобный foo[bar], будет искать более глубокие элементы |
Значение результата
| смешанный тип |
Исключения
| InvalidArgumentException |
set(string $key, mixed $value)
Устанавливает параметр по имени.
Параметры
| строка | $key | Ключ |
| смешанный тип | $value | Значение |
bool has(string $key)
Возвращает true, если параметр определён.
Параметры
| строка | $key | Ключ |
Значение результата
| bool | true, если параметр существует, иначе false |
remove(string $key)
Удаляет параметр.
Параметры
| строка | $key | Ключ |
строка getAlpha(string $key, string $default = '', bool $deep = false)
Возвращает буквенные символы значения параметра.
Параметры
| строка | $key | Ключ параметра |
| строка | $default | Значение по умолчанию, если ключ параметра не существует |
| bool | $deep | Если true, путь, подобный foo[bar], будет искать более глубокие элементы |
Значение результата
| строка | Отфильтрованное значение |
строка getAlnum(string $key, string $default = '', bool $deep = false)
Возвращает буквенные символы и цифры значения параметра.
Параметры
| строка | $key | Ключ параметра |
| строка | $default | Значение по умолчанию, если ключ параметра не существует |
| bool | $deep | Если true, путь, подобный foo[bar], будет искать более глубокие элементы |
Значение результата
| строка | Отфильтрованное значение |
строка getDigits(string $key, string $default = '', bool $deep = false)
Возвращает цифры значения параметра.
Параметры
| строка | $key | Ключ параметра |
| строка | $default | Значение по умолчанию, если ключ параметра не существует |
| bool | $deep | Если true, путь, подобный foo[bar], будет искать более глубокие элементы |
Значение результата
| строка | Отфильтрованное значение |
целое число getInt(string $key, int $default, bool $deep = false)
Возвращает значение параметра, преобразованное в целое число.
Параметры
| строка | $key | Ключ параметра |
| целое число | $default | Значение по умолчанию, если ключ параметра не существует |
| bool | $deep | Если true, путь, подобный foo[bar], будет искать более глубокие элементы |
Значение результата
| целое число | Отфильтрованное значение |
bool getBoolean(string $key, mixed $default = false, bool $deep = false)
Возвращает значение параметра, преобразованное в булево значение.
Параметры
| строка | $key | Ключ параметра |
| смешанный тип | $default | Значение по умолчанию, если ключ параметра не существует |
| bool | $deep | Если true, путь, подобный foo[bar], будет искать более глубокие элементы |
Значение результата
| bool | Отфильтрованное значение |
смешанный тип filter(string $key, mixed $default = null, int $filter = FILTER_DEFAULT, mixed $options = array(), bool $deep = false)
Фильтр ключа.
Параметры
| строка | $key | Ключ |
| смешанный тип | $default | Значение по умолчанию = null |
| целое число | $filter | Константа FILTER_* |
| смешанный тип | $options | Опции фильтра |
| bool | $deep | Значение по умолчанию = false |
Значение результата
| смешанный тип |
См. также
| http://php.net/manual/en/function.filter-var.php |
ArrayIterator getIterator()
Возвращает итератор для параметров.
Значение результата
| ArrayIterator | Экземпляр \ArrayIterator |
целое число count()
Возвращает количество параметров.
Значение результата
| целое число | Количество параметров |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/HttpFoundation/ParameterBag.html
