Menu

## UploadedFileInterface
in

UploadedFileInterface.php : 12

Value object representing a file uploaded through an HTTP request.

Instances of this interface are considered immutable; all methods that might change state MUST be implemented such that they retain the internal state of the current instance and return an instance that contains the changed state.

### Table of Contents

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.
moveTo() : mixed
  Move the uploaded file to a new location.

### Methods

#### getClientFilename()

UploadedFileInterface.php : 113

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.

    was provided.

##### Return values

string|null —

The filename sent by the client or null if none

#### getClientMediaType()

UploadedFileInterface.php : 129

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.

    was provided.

##### Return values

string|null —

The media type sent by the client or null if none

#### getError()

UploadedFileInterface.php : 97

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.

##### Tags

see
  http://php.net/manual/en/features.file-upload.errors.php

##### Return values

int —

one of PHP's UPLOAD_ERR_XXX constants

#### getSize()

UploadedFileInterface.php : 80

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()

UploadedFileInterface.php : 32

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.

    created.

##### Tags

throws
  RuntimeException

  in cases when no stream is available or can be

##### Return values

StreamInterface —

stream representation of the uploaded file

#### moveTo()

UploadedFileInterface.php : 69

Move the uploaded file to a new location.

`public moveTo(string $targetPath) : mixed`

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.

    the second or subsequent call to the method.

##### Parameters

$targetPath : string

  path to which to move the uploaded file

##### Tags

see
  http://php.net/is_uploaded_file
see
  http://php.net/move_uploaded_file
throws
  InvalidArgumentException

  if the $path specified is invalid

throws
  RuntimeException

  on any error during the move operation, or on

##### Return values

mixed —

## Search results