fread

(PHP 4, PHP 5, PHP 7)

fread — Бинарно-безопасное чтение файла

Описание

fread ( resource $stream , int $length ) : string|false

fread() читает до length байт из файлового указателя stream и смещает указатель. Чтение останавливается как только было достигнуто одно из следующих условий:

было прочитано length байт
достигнут EOF (конец файла)
стал доступен пакет или произошел тайм-аут сокета (для сетевых потоков)
если читаемый поток является буферизованным и не представляет собой обычный файл, то за один раз максимум читается количество байт, равное размеру одной порции данных (обычно это 8192), однако, в зависимости от ранее буферизованных данных размер возвращаемых данных может быть больше размера одной порции данных.

Список параметров

stream: Указатель (resource) на файл, обычно создаваемый с помощью функции fopen().
length: length указывает размер прочитанных данных в байтах.

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

Возвращает прочтенную строку или false в случае возникновения ошибки.

Примеры

Пример #1 Простой пример использования fread()


<?php
// получает содержимое файла в строку
$filename = "/usr/local/something.txt";
$handle = fopen($filename, "r");
$contents = fread($handle, filesize($filename));
fclose($handle);
?>

Пример #2 Пример бинарного чтения с помощью fread()

Внимание

На системах, которые различают бинарные и текстовые файлы (к примеру, Windows), файл должен быть открыт с использованием флага 'b' в параметре mode функции fopen().


<?php
$filename = "c:\\files\\somepic.gif";
$handle = fopen($filename, "rb");
$contents = fread($handle, filesize($filename));
fclose($handle);
?>

Пример #3 Примеры удаленного чтения с помощью fread()

Внимание

При чтении чего-либо отличного от локальных файлов, например потоков, возвращаемых при чтении удаленных файлов или из popen() и fsockopen(), чтение остановится после того, как пакет станет доступным. Это означает, что вы должны собирать данные вместе по кусочкам, как показано на примере ниже.


<?php
// Для PHP 5 и выше
$handle = fopen("http://www.example.com/", "rb");
$contents = stream_get_contents($handle);
fclose($handle);
?>


<?php
$handle = fopen("http://www.example.com/", "rb");
if (FALSE === $handle) {
    exit("Не удалось открыть поток по url адресу");
}

$contents = '';

while (!feof($handle)) {
    $contents .= fread($handle, 8192);
}
fclose($handle);
?>

Примечания

Замечание:
Если вы просто хотите получить содержимое файла в виде строки, используйте file_get_contents(), так как эта функция намного производительнее, чем код описанный выше.

Замечание:
Учтите, что fread() читает, начиная с текущей позиции файлового указателя. Используйте функцию ftell() для нахождения текущей позиции указателя и функцию rewind() для перемотки позиции указателя в начало.

Смотрите также

fwrite() - Бинарно-безопасная запись в файл
fopen() - Открывает файл или URL
fsockopen() - Открывает соединение с интернет-сокетом или доменным сокетом Unix
popen() - Открывает файловый указатель процесса
fgets() - Читает строку из файла
fgetss() - Читает строку из файла и удаляет HTML-теги
fscanf() - Обрабатывает данные из файла в соответствии с форматом
file() - Читает содержимое файла и помещает его в массив
fpassthru() - Выводит все оставшиеся данные из файлового указателя
ftell() - Возвращает текущую позицию указателя чтения/записи файла
rewind() - Сбрасывает курсор файлового указателя
unpack() - Распаковать данные из бинарной строки