/http-send-file

PHP lib which sends a file with support for (multiple) range requests and throttle.

Primary LanguagePHPMIT LicenseMIT

HTTP send file

Sends a file with support for (multiple) range requests. It is able to throttle the download. It is quite small and simple.

This class resembles the php http_send_file from PHP pecl

See:

http://php.net/manual/en/function.http-send-file.php

Install

With composer add to your "require" section:

composer require diversen/http-send-file

Usage example:

use diversen\sendfile;
$s = new sendfile();
        
// if you don't set type - we will try to guess it
$s->contentType('application/epub+zip');
        
// if you don't set disposition (file name user agent will see)
// we will make a file name from file
$s->contentDisposition('test.epub');
        
// chunks of 40960 bytes per 0.1 secs
// if you don't set this then the values below are the defaults
// approx 409600 bytes per sec
$s->throttle(0.1, 40960);

// file
$file = '/some/dir/test.epub';

// send the file
try {
    $s->send($file);
} catch (\Exception $e) {
    echo $e->getMessage();
}

So you could just do like this:

use diversen\sendfile;
$s = new sendfile();

// file
$file = '/some/dir/test.epub';

// send the file
try {
    $s->send($file);
} catch (\Exception $e) {
    echo $e->getMessage();
}

// but check the headers if it is not
// working as expected as the guessing
// of content-type does not always work
// correctly. 

Without sending content-disposition header:

// without sending content-disposition header
// 2. param = false
try {
    $s->send($file, false);
} catch (\Exception $e) {
    echo $e->getMessage();
}

Credits

Much of the code is taken (and rewritten) from here:

http://w-shadow.com/blog/2007/08/12/how-to-force-file-download-with-php/

The process is nicely explained here:

http://www.media-division.com/the-right-way-to-handle-file-downloads-in-php/

MIT © Dennis Iversen