class UploadedFile extends File

A file uploaded through a form.

Methods

__construct(string $path, string $originalName, string|null $mimeType = null, int|null $size = null, int|null $error = null, bool $test = false)

Accepts the information of the uploaded file as provided by the PHP global $_FILES.

string|null
guessExtension()

Returns the extension based on the mime type.

from File
string|null
getMimeType()

Returns the mime type of the file.

from File
move(string $directory, string $name = null)

Moves the file to a new location.

getTargetFile($directory, $name = null)

No description

from File
string
getName(string $name)

Returns locale independent base name of the given path.

from File
string|null
getClientOriginalName()

Returns the original file name.

string
getClientOriginalExtension()

Returns the original file extension.

string|null
getClientMimeType()

Returns the file mime type.

string|null
guessClientExtension()

Returns the extension based on the client mime type.

int|null
getClientSize()

Returns the file size.

int
getError()

Returns the upload error.

bool
isValid()

Returns whether the file was uploaded successfully.

static int
getMaxFilesize()

Returns the maximum size of an uploaded file as configured in php.ini.

string
getErrorMessage()

Returns an informative upload error message.

Details

at line 58
__construct(string $path, string $originalName, string|null $mimeType = null, int|null $size = null, int|null $error = null, bool $test = false)

Accepts the information of the uploaded file as provided by the PHP global $_FILES.

The file object is only created when the uploaded file is valid (i.e. when the isValid() method returns true). Otherwise the only methods that could be called on an UploadedFile instance are:

  • getClientOriginalName,
  • getClientMimeType,
  • isValid,
  • getError.

Calling any other method on an non-valid instance will cause an unpredictable result.

Parameters

string $path The path to the file
string $originalName The original file name of the uploaded file
string|null $mimeType The type of the file as provided by PHP; null defaults to application/octet-stream
int|null $size The file size provided by the uploader
int|null $error The error constant of the upload (one of PHP's UPLOAD_ERR_XXX constants); null defaults to UPLOAD_ERR_OK
bool $test Whether the test mode is active Local files are used in test mode hence the code should not enforce HTTP uploads

Exceptions

FileException If file_uploads is disabled
FileNotFoundException If the file does not exist

in File at line 56
string|null guessExtension()

Returns the extension based on the mime type.

If the mime type is unknown, returns null.

This method uses the mime type as guessed by getMimeType() to guess the file extension.

Return Value

string|null The guessed extension or null if it cannot be guessed

See also

ExtensionGuesser
getMimeType()

in File at line 75
string|null getMimeType()

Returns the mime type of the file.

The mime type is guessed using a MimeTypeGuesser instance, which uses finfo(), mime_content_type() and the system binary "file" (in this order), depending on which of those are available.

Return Value

string|null The guessed mime type (e.g. "application/pdf")

See also

MimeTypeGuesser

at line 186
File move(string $directory, string $name = null)

Moves the file to a new location.

Parameters

string $directory The destination folder
string $name The new file name

Return Value

File A File object representing the new file

Exceptions

FileException if, for any reason, the file could not have been moved

in File at line 108
protected getTargetFile($directory, $name = null)

Parameters

$directory
$name

in File at line 130
protected string getName(string $name)

Returns locale independent base name of the given path.

Parameters

string $name The new file name

Return Value

string containing

at line 77
string|null getClientOriginalName()

Returns the original file name.

It is extracted from the request from which the file has been uploaded. Then it should not be considered as a safe value.

Return Value

string|null The original name

at line 90
string getClientOriginalExtension()

Returns the original file extension.

It is extracted from the original file name that was uploaded. Then it should not be considered as a safe value.

Return Value

string The extension

at line 108
string|null getClientMimeType()

Returns the file mime type.

The client mime type is extracted from the request from which the file was uploaded, so it should not be considered as a safe value.

For a trusted mime type, use getMimeType() instead (which guesses the mime type based on the file content).

Return Value

string|null The mime type

See also

getMimeType()

at line 130
string|null guessClientExtension()

Returns the extension based on the client mime type.

If the mime type is unknown, returns null.

This method uses the mime type as guessed by getClientMimeType() to guess the file extension. As such, the extension returned by this method cannot be trusted.

For a trusted extension, use guessExtension() instead (which guesses the extension based on the guessed mime type for the file).

Return Value

string|null The guessed extension or null if it cannot be guessed

See also

guessExtension()
getClientMimeType()

at line 146
int|null getClientSize()

Returns the file size.

It is extracted from the request from which the file has been uploaded. Then it should not be considered as a safe value.

Return Value

int|null The file size

at line 159
int getError()

Returns the upload error.

If the upload was successful, the constant UPLOAD_ERR_OK is returned. Otherwise one of the other UPLOAD_ERR_XXX constants is returned.

Return Value

int The upload error

at line 169
bool isValid()

Returns whether the file was uploaded successfully.

Return Value

bool True if the file has been uploaded with HTTP and no error occurred

at line 215
static int getMaxFilesize()

Returns the maximum size of an uploaded file as configured in php.ini.

Return Value

int The maximum size of an uploaded file in bytes

at line 250
string getErrorMessage()

Returns an informative upload error message.

Return Value

string The error message regarding the specified error code