SDK for PHP 3.x

UploadedFile
in package
implements UploadedFileInterface

Table of Contents

Interfaces

UploadedFileInterface
Value object representing a file uploaded through an HTTP request.

Methods

__construct()  : mixed
getClientFilename()  : string|null
Retrieve the filename sent by the client.
getClientMediaType()  : string|null
Retrieve the media type sent by the client.
getError()  : int
Retrieve the error associated with the uploaded file.
getSize()  : int|null
Retrieve the file size.
getStream()  : StreamInterface
Retrieve a stream representing the uploaded file.
isMoved()  : bool
moveTo()  : void
Move the uploaded file to a new location.

Methods

__construct()

public __construct(StreamInterface|string|resource $streamOrFile, int|null $size, int $errorStatus[, string|null $clientFilename = null ][, string|null $clientMediaType = null ]) : mixed
Parameters
$streamOrFile : StreamInterface|string|resource
$size : int|null
$errorStatus : int
$clientFilename : string|null = null
$clientMediaType : string|null = null

getClientFilename()

Retrieve the filename sent by the client.

public getClientFilename() : string|null

Do not trust the value returned by this method. A client could send a malicious filename with the intention to corrupt or hack your application.

Implementations SHOULD return the value stored in the "name" key of the file in the $_FILES array.

Return values
string|null —

The filename sent by the client or null if none was provided.

getClientMediaType()

Retrieve the media type sent by the client.

public getClientMediaType() : string|null

Do not trust the value returned by this method. A client could send a malicious media type with the intention to corrupt or hack your application.

Implementations SHOULD return the value stored in the "type" key of the file in the $_FILES array.

Return values
string|null —

The media type sent by the client or null if none was provided.

getError()

Retrieve the error associated with the uploaded file.

public getError() : int

The return value MUST be one of PHP's UPLOAD_ERR_XXX constants.

If the file was uploaded successfully, this method MUST return UPLOAD_ERR_OK.

Implementations SHOULD return the value stored in the "error" key of the file in the $_FILES array.

Return values
int —

One of PHP's UPLOAD_ERR_XXX constants.

getSize()

Retrieve the file size.

public getSize() : int|null

Implementations SHOULD return the value stored in the "size" key of the file in the $_FILES array if available, as PHP calculates this based on the actual size transmitted.

Return values
int|null —

The file size in bytes or null if unknown.

getStream()

Retrieve a stream representing the uploaded file.

public getStream() : StreamInterface

This method MUST return a StreamInterface instance, representing the uploaded file. The purpose of this method is to allow utilizing native PHP stream functionality to manipulate the file upload, such as stream_copy_to_stream() (though the result will need to be decorated in a native PHP stream wrapper to work with such functions).

If the moveTo() method has been called previously, this method MUST raise an exception.

Return values
StreamInterface —

Stream representation of the uploaded file.

isMoved()

public isMoved() : bool
Return values
bool

moveTo()

Move the uploaded file to a new location.

public moveTo(mixed $targetPath) : void

Use this method as an alternative to move_uploaded_file(). This method is guaranteed to work in both SAPI and non-SAPI environments. Implementations must determine which environment they are in, and use the appropriate method (move_uploaded_file(), rename(), or a stream operation) to perform the operation.

$targetPath may be an absolute path, or a relative path. If it is a relative path, resolution should be the same as used by PHP's rename() function.

The original file or stream MUST be removed on completion.

If this method is called more than once, any subsequent calls MUST raise an exception.

When used in an SAPI environment where $_FILES is populated, when writing files via moveTo(), is_uploaded_file() and move_uploaded_file() SHOULD be used to ensure permissions and upload status are verified correctly.

If you wish to move to a stream, use getStream(), as SAPI operations cannot guarantee writing to stream destinations.

Parameters
$targetPath : mixed

Path to which to move the uploaded file.

On this page