FileUpload
final class FileUpload
Provides access to individual files that have been uploaded by a client.
Constants
| IMAGE_MIME_TYPES |
|
Properties
| string read-only | $name | ||
| string read-only | $sanitizedName | ||
| string read-only | $untrustedFullPath | ||
| ?string read-only | $contentType | ||
| int read-only | $size | ||
| string read-only | $temporaryFile | ||
| int read-only | $error | ||
| bool read-only | $ok | ||
| ?string read-only | $contents |
Methods
No description
No description
Returns the original file name as submitted by the browser. Do not trust the value returned by this method.
Returns the sanitized file name. The resulting name contains only ASCII characters [a-zA-Z0-9.-].
Returns the original full path as submitted by the browser during directory upload. Do not trust the value returned by this method. A client could send a malicious directory structure with the intention to corrupt or hack your application.
Detects the MIME content type of the uploaded file based on its signature. Requires PHP extension fileinfo.
Returns the appropriate file extension (without the period) corresponding to the detected MIME type. Requires the PHP extension fileinfo.
Returns the size of the uploaded file in bytes.
Returns the path of the temporary location of the uploaded file.
Returns the path of the temporary location of the uploaded file.
Returns the upload error code (one of the UPLOAD_ERR_XXX constants).
Returns true if the file was uploaded successfully.
Returns true if the user has uploaded a file.
Moves an uploaded file to a new location. If the destination file already exists, it will be overwritten.
Checks whether the uploaded file is an image in a format supported by PHP (detectable via fileinfo, loadable via GD).
Converts uploaded image to Nette\Utils\Image object.
Returns the [width, height] dimensions of the uploaded image, or null if it is not a valid image.
Returns image file extension based on detected content type (without dot).
Returns the contents of the uploaded file. If the upload was not successful, it returns null.
Details
at line 45
__construct(array|string|null $value)
No description
at line 65
string
getName()
No description
at line 77
string
getUntrustedName()
Returns the original file name as submitted by the browser. 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.
at line 88
string
getSanitizedName()
Returns the sanitized file name. The resulting name contains only ASCII characters [a-zA-Z0-9.-].
If the name does not contain such characters, it returns 'unknown'. If the file is an image supported by PHP, it returns the correct file extension. Do not blindly trust the value returned by this method.
at line 108
string
getUntrustedFullPath()
Returns the original full path as submitted by the browser during directory upload. Do not trust the value returned by this method. A client could send a malicious directory structure with the intention to corrupt or hack your application.
at line 118
string|null
getContentType()
Detects the MIME content type of the uploaded file based on its signature. Requires PHP extension fileinfo.
If the upload was not successful or the detection failed, it returns null.
at line 131
string|null
getSuggestedExtension()
Returns the appropriate file extension (without the period) corresponding to the detected MIME type. Requires the PHP extension fileinfo.
at line 153
int
getSize()
Returns the size of the uploaded file in bytes.
at line 162
string
getTemporaryFile()
Returns the path of the temporary location of the uploaded file.
at line 171
string
__toString()
Returns the path of the temporary location of the uploaded file.
at line 181
int
getError()
Returns the upload error code (one of the UPLOAD_ERR_XXX constants).
at line 190
bool
isOk()
Returns true if the file was uploaded successfully.
at line 199
bool
hasFile()
Returns true if the user has uploaded a file.
at line 208
FileUpload
move(string $dest)
Moves an uploaded file to a new location. If the destination file already exists, it will be overwritten.
at line 230
bool
isImage()
Checks whether the uploaded file is an image in a format supported by PHP (detectable via fileinfo, loadable via GD).
Detection is based on file signature; full integrity is not verified.
at line 241
Image
toImage()
Converts uploaded image to Nette\Utils\Image object.
at line 251
array|null
getImageSize()
Returns the [width, height] dimensions of the uploaded image, or null if it is not a valid image.
at line 263
string|null
getImageFileExtension()
deprecated
deprecated
Returns image file extension based on detected content type (without dot).
at line 272
string|null
getContents()
Returns the contents of the uploaded file. If the upload was not successful, it returns null.