Headers
in package
Неизменяемый регистронезависимый набор HTTP-заголовков.
Имена заголовков сравниваются без учёта регистра (RFC 7230), исходное написание имени сохраняется для вывода. Каждый заголовок может иметь несколько значений. Все модифицирующие методы возвращают новый экземпляр — общий экземпляр невозможно изменить незаметно для владельца.
Table of Contents
Methods
- __construct() : mixed
- all() : array<string, array<int, string>>
- Все заголовки как «имя → список значений» (в исходном написании имён).
- first() : string|null
- Первое значение заголовка или значение по умолчанию.
- get() : array<int, string>
- Значения заголовка.
- has() : bool
- Есть ли заголовок с указанным именем.
- isEmpty() : bool
- Пустой ли набор заголовков.
- line() : string
- Значения заголовка, объединённые запятой (как в одной строке заголовка).
- toLines() : array<int, string>
- Заголовки в формате cURL — список строк «Имя: значение».
- with() : self
- Копия с заменой значения заголовка.
- withAdded() : self
- Копия с добавленным значением (существующие значения сохраняются).
- without() : self
- Копия без указанного заголовка.
Methods
__construct()
public
__construct([iterable<string, string|array<int, string>> $headers = [] ]) : mixed
Parameters
- $headers : iterable<string, string|array<int, string>> = []
-
пары «имя → значение(я)»
all()
Все заголовки как «имя → список значений» (в исходном написании имён).
public
all() : array<string, array<int, string>>
Return values
array<string, array<int, string>> —карта заголовков
first()
Первое значение заголовка или значение по умолчанию.
public
first(string $name[, string|null $default = null ]) : string|null
Parameters
- $name : string
-
имя заголовка (регистр не важен)
- $default : string|null = null
-
значение, если заголовок отсутствует
Return values
string|null —первое значение либо значение по умолчанию
get()
Значения заголовка.
public
get(string $name) : array<int, string>
Parameters
- $name : string
-
имя заголовка (регистр не важен)
Return values
array<int, string> —список значений (пустой, если заголовка нет)
has()
Есть ли заголовок с указанным именем.
public
has(string $name) : bool
Parameters
- $name : string
-
имя заголовка (регистр не важен)
Return values
bool —true, если заголовок присутствует
isEmpty()
Пустой ли набор заголовков.
public
isEmpty() : bool
Return values
bool —true, если заголовков нет
line()
Значения заголовка, объединённые запятой (как в одной строке заголовка).
public
line(string $name) : string
Parameters
- $name : string
-
имя заголовка (регистр не важен)
Return values
string —объединённые значения (пустая строка, если заголовка нет)
toLines()
Заголовки в формате cURL — список строк «Имя: значение».
public
toLines() : array<int, string>
Return values
array<int, string> —строки заголовков для CURLOPT_HTTPHEADER
with()
Копия с заменой значения заголовка.
public
with(string $name, string|array<int, string> $value) : self
Parameters
- $name : string
-
имя заголовка
- $value : string|array<int, string>
-
значение или список значений
Return values
self —новый экземпляр
withAdded()
Копия с добавленным значением (существующие значения сохраняются).
public
withAdded(string $name, string|array<int, string> $value) : self
Parameters
- $name : string
-
имя заголовка
- $value : string|array<int, string>
-
значение или список значений
Return values
self —новый экземпляр
without()
Копия без указанного заголовка.
public
without(string $name) : self
Parameters
- $name : string
-
имя заголовка (регистр не важен)
Return values
self —новый экземпляр