StreamFile Class Reference

Functions related to the output of file content. More...

Static Public Member Functions
static	contentTypeFromPath ( $filename, $safe=true)
	Determine the file type of a file based on the path. More...
static	parseRange ( $range, $size)
	Convert a Range header value to an absolute (start, end) range tuple. More...
static	send404Message ( $fname, $flags=0)
	Send out a standard 404 message for a file. More...
static	stream ( $fname, $headers=[], $sendErrors=true, $optHeaders=[], $flags=0)
	Stream a file to the browser, adding all the headings and fun stuff. More...

Public Attributes
const	STREAM_ALLOW_OB = HTTPFileStreamer::STREAM_ALLOW_OB
const	STREAM_HEADLESS = HTTPFileStreamer::STREAM_HEADLESS

Detailed Description

Functions related to the output of file content.

Definition at line 26 of file StreamFile.php.

Member Function Documentation

contentTypeFromPath()

static StreamFile::contentTypeFromPath (   $filename,   $safe = true  )

static

Determine the file type of a file based on the path.

Parameters

string	$filename	Storage path or file system path
bool	$safe	Whether to do retroactive upload blacklist checks

Returns

null|string

Definition at line 93 of file StreamFile.php.

References $ext, $type, $wgCheckFileExtensions, $wgFileBlacklist, $wgFileExtensions, $wgMimeTypeBlacklist, $wgStrictFileExtensions, $wgTrivialMimeDetection, $wgVerifyMimeType, MediaWiki\MediaWikiServices\getInstance(), and list.

Referenced by FileBackendDBRepoWrapper\streamFile().

parseRange()

static StreamFile::parseRange (   $range,   $size  )

static

Convert a Range header value to an absolute (start, end) range tuple.

Parameters

string	$range	Range header value
int	$size	File size

Returns

array|string Returns error string on failure (start, end, length)

Since

1.24

Definition at line 82 of file StreamFile.php.

References HTTPFileStreamer\parseRange().

send404Message()

static StreamFile::send404Message (   $fname,   $flags = 0  )

static

Send out a standard 404 message for a file.

Parameters

string	$fname	Full name and path of the file to stream
int	$flags	Bitfield of STREAM_* constants

Since

1.24

Definition at line 70 of file StreamFile.php.

References $fname, and HTTPFileStreamer\send404Message().

Referenced by SwiftFileBackend\doStreamFile().

stream()

static StreamFile::stream (   $fname,   $headers = [],   $sendErrors = true,   $optHeaders = [],   $flags = 0  )

static

Stream a file to the browser, adding all the headings and fun stuff.

Headers sent include: Content-type, Content-Length, Last-Modified, and Content-Disposition.

Parameters

string	$fname	Full name and path of the file to stream
array	$headers	Any additional headers to send if the file exists
bool	$sendErrors	Send error messages if errors occur (like 404)
array	$optHeaders	HTTP request header map (e.g. "range") (use lowercase keys)
int	$flags	Bitfield of STREAM_* constants

Exceptions

MWException

Returns

bool Success

Definition at line 45 of file StreamFile.php.

References $fname, and FileBackend\isStoragePath().

Referenced by MediaTransformOutput\streamFileWithStatus().

Member Data Documentation

STREAM_ALLOW_OB

const StreamFile::STREAM_ALLOW_OB = HTTPFileStreamer::STREAM_ALLOW_OB

Definition at line 30 of file StreamFile.php.

STREAM_HEADLESS

const StreamFile::STREAM_HEADLESS = HTTPFileStreamer::STREAM_HEADLESS

Definition at line 28 of file StreamFile.php.

Referenced by SwiftFileBackend\doStreamFile().

---

The documentation for this class was generated from the following file:

• includes/StreamFile.php