FileBag

__construct(array $parameters = array())

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

Параметры

array

$parameters

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

array all()

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

Значение возврата

array

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

array keys()

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

Значение возврата

array

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

replace(array $files = array())

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

Параметры

array

$files

add(array $files = array())

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

Параметры

array

$files

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

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

Примечание: Поиск глубоких элементов устарел начиная с версии 2.8, будет удален в версии 3.0.

Параметры

string	$key	Ключ
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, int $filter = FILTER_DEFAULT, mixed $options = array(), bool $deep = false)

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

Параметры

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

Значение возврата

mixed

См. также

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

ArrayIterator getIterator()

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

Значение возврата

ArrayIterator

Экземпляр \ArrayIterator

int count()

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

Значение возврата

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