PHP file_get_contents(): Dosyayı Bir Dizgeye Okuma

file_get_contents('notes.txt') bütün dosyayı okur ve tek bir dizge olarak döndürür. Dosya okunamazsa false döndürür. Yazmak için dosyayı oluşturan veya içindekini değiştiren file_put_contents('notes.txt', $text) kullanın.

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

Çıktı:

Buy milk
Call Ada
Write docs
29 bytes
3 lines

Blok üzerinde çalışacak bir dosyası olsun diye önce notes.txt dosyasını yazar, sonra geri okur. 'notes.txt' gibi bir yol geçerli çalışma dizinine göredir; bir web uygulamasında yolu betiğin kendi klasöründen __DIR__ . '/notes.txt' ile oluşturun.

file_put_contents() ile yazma ve ekleme

file_put_contents() yazılan bayt sayısını, başarısızlıkta false döndürür. Varsayılan olarak dosyanın üzerine yazar. FILE_APPEND bayrağı bunun yerine sona ekler, basit loglar bu şekilde çalışır; LOCK_EX ise iki isteğin aynı anda yazmasını önler:

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

Çıktı:

Wrote 8 bytes
started
step 1 done
step 2 done

replaced

abc
5 bytes

Bir diziyi saklayıp dizi olarak geri almak için onu json_encode() ile JSON olarak yazın ve json_decode() ile okuyun.

file() ile bir dosyayı satır satır okuma

file() bir dosyayı her elemanı bir satır olan bir diziye okur. FILE_IGNORE_NEW_LINES vermedikçe her satır sonundaki yeni satır karakterini korur; FILE_SKIP_EMPTY_LINES ise boş satırları atar (yalnızca FILE_IGNORE_NEW_LINES ile birlikte çalışır):

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

Çıktı:

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

file() ve file_get_contents() dosyanın tamamını belleğe yükler. Yapılandırma dosyaları ve birkaç megabaytlık loglar için bu sorun değildir. Yüzlerce megabaytlık bir dosya için onu bunun yerine fopen() ve fgets() ile her seferinde bir satır okuyun.

Okumadan önce dosyanın var olup olmadığını kontrol etme

Dosya eksikse file_get_contents() false döndürür ve PHP bir uyarı yazdırır:

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

Önce is_file() (var olan ve dizin olmayan bir dosya) veya file_exists() (bir dosya veya dizin) ile kontrol edin ve sonucu her zaman === false ile karşılaştırın, çünkü boş bir dosya da falsy olan "" döndürür:

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

Çıktı:

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

Uyarıyı @file_get_contents() ile gizlemeyin. Önce kontrol etmek ya da false durumunu ele almak, başka bir şey yanlış gittiğinde hatayı görünür tutar.

Bir dosyanın bir kısmını okuma

Dördüncü ve beşinci argümanlar başlanacak bayt konumu ve okunacak bayt sayısıdır. Negatif bir konum dosyanın sonundan sayar. Adlandırılmış argümanlar aradaki iki argümanı atlamanızı sağlar:

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

Çıktı:

HEADER
line 2
last line

Konumlar karakterleri değil baytları sayar. UTF-8'de bir Japonca karakter 3 bayttır, bu yüzden birinin ortasına denk gelen bir konum onu ikiye böler. Karakterlerle çalışmak için dizgenin tamamını okuyun ve mb_substr() kullanın.

Bir metin dosyasını bir web sayfasında gösterme

Dosya içerikleri metindir ve HTML'e yazdırılan metin kaçışlanmalıdır, yoksa dosyadaki bir < bir etikete dönüşür. htmlspecialchars() onu kaçışlar ve nl2br() yeni satırları <br> etiketlerine çevirir. Çalıştırın ve Page sekmesine bakın:

<?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() kısmını kaldırın ve tekrar çalıştırın: sayfa artık "v1.2: Fixed" noktasında biter, çünkü tarayıcı <title> ifadesini gerçek bir etiket olarak okur ve ardından gelen her şeyi sayfa başlığı olarak yutar. htmlspecialchars() sayfası bunun bir kullanıcının yazabildiği her şey için neden önemli olduğunu anlatır.

file_get_contents() ile bir URL okuma

allow_url_fopen etkinken (php.ini içinde varsayılan), file_get_contents() URL'leri de okur ve yanıt gövdesini döndürür. Bir akış bağlamı bir yöntem, başlıklar, bir gövde ve bir zaman aşımı ekler:

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

Yeniden denemeler, sınırlı yönlendirmeler ve net hata kodları için cURL veya Guzzle gibi bir HTTP istemci kütüphanesi daha iyi araçtır.

file_get_contents, file() ve fopen() karşılaştırması

Tek çağrılık fonksiyonlar dosyayı sizin yerinize açar, okur veya yazar ve kapatır, bu yüzden doğru varsayılan onlardır. Dosya bellekte tutulamayacak kadar büyük olduğunda ya da işlemler arasında açık tutmanız gerektiğinde fopen() kullanın.