ParameterBag

__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 $path, mixed $default = null, bool $deep = false)

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

Параметры

string	$path	Ключ
mixed	$default	Значение по умолчанию, если ключ параметра не существует
bool	$deep	Если true, путь типа foo[bar] будет искать более глубокие элементы

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

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 = '', bool $deep = false)

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

Параметры

string	$key	Ключ параметра
string	$default	Значение по умолчанию, если ключ параметра не существует
bool	$deep	Если true, путь типа foo[bar] будет искать более глубокие элементы

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

string

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

string getAlnum(string $key, string $default = '', bool $deep = false)

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

Параметры

string	$key	Ключ параметра
string	$default	Значение по умолчанию, если ключ параметра не существует
bool	$deep	Если true, путь типа foo[bar] будет искать более глубокие элементы

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

string

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

string getDigits(string $key, string $default = '', bool $deep = false)

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

Параметры

string	$key	Ключ параметра
string	$default	Значение по умолчанию, если ключ параметра не существует
bool	$deep	Если true, путь типа foo[bar] будет искать более глубокие элементы

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

string

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

int getInt(string $key, int $default, bool $deep = false)

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

Параметры

string	$key	Ключ параметра
int	$default	Значение по умолчанию, если ключ параметра не существует
bool	$deep	Если true, путь типа foo[bar] будет искать более глубокие элементы

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

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

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

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

Параметры

string	$key	Ключ параметра
mixed	$default	Значение по умолчанию, если ключ параметра не существует
bool	$deep	Если true, путь типа foo[bar] будет искать более глубокие элементы

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

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

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

Фильтрует ключ.

Параметры

string	$key	Ключ
mixed	$default	Значение по умолчанию = null
bool	$deep	Значение по умолчанию = false
int	$filter	Константа FILTER_*
mixed	$options	Опции фильтра

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

mixed

См. также

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

ArrayIterator getIterator()

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

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

ArrayIterator

Экземпляр \ArrayIterator

int count()

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

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

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