(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)
stream_get_meta_data — Извлекает заголовок или метаданные из потоков или файловых указателей
Функция возвращает информацию о существующем потоке stream
.
stream
Параметр stream может быть любым потоком, который создали функциями fopen(), fsockopen(), pfsockopen() и stream_socket_client().
Функция возвращает массив, который содержит следующие элементы:
timed_out
(bool) — true
, если поток
превысил время ожидания данных во время последнего вызова функции
fread() или fgets().
blocked
(bool) — true
, если поток находится в
режиме блокирующего ввода-вывода. Смотрите описание функции stream_set_blocking().
eof
(bool) — true
, если поток достиг
конца файла. Заметьте, что для потоков с типом socket этот член может быть равен true
,
даже когда элемент unread_bytes
не равен нулю. Чтобы
определить, есть ли ещё данные для чтения, вместо чтения этого элемента
вызывают функцию feof().
unread_bytes
(int) — количество байтов,
которые содержатся сейчас в собственном внутреннем буфере PHP.
Замечание: Не следует использовать это значение в скрипте.
stream_type
(string) — метка, которая описывает
внутреннюю реализацию потока.
wrapper_type
(string) — метка, которая описывает
реализацию обёртки протокола, наложенного на поток.
Раздел «Протоколы и обёртки» даёт дополнительную информацию об обёртках.
wrapper_data
(mixed) — специфические для обёртки
данные, прикреплённые к этому потоку. Раздел «Протоколы и обёртки»
даёт дополнительную информацию об обёртках и их данных.
mode
(string) — тип доступа, который требуется
для этого потока (смотрите таблицу 1 в описании функции fopen())
seekable
(bool) — можно ли перемещаться по текущему
потоку.
uri
(string) — URI-идентификатор или имя файла, которое связано с этим
потоком.
crypto
(array) — метаданные TLS-соединения потока.
Примечание: массив будет содержать это поле, только если поток ресурса использует TLS.
Пример #1 Пример использования функции stream_get_meta_data() с вызовом функции fopen() с HTTP-протоколом
<?php
$url = 'http://www.example.com/';
if (!$fp = fopen($url, 'r')) {
trigger_error("Невозможно открыть URL-адрес, который содержит переменная $url", E_USER_ERROR);
}
$meta = stream_get_meta_data($fp);
var_dump($meta);
fclose($fp);
?>
Вывод приведённого примера будет похож на:
array(10) { 'timed_out' => bool(false) 'blocked' => bool(true) 'eof' => bool(false) 'wrapper_data' => array(13) { [0] => string(15) "HTTP/1.1 200 OK" [1] => string(11) "Age: 244629" [2] => string(29) "Cache-Control: max-age=604800" [3] => string(38) "Content-Type: text/html; charset=UTF-8" [4] => string(35) "Date: Sat, 20 Nov 2021 18:17:57 GMT" [5] => string(24) "Etag: "3147526947+ident"" [6] => string(38) "Expires: Sat, 27 Nov 2021 18:17:57 GMT" [7] => string(44) "Last-Modified: Thu, 17 Oct 2019 07:18:26 GMT" [8] => string(22) "Server: ECS (chb/0286)" [9] => string(21) "Vary: Accept-Encoding" [10] => string(12) "X-Cache: HIT" [11] => string(20) "Content-Length: 1256" [12] => string(17) "Connection: close" } 'wrapper_type' => string(4) "http" 'stream_type' => string(14) "tcp_socket/ssl" 'mode' => string(1) "r" 'unread_bytes' => int(1256) 'seekable' => bool(false) 'uri' => string(23) "http://www.example.com/" }
Пример #2 Пример использования stream_get_meta_data() с вызовом функции stream_socket_client() с HTTPS-протоколом
<?php
$streamContext = stream_context_create(
[
'ssl' => [
'capture_peer_cert' => true,
'capture_peer_cert_chain' => true,
'disable_compression' => true,
],
]
);
$client = stream_socket_client(
'ssl://www.example.com:443',
$errorNumber,
$errorDescription,
40,
STREAM_CLIENT_CONNECT,
$streamContext
);
$meta = stream_get_meta_data($client);
var_dump($meta);
?>
Вывод приведённого примера будет похож на:
array(8) { 'crypto' => array(4) { 'protocol' => string(7) "TLSv1.3" 'cipher_name' => string(22) "TLS_AES_256_GCM_SHA384" 'cipher_bits' => int(256) 'cipher_version' => string(7) "TLSv1.3" } 'timed_out' => bool(false) 'blocked' => bool(true) 'eof' => bool(false) 'stream_type' => string(14) "tcp_socket/ssl" 'mode' => string(2) "r+" 'unread_bytes' => int(0) 'seekable' => bool(false) }
Замечание:
Эта функция НЕ будет работать с сокетами, которые создали через модуль Socket.