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 |
| File | move(string $directory, string $name = null) Moves the file to a new location. | |
| 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
__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.
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.
string|null getMimeType()
Returns the mime type of the file.
The mime type is guessed using a MimeTypeGuesser instance, which uses finfo(), mimecontenttype() and the system binary "file" (in this order), depending on which of those are available.
File move(string $directory, string $name = null)
Moves the file to a new location.
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.
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.
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).
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).
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.
int getError()
Returns the upload error.
If the upload was successful, the constant UPLOADERROK is returned. Otherwise one of the other UPLOADERRXXX constants is returned.
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.
Please login to continue.