PHP file_get_contents(): Membaca File Menjadi String

file_get_contents('notes.txt') membaca seluruh isi file dan mengembalikannya sebagai satu string. Kalau file-nya tidak bisa dibaca, hasilnya false. Untuk menulis, pakai file_put_contents('notes.txt', $text), yang membuat file baru atau mengganti isinya.

<?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";

Output:

Buy milk
Call Ada
Write docs
29 bytes
3 lines

Blok ini menulis notes.txt lebih dulu lalu membacanya kembali, supaya ada file yang bisa diolah. Path seperti 'notes.txt' bersifat relatif terhadap direktori kerja saat ini; di aplikasi web, susun path dari folder script itu sendiri dengan __DIR__ . '/notes.txt'.

Menulis dan menambahkan isi dengan file_put_contents()

file_put_contents() mengembalikan jumlah byte yang ditulis, atau false kalau gagal. Secara bawaan, fungsi ini menimpa file. Flag FILE_APPEND justru menambahkan ke akhir file, begitulah cara kerja log sederhana, dan LOCK_EX mencegah dua request menulis pada saat yang sama:

<?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";

Output:

Wrote 8 bytes
started
step 1 done
step 2 done

replaced

abc
5 bytes

Untuk menyimpan array dan mendapatkannya kembali sebagai array, tulis dalam format JSON dengan json_encode() lalu baca dengan json_decode().

Membaca file baris per baris dengan file()

file() membaca file ke dalam array dengan satu baris per elemen. Setiap baris tetap menyimpan baris barunya di akhir kecuali kamu memberikan FILE_IGNORE_NEW_LINES, dan FILE_SKIP_EMPTY_LINES membuang baris kosong (hanya bekerja bersama 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";

Output:

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

file() dan file_get_contents() memuat seluruh file ke memori. Itu tidak masalah untuk file konfigurasi dan log berukuran beberapa megabyte. Untuk file berukuran ratusan megabyte, baca satu baris setiap kali dengan fopen() dan fgets().

Memeriksa apakah file ada sebelum membacanya

Saat file-nya tidak ada, file_get_contents() mengembalikan false dan PHP mencetak warning:

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

Periksa dulu dengan is_file() (file yang ada dan bukan direktori) atau file_exists() (file atau direktori), dan selalu bandingkan hasilnya dengan === false, karena file kosong mengembalikan "", yang juga bernilai falsy:

<?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";

Output:

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

Jangan sembunyikan warning-nya dengan @file_get_contents(). Memeriksa lebih dulu, atau menangani false, membuat error tetap terlihat saat ada hal lain yang salah.

Membaca sebagian file

Argumen keempat dan kelima adalah offset byte tempat mulai membaca dan jumlah byte yang dibaca. Offset negatif dihitung dari akhir file. Named argument memungkinkanmu melewati dua argumen di antaranya:

<?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

Output:

HEADER
line 2
last line

Offset menghitung byte, bukan karakter. Di UTF-8, satu karakter Jepang berukuran 3 byte, jadi offset di tengahnya akan memotong karakter itu menjadi dua. Untuk bekerja dengan karakter, baca seluruh string lalu pakai mb_substr().

Menampilkan file teks di halaman web

Isi file adalah teks, dan teks yang dicetak ke HTML harus di-escape, kalau tidak, < di dalam file akan menjadi tag. htmlspecialchars() melakukan escape dan nl2br() mengubah baris baru menjadi tag <br>. Jalankan, lalu lihat tab Halaman:

<?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>

Hapus htmlspecialchars() lalu jalankan lagi: halamannya sekarang berhenti di "v1.2: Fixed", karena browser membaca <title> sebagai tag sungguhan dan menelan semua sesudahnya sebagai judul halaman. Halaman htmlspecialchars() menjelaskan kenapa hal ini penting untuk apa pun yang bisa ditulis pengguna.

Membaca URL dengan file_get_contents()

Dengan allow_url_fopen aktif (bawaan di php.ini), file_get_contents() juga membaca URL dan mengembalikan body respons. Stream context menambahkan method, header, body, dan timeout:

<?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
}

Untuk retry, redirect dengan batas, dan kode error yang jelas, cURL atau library HTTP client seperti Guzzle adalah alat yang lebih baik.

file_get_contents vs file() vs fopen()

Fungsi satu panggilan itu membuka, membaca atau menulis, lalu menutup file untukmu, jadi itulah pilihan bawaan yang tepat. Gunakan fopen() saat file-nya terlalu besar untuk disimpan di memori atau kamu perlu membiarkannya tetap terbuka di antara beberapa operasi.