Download the PHP package moudarir/downloader without Composer

Downloader

A lightweight and modern PHP library for streaming files and in-memory data with full support for HTTP conditional requests and byte range requests.

Features

• PHP 8.4+
• File downloads
• In-memory data downloads
• Bandwidth Rate Limiting
• HTTP Range Requests (RFC 9110)
• Multipart byte ranges
• Mandatory ETag generation
• Last-Modified support
• Conditional requests
• HEAD requests
• X-Sendfile support
• X-Accel-Redirect support
• UTF-8 filenames (RFC 6266)

Requirements

• PHP 8.4+;
• fileinfo extension for MIME type detection;
• zip extension for MIME type detection;
• (optional) mod_xsendfile Apache module to download files with ResponseAction::X_SEND_FILE method.

Installation

Usage

$mime accepts:

• null to automatically detect the MIME type from the file contents.
• Or, a MimeType enum.

Download a file

Download with a custom filename

Inline response

Partial content / Range requests

ResponseAction::PARTIAL enables HTTP Range request handling, including:

• full responses when no valid Range request is processed;
• single-range responses;
• multipart byte-range responses;
• unsatisfiable ranges (416 Range Not Satisfiable).

For browser-based media playback, use ResponseAction::PARTIAL together with inline().

Download from data

Server-side file delivery

For files, the response can be delegated to the web server using X-Sendfile or X-Accel-Redirect.

Apache – X-Sendfile

Nginx – X-Accel-Redirect

X-Accel-Redirect uses an internal URI configured for the web server. It is not required to be the physical filesystem path.

Server-side response actions are only available for file resources.

Download configuration

Download behavior can be customized through DownloadConfig.

The configuration options are:

Invalid configuration values throw a DownloadException.

Response actions

Download::fromFile() and Download::fromData() accept a ResponseAction to explicitly define the response mode.

Available actions:

The resulting DownloadResponse must always be sent explicitly:

Response metadata

Download::fromFile() and Download::fromData() return a DownloadResponse instance.

Response metadata can be inspected before sending the response through DownloadResponse::metadata():

Available metadata includes:

• resource information such as filepath, filename, filesize, MIME type and Last-Modified;
• Content-Length and Content-Type;
• the selected ResponseAction;
• ETag value and weak/strong state;
• Range information, including single and multipart ranges.
• statusCode() returns a StatusCode enum.

ETag

ETag generation is mandatory.

The library automatically generates an ETag for every supported resource and uses it for HTTP conditional requests.

Available strategies:

• ETagStrategy::MTIME
• ETagStrategy::INODE
• ETagStrategy::MD5
• ETagStrategy::SHA256
• ETagStrategy::SHA512

A strategy can optionally be selected when creating a download:

If no strategy is specified, the library automatically selects the first strategy supported by the resource.

The selected strategy must be supported by the resource. Otherwise, the library throws a DownloadException exception.

HTTP Features

The library automatically supports:

• ETag
• Last-Modified
• If-Match
• If-None-Match
• If-Modified-Since
• If-Unmodified-Since
• Range
• If-Range
• HEAD

Conditional request evaluation follows the precedence defined by RFC 9110.

If-Range supports both strong ETag comparison and HTTP-date comparison.

HTTP-date parsing supports the HTTP-date formats defined by RFC 9110.

HTTP Responses

The library supports the following response status codes:

• StatusCode::OK (200 OK)
• StatusCode::PARTIAL_CONTENT (206 Partial Content)
• StatusCode::NOT_MODIFIED (304 Not Modified)
• StatusCode::PRECONDITION_FAILED (412 Precondition Failed)
• StatusCode::RANGE_NOT_SATISFIABLE (416 Range Not Satisfiable)

412 Precondition Failed responses do not include representation headers such as Content-Type, Content-Disposition or the representation Content-Length.

License

MIT