ServerBag
class ServerBag extends ParameterBag
ServerBag — это контейнер для HTTP-заголовков из переменной $_SERVER.
Методы
| __construct(array $parameters = array()) Конструктор. | from ParameterBag | |
| array | all() Возвращает параметры. | from ParameterBag |
| array | keys() Возвращает ключи параметров. | from ParameterBag |
| replace(array $parameters = array()) Заменяет текущие параметры новым набором. | from ParameterBag | |
| add(array $parameters = array()) Добавляет параметры. | from ParameterBag | |
| mixed | get(string $key, mixed $default = null) Возвращает параметр по имени. | from ParameterBag |
| set(string $key, mixed $value) Устанавливает параметр по имени. | from ParameterBag | |
| bool | has(string $key) Возвращает true, если параметр определён. | from ParameterBag |
| remove(string $key) Удаляет параметр. | from ParameterBag | |
| string | getAlpha(string $key, string $default = '') Возвращает буквенные символы значения параметра. | from ParameterBag |
| string | getAlnum(string $key, string $default = '') Возвращает буквенные символы и цифры значения параметра. | from ParameterBag |
| string | getDigits(string $key, string $default = '') Возвращает цифры значения параметра. | from ParameterBag |
| int | getInt(string $key, int $default) Возвращает значение параметра, преобразованное в целое число. | from ParameterBag |
| bool | getBoolean(string $key, mixed $default = false) Возвращает значение параметра, преобразованное в булево значение. | from ParameterBag |
| mixed | filter(string $key, mixed $default = null, int $filter = FILTER_DEFAULT, mixed $options = array()) Фильтрует ключ. | from ParameterBag |
| ArrayIterator | getIterator() Возвращает итератор для параметров. | from ParameterBag |
| int | count() Возвращает количество параметров. | from ParameterBag |
| array | getHeaders() Получает HTTP-заголовки. |
Подробности
__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 |
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 | Количество параметров |
array getHeaders()
Получает HTTP-заголовки.
Значение результата
| array |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/HttpFoundation/ServerBag.html
