Stream Large Files Without Running Out of Memory

Introduction

When working with large files in PHP, it's crucial to handle them in a way that minimizes memory usage. Using the built-in functions like file_get_contents can lead to high memory consumption and potential crashes. Instead, streaming the file allows you to read and process it piece by piece.

Streaming Large Files

To stream a large file in PHP, you can use the readfile function. This function reads a file and writes it directly to the output buffer without loading the entire file into memory.

<?php
// Path to the large file
$file = 'path/to/largefile.zip';

// Set headers for streaming
header('Content-Type: application/octet-stream');
header('Content-Disposition: attachment; filename="' . basename($file) . '"');

// Stream the file
readfile($file);
?>
        

Streaming with a Custom Buffer Size

If you need more control over the streaming process, such as adjusting the buffer size, you can use a loop to read and output chunks of the file. This method allows for fine-tuning memory usage.

<?php
// Path to the large file
$file = 'path/to/largefile.zip';

// Set headers for streaming
header('Content-Type: application/octet-stream');
header('Content-Disposition: attachment; filename="' . basename($file) . '"');

// Open the file in read mode
$handle = fopen($file, "rb");

// Check if the file handle is valid
if ($handle === false) {
    die("Error opening file.");
}

// Define buffer size (e.g., 4MB)
$bufferSize = 4 * 1024 * 1024;

// Read and output the file in chunks
while (!feof($handle)) {
    echo fread($handle, $bufferSize);
    ob_flush();
    flush();
}

// Close the file handle
fclose($handle);
?>
        

Conclusion

Streaming large files in PHP is an effective way to manage memory usage. By using the readfile function or reading and outputting chunks of the file, you can handle even the largest files without running out of memory. This approach ensures that your application remains responsive and efficient.