Spec-Zone.ru › Symfony 3.0

ParameterBag

class ParameterBag implements IteratorAggregate, Countable

ParameterBag — контейнер для пар ключ/значение.

Методы

__construct(array $parameters = array())

Конструктор.

array all()

Возвращает параметры.

array keys()

Возвращает ключи параметров.

replace(array $parameters = array())

Заменяет текущие параметры новым набором.

add(array $parameters = array())

Добавляет параметры.

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

Возвращает параметр по имени.

set(string $key, mixed $value)

Устанавливает параметр по имени.

bool has(string $key)

Возвращает true, если параметр определён.

remove(string $key)

Удаляет параметр.

string getAlpha(string $key, string $default = '')

Возвращает буквенные символы значения параметра.

string getAlnum(string $key, string $default = '')

Возвращает буквенно-цифровые символы значения параметра.

string getDigits(string $key, string $default = '')

Возвращает цифровые символы значения параметра.

int getInt(string $key, int $default)

Возвращает значение параметра, преобразованное в целое число.

bool getBoolean(string $key, mixed $default = false)

Возвращает значение параметра, преобразованное в булево значение.

mixed filter(string $key, mixed $default = null, int $filter = FILTER_DEFAULT, mixed $options = array())

Фильтр ключа.

ArrayIterator getIterator()

Возвращает итератор для параметров.

int count()

Возвращает количество параметров.

Подробности

__construct(array $parameters = array())

Конструктор.

Параметры

array $parameters Массив параметров

array all()

Возвращает параметры.

Возвращаемое значение

array Массив параметров

array keys()

Возвращает ключи параметров.

Возвращаемое значение

array Массив ключей параметров

replace(array $parameters = array())

Заменяет текущие параметры новым набором.

Параметры

array $parameters Массив параметров

add(array $parameters = array())

Добавляет параметры.

Параметры

array $parameters Массив параметров

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

Возвращает параметр по имени.

Параметры

string $key Ключ
mixed $default Значение по умолчанию, если ключ параметра не существует

Возвращаемое значение

mixed

Исключения

InvalidArgumentException

set(string $key, mixed $value)

Устанавливает параметр по имени.

Параметры

string $key Ключ
mixed $value Значение

bool has(string $key)

Возвращает true, если параметр определён.

Параметры

string $key Ключ

Возвращаемое значение

bool true, если параметр существует, иначе false

remove(string $key)

Удаляет параметр.

Параметры

string $key Ключ

string getAlpha(string $key, string $default = '')

Возвращает буквенные символы значения параметра.

Параметры

string $key Ключ параметра
string $default Значение по умолчанию, если ключ параметра не существует

Возвращаемое значение

string Отфильтрованное значение

string getAlnum(string $key, string $default = '')

Возвращает буквенно-цифровые символы значения параметра.

Параметры

string $key Ключ параметра
string $default Значение по умолчанию, если ключ параметра не существует

Возвращаемое значение

string Отфильтрованное значение

string getDigits(string $key, string $default = '')

Возвращает цифровые символы значения параметра.

Параметры

string $key Ключ параметра
string $default Значение по умолчанию, если ключ параметра не существует

Возвращаемое значение

string Отфильтрованное значение

int getInt(string $key, int $default)

Возвращает значение параметра, преобразованное в целое число.

Параметры

string $key Ключ параметра
int $default Значение по умолчанию, если ключ параметра не существует

Возвращаемое значение

int Отфильтрованное значение

bool getBoolean(string $key, mixed $default = false)

Возвращает значение параметра, преобразованное в булево значение.

Параметры

string $key Ключ параметра
mixed $default Значение по умолчанию, если ключ параметра не существует

Возвращаемое значение

bool Отфильтрованное значение

mixed filter(string $key, mixed $default = null, int $filter = FILTER_DEFAULT, mixed $options = array())

Фильтр ключа.

Параметры

string $key Ключ.
mixed $default Значение по умолчанию = null.
int $filter Константа FILTER_*.
mixed $options Параметры фильтра.

Возвращаемое значение

mixed

См. также

http://php.net/manual/en/function.filter-var.php

ArrayIterator getIterator()

Возвращает итератор для параметров.

Возвращаемое значение

ArrayIterator Экземпляр \ArrayIterator

int count()

Возвращает количество параметров.

Возвращаемое значение

int Количество параметров

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/HttpFoundation/ParameterBag.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API