(PHP 4 >= 4.3.0, PHP 5, PHP 7)
file_get_contents — Liest die gesamte Datei in einen String
$filename
[, bool $use_include_path = false
[, resource $context
[, int $offset = 0
[, int $maxlen
]]]] )
Diese Funktion ist mit file() identisch,
außer dass file_get_contents() die Datei in
einem String zurückgibt, beginnend am angebenen offset
über bis zu maxlen Bytes. Im Fehlerfall gibt
file_get_contents() FALSE zurück.
file_get_contents() ist der empfohlene Weg, um den Inhalt einer Datei in einen String zu lesen. Es werden Techniken zur Speicherabbildung genutzt, um die Performance zu erhöhen, falls das Betriebssystem dies unterstützt.
Hinweis:
Falls Sie einen URI mit speziellen Zeichen, wie z.B. Leerzeichen, öffnen, müssen Sie den URI mittels urlencode() enkodieren.
filenameName der zu lesenden Datei.
use_include_pathHinweis:
Seit PHP 5 kann die Konstante
FILE_USE_INCLUDE_PATHgenutzt werden, um eine Suche im include path auszulösen.
context
Eine gültige Context-Ressource, die mit
stream_context_create() erstellt wurde. Falls Sie
keinen eigenen Context benötigen, können Sie diesen Parameter mit
NULL überspringen.
offsetDie Position, an der das Lesen im Originalstream beginnt. Negative Offsets zählen vom Ende des Streams an.
Das Springen an bestimmte Positionen (offset)
wird nicht für entfernte Dateien unterstützt. Für kleine Offsets kann
der Sprung funktionieren, allerdings ist dies nicht vorhersagbar,
weil hierbei auf dem gepufferten Stream gearbeitet wird.
maxlenMaximale Länge der zu lesenden Daten. Standardmäßig wird solange gelesen bis das Ende der Datei erreicht wird. Beachten Sie, dass dieser Parameter auf den Stream angewendet wird, der durch die Filter verarbeitet wird.
Die Funktion gibt die gelesenen Daten zurück. Im Fehlerfall wird FALSE zurückgegeben.
Diese Funktion kann sowohl das
boolsche FALSE zurückliefern, als auch einen nicht-boolschen Wert, welcher zu FALSE ausgewertet wird.
Weitere Informationen entnehmen Sie bitte dem Abschnitt über die
boolschen Typen. Benutzen Sie deshalb
den === Operator,
um den Rückgabewert dieser Funktion zu überprüfen.
Ein Fehler der Stufe E_WARNING wird generiert, wenn
filename nicht gefunden werden kann,
maxlength kleiner als Null ist oder wenn das Aufsuchen des angegebenen
offset im Streams fehlschlägt.
Beispiel #1 Holen und Ausgeben des Quelltextes der Startseite einer Webseite
<?php
$homepage = file_get_contents('http://www.example.com/');
echo $homepage;
?>
Beispiel #2 Suche im include_path
<?php
// <= PHP 5
$file = file_get_contents('./leute.txt', true);
// > PHP 5
$file = file_get_contents('./leute.txt', FILE_USE_INCLUDE_PATH);
?>
Beispiel #3 Lesen einen Abschnitts einer Datei
<?php
// Lese 14 Zeichen, beginnend mit dem 21. Zeichen
$section = file_get_contents('./leute.txt', NULL, NULL, 20, 14);
var_dump($section);
?>
Das oben gezeigte Beispiel erzeugt eine ähnliche Ausgabe wie:
string(14) "lle Bjori Ro"
Beispiel #4 Nutzung von Stream-Contexten
<?php
// Erzeugen eines Streams
$opts = array(
'http'=>array(
'method'=>"GET",
'header'=>"Accept-language: en\r\n" .
"Cookie: foo=bar\r\n"
)
);
$context = stream_context_create($opts);
// Öffnen der Datei mit den oben definierten HTTP-Headern
$file = file_get_contents('http://www.example.com/', false, $context);
?>
| Version | Beschreibung |
|---|---|
| 7.1.0 |
Unterstützung für negative offsets wurde hinzugefügt.
|
| 5.1.0 |
Die offset- und
maxlen-Parameter wurden hinzugefügt.
|
Hinweis: Diese Funktion ist binary safe.
Mit dieser Funktion können Sie eine URL als Dateinamen verwenden, falls Sie fopen wrappers ermöglicht haben. Mehr Details dazu, wie Sie den Dateinamen angeben müssen finden Sie bei fopen(). Eine Liste der unterstützten URL Protokolle, die Fähigkeiten der verschiedenen Wrapper, Hinweise zu deren Verwendung und Informationen zu den eventuell vorhandenen vordefinierten Variablen finden Sie unter Unterstützte Protokolle und Wrapper.
Bei SSL-Verbindungen zusammen mit Microsoft IIS hält sich dieser Webserver nicht an das Protokoll und schließt die Verbindung ohne ein close_notify zu senden. PHP quittiert dieses Fehlverhalten mit "SSL: Fatal Protocol Error", wenn das Ende der Daten erreicht ist. Eine mögliche Lösung besteht darin, den Level von error_reporting herabzusetzten und Warnings auszuschließen. PHP kann fehlerhafte IIS-Serversoftware erkennen, wenn Sie einen Stream mit dem https://-Wrapper öffnen, und unterdrückt die Warnung für Sie. Falls Sie fsockopen() benutzen, um einen ssl://-Socket zu öffnen, müssen Sie selbst dafür Sorge tragen, die Warnung zu erkennen und diese zu unterdrücken.