file_get_contents() ב-PHP: קריאת קובץ למחרוזת

file_get_contents('notes.txt') קוראת את כל הקובץ ומחזירה אותו כמחרוזת אחת. אם אי אפשר לקרוא את הקובץ היא מחזירה false. כדי לכתוב, השתמשו ב-file_put_contents('notes.txt', $text), שיוצרת את הקובץ או מחליפה את מה שהיה בו.

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

פלט:

Buy milk
Call Ada
Write docs
29 bytes
3 lines

הבלוק כותב קודם את notes.txt ואז קורא אותו בחזרה, כדי שיהיה לו קובץ לעבוד איתו. נתיב כמו 'notes.txt' יחסי לתיקיית העבודה הנוכחית; באפליקציית web, בנו את הנתיב מהתיקייה של הסקריפט עצמו עם __DIR__ . '/notes.txt'.

כתיבה והוספה עם file_put_contents()

file_put_contents() מחזירה את מספר הבתים שנכתבו, או false בכישלון. כברירת מחדל היא דורסת את הקובץ. הדגל FILE_APPEND מוסיף לסוף במקום זאת, וכך עובדים לוגים פשוטים, ו-LOCK_EX מונע משתי בקשות לכתוב באותו רגע:

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

פלט:

Wrote 8 bytes
started
step 1 done
step 2 done

replaced

abc
5 bytes

כדי לשמור מערך ולקבל אותו בחזרה כמערך, כתבו אותו כ-JSON עם json_encode() וקראו אותו עם json_decode().

קריאת קובץ שורה אחר שורה עם file()

file() קוראת קובץ למערך עם שורה אחת בכל איבר. כל שורה שומרת על ירידת השורה שבסופה אלא אם מעבירים FILE_IGNORE_NEW_LINES, ו-FILE_SKIP_EMPTY_LINES משמיט שורות ריקות (הוא עובד רק יחד עם 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";

פלט:

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

file() ו-file_get_contents() טוענות את כל הקובץ לזיכרון. זה בסדר לקובצי הגדרות וללוגים של כמה מגה-בתים. לקובץ של מאות מגה-בתים, קראו אותו שורה אחר שורה עם fopen() ו-fgets() במקום זאת.

בדיקה אם קובץ קיים לפני הקריאה

כשהקובץ חסר, file_get_contents() מחזירה false ו-PHP מדפיסה אזהרה:

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

בדקו קודם עם is_file() (קובץ שקיים ואינו תיקייה) או עם file_exists() (קובץ או תיקייה), ותמיד השוו את התוצאה עם === false, כי קובץ ריק מחזיר "", שגם הוא שקרי:

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

פלט:

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

אל תסתירו את האזהרה עם @file_get_contents(). בדיקה מראש, או טיפול ב-false, שומרים על השגיאה גלויה כשמשהו אחר משתבש.

קריאת חלק מקובץ

הארגומנטים הרביעי והחמישי הם היסט הבתים שממנו מתחילים ומספר הבתים לקריאה. היסט שלילי נספר מסוף הקובץ. ארגומנטים בשם מאפשרים לדלג על שני הארגומנטים שבאמצע:

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

פלט:

HEADER
line 2
last line

היסטים סופרים בתים, לא תווים. ב-UTF-8 תו יפני הוא 3 בתים, ולכן היסט באמצע תו כזה חותך אותו לשניים. כדי לעבוד עם תווים, קראו את כל המחרוזת והשתמשו ב-mb_substr().

הצגת קובץ טקסט בדף אינטרנט

תוכן של קובץ הוא טקסט, וטקסט שמודפס לתוך HTML חייב לעבור escape, אחרת < בקובץ הופך לתגית. htmlspecialchars() מבצעת לו escape ו-nl2br() הופכת את ירידות השורה לתגיות <br>. הריצו את זה והסתכלו בלשונית 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>

הסירו את htmlspecialchars() והריצו שוב: הדף מסתיים עכשיו ב-"v1.2: Fixed", כי הדפדפן קורא את <title> כתגית אמיתית ובולע את כל מה שאחריה ככותרת הדף. העמוד htmlspecialchars() מסביר למה זה חשוב לכל דבר שמשתמש יכול לכתוב.

קריאת URL עם file_get_contents()

כש-allow_url_fopen מופעל (ברירת המחדל ב-php.ini), file_get_contents() קוראת גם כתובות URL ומחזירה את גוף התשובה. stream context מוסיף method, כותרות, גוף ו-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
}

לניסיונות חוזרים, הפניות עם מגבלות וקודי שגיאה ברורים, cURL או ספריית לקוח HTTP כמו Guzzle הם הכלי הטוב יותר.

file_get_contents מול file() מול fopen()

הפונקציות של קריאה אחת פותחות, קוראות או כותבות, וסוגרות את הקובץ בשבילכם, ולכן הן ברירת המחדל הנכונה. פנו ל-fopen() כשהקובץ גדול מכדי להחזיק בזיכרון או כשאתם צריכים להשאיר אותו פתוח בין פעולות.