PHP: fread

Beschreibung

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

fread() liest bis zu length Bytes vom Dateizeiger stream. Das Lesen wird beendet, sobald eine der folgenden Bedingungen eintritt:

length Bytes wurden gelesen
Das Dateiende (EOF, end of file) wurde erreicht
Ein Paket wird verfügbar oder eine Socket-Zeitüberschreitung tritt auf (Bei Netzwerk-Streams)
Falls dieser Stream beim Lesen gepuffert wird und keine reguläre Datei repräsentiert, wird maximal einmal ein Stück bis zur maximalen Chunkgröße (normalerweise 8192 Bytes) gelesen. Abhängig von den bisher gepufferten Daten können die zurückgelieferten Daten größer als die Chunkgröße sein.

Parameter-Liste

stream: Eine Dateisystemressource (resource), wie sie in der Regel von fopen() zurückgegeben wird.
length: Bis zu length Bytes lesen.

Rückgabewerte

Gibt die ausgelesene Zeichenkette zurück. Bei einem Fehler wird false zurückgegeben.

Beispiele

Beispiel #1 Ein einfaches fread()-Beispiel

<?php
// liest den Inhalt einer Datei in einen String
$filename = "/usr/local/etwas.txt";
$handle = fopen($filename, "r");
$contents = fread($handle, filesize($filename));
fclose($handle);
?>

Beispiel #2 Ein fread()-Beispiel mit einer Binärdatei

Warnung

Auf Systemen, welche zwischen Binär- und Textdateien (z. B. Windows) unterscheiden, muss die Datei mit 'b' im fopen() Mode-Parameter geöffnet werden.

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

Beispiel #3 fread()-Beispiele für entfernte Dateien

Warnung

Wenn aus etwas gelesen werden soll, was keine normale lokale Datei ist, wie etwa Streams von entfernten Dateien oder von popen() und fsockopen(), so wird das Lesen beendet sobald ein Paket verfügbar ist. Das bedeutet, dass man die Daten in Stücken sammeln muss. Dies wird im unteren Beispiel gezeigt.

<?php
$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("Konnte Stream von URL nicht öffnen");
}

$contents = '';

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

Anmerkungen

Hinweis:
Wenn man nur den Inhalt einer Datei in eine Zeichenkette lesen will, so sollte man file_get_contents() verwenden, da dies eine bessere Performance hat als der obige Code.

Hinweis:
Beachten Sie, dass fread() an der aktuellen Position im Dateizeiger zu lesen beginnt. Verwenden Sie ftell(), um herauszufinden wo dieser Zeiger steht und die Funktion rewind(), um den Zeiger zurückzustellen.

Siehe auch

fwrite() - Binär-sicheres Dateischreiben
fopen() - Öffnet eine Datei oder URL
fsockopen() - Stellt eine Internet- oder Unix-Domain-Socket-Verbindung her
popen() - Öffnet einen Dateizeiger für einen Prozess
fgets() - Liest die Zeile von der Position des Dateizeigers
fgetss() - Liest eine Zeile von der Position des Dateizeigers und entfernt HTML Tags.
fscanf() - Interpretiert den Input einer Datei entsprechend einem angegebenen Format
file() - Liest eine komplette Datei in ein Array
fpassthru() - Gibt alle verbleibenden Daten eines Dateizeigers aus
fseek() - Positioniert den Dateizeiger
ftell() - Ermittelt die aktuelle Position des Dateizeigers
rewind() - Setzt die Position eines Dateizeigers auf den Anfang
unpack() - Entpackt die Daten einer binäre Zeichenkette