Hàm file_get_contents() trong PHP: đọc tệp thành chuỗi

file_get_contents('notes.txt') đọc toàn bộ tệp và trả về nó dưới dạng một chuỗi. Nếu không đọc được tệp, hàm trả về false. Để ghi, dùng file_put_contents('notes.txt', $text), hàm này tạo tệp hoặc thay thế nội dung đang có trong đó.

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

Đầu ra:

Buy milk
Call Ada
Write docs
29 bytes
3 lines

Khối code ghi notes.txt trước rồi đọc lại, nên nó luôn có một tệp để làm việc. Một đường dẫn như 'notes.txt' là tương đối so với thư mục làm việc hiện tại; trong ứng dụng web, hãy tạo đường dẫn từ chính thư mục của script bằng __DIR__ . '/notes.txt'.

Ghi và ghi thêm với file_put_contents()

file_put_contents() trả về số byte đã ghi, hoặc false khi thất bại. Mặc định, hàm ghi đè lên tệp. Cờ FILE_APPEND thì thêm vào cuối, đó là cách các log đơn giản hoạt động, còn LOCK_EX ngăn hai request ghi vào cùng một thời điểm:

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

Đầu ra:

Wrote 8 bytes
started
step 1 done
step 2 done

replaced

abc
5 bytes

Để lưu một mảng và lấy lại đúng dạng mảng, hãy ghi nó dưới dạng JSON bằng json_encode() và đọc bằng json_decode().

Đọc tệp từng dòng với file()

file() đọc một tệp thành mảng, mỗi phần tử là một dòng. Mỗi dòng giữ ký tự xuống dòng ở cuối, trừ khi bạn truyền FILE_IGNORE_NEW_LINES, còn FILE_SKIP_EMPTY_LINES bỏ các dòng trống (nó chỉ hoạt động khi đi cùng 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";

Đầu ra:

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

file() và file_get_contents() nạp toàn bộ tệp vào bộ nhớ. Điều đó ổn với tệp cấu hình và log vài megabyte. Với tệp hàng trăm megabyte, hãy đọc từng dòng một bằng fopen() và fgets().

Kiểm tra tệp có tồn tại trước khi đọc

Khi tệp không tồn tại, file_get_contents() trả về false và PHP in ra cảnh báo:

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

Hãy kiểm tra trước bằng is_file() (một tệp có tồn tại và không phải thư mục) hoặc file_exists() (một tệp hoặc một thư mục), và luôn so sánh kết quả với === false, vì một tệp rỗng trả về "", cũng là giá trị 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";

Đầu ra:

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

Đừng che cảnh báo bằng @file_get_contents(). Kiểm tra trước, hoặc xử lý false, giúp lỗi vẫn hiện ra khi có chuyện khác xảy ra.

Đọc một phần của tệp

Đối số thứ tư và thứ năm là vị trí byte bắt đầu và số byte cần đọc. Vị trí âm được tính từ cuối tệp. Đối số có tên (named arguments) cho phép bạn bỏ qua hai đối số ở giữa:

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

Đầu ra:

HEADER
line 2
last line

Vị trí được tính theo byte, không phải ký tự. Trong UTF-8, một ký tự tiếng Nhật chiếm 3 byte, còn nhiều chữ cái tiếng Việt có dấu chiếm 2 hoặc 3 byte, nên một vị trí rơi vào giữa ký tự sẽ cắt đôi nó. Để làm việc theo ký tự, hãy đọc cả chuỗi rồi dùng mb_substr().

Hiển thị tệp văn bản trên trang web

Nội dung tệp là văn bản, và văn bản in vào HTML phải được escape, nếu không một dấu < trong tệp sẽ thành thẻ. htmlspecialchars() escape nó, còn nl2br() biến các dấu xuống dòng thành thẻ <br>. Hãy chạy rồi xem tab Trang:

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

Bỏ htmlspecialchars() rồi chạy lại: trang giờ dừng ở "v1.2: Fixed", vì trình duyệt hiểu <title> là một thẻ thật và nuốt mọi thứ sau đó làm tiêu đề trang. Trang htmlspecialchars() giải thích vì sao điều đó quan trọng với mọi thứ người dùng có thể viết.

Đọc URL với file_get_contents()

Khi allow_url_fopen được bật (mặc định trong php.ini), file_get_contents() cũng đọc được URL và trả về phần thân của response. Một stream context thêm phương thức, header, phần thân và thời gian chờ:

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

Để thử lại, chuyển hướng có giới hạn và mã lỗi rõ ràng, cURL hoặc một thư viện HTTP client như Guzzle là công cụ tốt hơn.

file_get_contents, file() và fopen()

Các hàm một lời gọi tự mở, đọc hoặc ghi, rồi đóng tệp giúp bạn, nên chúng là lựa chọn mặc định đúng. Hãy dùng fopen() khi tệp quá lớn để giữ trong bộ nhớ hoặc bạn cần giữ tệp mở giữa các thao tác.