PHP file_get_contents() : lire un fichier dans une chaîne

file_get_contents('notes.txt') lit le fichier entier et le renvoie sous forme d'une seule chaîne. Si le fichier ne peut pas être lu, elle renvoie false. Pour écrire, utilisez file_put_contents('notes.txt', $text), qui crée le fichier ou remplace son contenu.

<?php
file_put_contents('notes.txt', "Buy milk\nCall Ada\nWrite docs\n");

$text = file_get_contents('notes.txt');

echo $text;
echo strlen($text), " bytes\n";
echo substr_count($text, "\n"), " lines\n";

Sortie :

Buy milk
Call Ada
Write docs
29 bytes
3 lines

Le bloc écrit d'abord notes.txt puis le relit, pour avoir un fichier sur lequel travailler. Un chemin comme 'notes.txt' est relatif au dossier de travail courant ; dans une application web, construisez le chemin à partir du dossier du script avec __DIR__ . '/notes.txt'.

Écrire et ajouter avec file_put_contents()

file_put_contents() renvoie le nombre d'octets écrits, ou false en cas d'échec. Par défaut, elle écrase le fichier. L'option FILE_APPEND ajoute plutôt à la fin, c'est ainsi que fonctionnent les journaux simples, et LOCK_EX empêche deux requêtes d'écrire au même moment :

<?php
$bytes = file_put_contents('log.txt', "started\n");
echo "Wrote $bytes bytes\n";

file_put_contents('log.txt', "step 1 done\n", FILE_APPEND | LOCK_EX);
file_put_contents('log.txt', "step 2 done\n", FILE_APPEND | LOCK_EX);
echo file_get_contents('log.txt'), "\n";

file_put_contents('log.txt', "replaced\n");   // no flag: the old content is gone
echo file_get_contents('log.txt'), "\n";

// An array is written with its elements joined, with nothing between them
file_put_contents('list.txt', ['a', 'b', 'c']);
echo file_get_contents('list.txt'), "\n";
echo file_put_contents('list.txt', implode("\n", ['a', 'b', 'c'])), " bytes\n";

Sortie :

Wrote 8 bytes
started
step 1 done
step 2 done

replaced

abc
5 bytes

Pour stocker un tableau et le récupérer sous forme de tableau, écrivez-le en JSON avec json_encode() et relisez-le avec json_decode().

Lire un fichier ligne par ligne avec file()

file() lit un fichier dans un tableau avec une ligne par élément. Chaque ligne garde son saut de ligne final sauf si vous passez FILE_IGNORE_NEW_LINES, et FILE_SKIP_EMPTY_LINES supprime les lignes vides (elle ne fonctionne qu'avec FILE_IGNORE_NEW_LINES) :

<?php
file_put_contents('todo.txt', "Buy milk\nCall Ada\n\nWrite docs\n");

$lines = file('todo.txt');
var_dump($lines[0]);   // the newline is still there

$lines = file('todo.txt', FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
foreach ($lines as $i => $line) {
    echo $i + 1, ". $line\n";
}

echo count($lines), " tasks\n";

Sortie :

string(9) "Buy milk
"
1. Buy milk
2. Call Ada
3. Write docs
3 tasks

file() et file_get_contents() chargent tout le fichier en mémoire. Cela convient pour des fichiers de configuration et des journaux de quelques mégaoctets. Pour un fichier de plusieurs centaines de mégaoctets, lisez-le plutôt ligne par ligne avec fopen() et fgets().

Vérifier qu'un fichier existe avant de le lire

Quand le fichier manque, file_get_contents() renvoie false et PHP affiche un warning :

Warning: file_get_contents(missing.txt): Failed to open stream: No such file or directory in /home/index.php on line 2

Vérifiez d'abord avec is_file() (un fichier qui existe et n'est pas un dossier) ou file_exists() (un fichier ou un dossier), et comparez toujours le résultat avec === false, car un fichier vide renvoie "", qui est aussi évalué à faux :

<?php
file_put_contents('empty.txt', '');

foreach (['empty.txt', 'missing.txt', '.'] as $path) {
    echo str_pad($path, 12);
    echo file_exists($path) ? 'exists ' : 'missing ';
    echo is_file($path) ? 'file ' : '';
    echo is_dir($path) ? 'directory ' : '';
    echo "\n";
}

$path = 'missing.txt';
if (!is_file($path) || !is_readable($path)) {
    echo "Cannot read $path, using defaults\n";
} else {
    $text = file_get_contents($path);
}

$text = file_get_contents('empty.txt');
var_dump($text === false, $text == false);   // not a failure, just empty
echo filesize('empty.txt'), " bytes\n";

Sortie :

empty.txt   exists file 
missing.txt missing 
.           exists directory 
Cannot read missing.txt, using defaults
bool(false)
bool(true)
0 bytes

Ne masquez pas le warning avec @file_get_contents(). Vérifier d'abord, ou traiter false, garde l'erreur visible quand autre chose tourne mal.

Lire une partie d'un fichier

Les quatrième et cinquième arguments sont la position en octets où commencer et le nombre d'octets à lire. Une position négative compte depuis la fin du fichier. Les arguments nommés permettent de sauter les deux arguments intermédiaires :

<?php
file_put_contents('data.txt', "HEADER\nline 2\nline 3\nlast line\n");

echo file_get_contents('data.txt', false, null, 0, 6), "\n";   // first 6 bytes
echo file_get_contents('data.txt', offset: 7, length: 6), "\n";
echo file_get_contents('data.txt', offset: -10);                 // last 10 bytes

Sortie :

HEADER
line 2
last line

Les positions comptent des octets, pas des caractères. En UTF-8, un caractère japonais fait 3 octets, donc une position au milieu de l'un d'eux le coupe en deux. Pour travailler sur des caractères, lisez toute la chaîne et utilisez mb_substr().

Afficher un fichier texte sur une page web

Le contenu d'un fichier est du texte, et le texte affiché dans du HTML doit être échappé, sinon un < dans le fichier devient une balise. htmlspecialchars() l'échappe et nl2br() transforme les sauts de ligne en balises <br>. Exécutez-le et regardez l'onglet Page :

<?php
file_put_contents('changelog.txt', <<<TXT
v1.2: Fixed <title> encoding
v1.1: Added "export" & "import"
v1.0: First release
TXT);

$text = file_get_contents('changelog.txt');
?>
<h3>Changelog</h3>
<p style="font-family: monospace"><?= nl2br(htmlspecialchars($text)) ?></p>
<p><?= count(file('changelog.txt')) ?> entries, <?= filesize('changelog.txt') ?> bytes</p>

Retirez htmlspecialchars() et relancez : la page s'arrête maintenant à « v1.2: Fixed », car le navigateur lit <title> comme une vraie balise et avale tout ce qui suit comme titre de la page. La page htmlspecialchars() explique pourquoi c'est important pour tout ce qu'un utilisateur peut écrire.

Lire une URL avec file_get_contents()

Avec allow_url_fopen activé (la valeur par défaut dans php.ini), file_get_contents() lit aussi des URL et renvoie le corps de la réponse. Un contexte de flux ajoute une méthode, des en-têtes, un corps et un délai maximal :

<?php
$html = file_get_contents('https://example.com/');

$context = stream_context_create([
    'http' => [
        'method'  => 'POST',
        'header'  => "Content-Type: application/json\r\n",
        'content' => json_encode(['name' => 'Ada']),
        'timeout' => 5,
        'ignore_errors' => true,   // return the body of 4xx/5xx responses too
    ],
]);

$response = file_get_contents('https://api.example.com/users', false, $context);
if ($response === false) {
    // DNS failure, timeout, or a refused connection
}

Pour les nouvelles tentatives, les redirections avec limites et des codes d'erreur clairs, cURL ou une bibliothèque cliente HTTP comme Guzzle est le meilleur outil.

file_get_contents, file() ou fopen()

Les fonctions en un appel ouvrent, lisent ou écrivent, puis ferment le fichier pour vous, elles sont donc le bon choix par défaut. Passez à fopen() quand le fichier est trop gros pour tenir en mémoire ou que vous devez le garder ouvert entre plusieurs opérations.