1. class
  2. Nette
  3. \
  4. Http
  5. \
  6. FileUpload

FileUpload

final class FileUpload

Provides access to individual files that have been uploaded by a client.

Constants

deprecated IMAGE_MIME_TYPES

Properties

string read-only $name
string read-only $sanitizedName
string read-only $untrustedFullPath
string|null read-only $contentType
int read-only $size
string read-only $temporaryFile
int read-only $error
bool read-only $ok
string|null read-only $contents

Methods

__construct(array|null $value)

No description

string
getName() deprecated

No description

string
getUntrustedName()

Returns the original file name as submitted by the browser. Do not trust the value returned by this method.

string
getSanitizedName()

Returns the sanitized file name. The resulting name contains only ASCII characters [a-zA-Z0-9.-].

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.

string|null
getContentType()

Detects the MIME content type of the uploaded file based on its signature. Requires PHP extension fileinfo.

string|null
getSuggestedExtension()

Returns the appropriate file extension (without the period) corresponding to the detected MIME type. Requires the PHP extension fileinfo.

int
getSize()

Returns the size of the uploaded file in bytes.

string
getTemporaryFile()

Returns the path of the temporary location of the uploaded file.

string
__toString()

Returns the path of the temporary location of the uploaded file.

int
getError()

Returns the error code. It is be one of UPLOAD_ERR_XXX constants.

bool
isOk()

Returns true if the file was uploaded successfully.

bool
hasFile()

Returns true if the user has uploaded a file.

FileUpload
move(string $dest)

Moves an uploaded file to a new location. If the destination file already exists, it will be overwritten.

bool
isImage()

Returns true if the uploaded file is an image and the format is supported by PHP, so it can be loaded using the toImage() method.

Image
toImage()

Converts uploaded image to Nette\Utils\Image object.

array|null
getImageSize()

Returns a pair of [width, height] with dimensions of the uploaded image.

string|null
getImageFileExtension() deprecated

Returns image file extension based on detected content type (without dot).

string|null
getContents()

Returns the contents of the uploaded file. If the upload was not successful, it returns null.

Details

at line 45
__construct(array|null $value)

No description

Parameters

array|null $value

at line 65
string getName() deprecated

deprecated use getUntrustedName()

No description

Return Value

string

at line 76
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.

Return Value

string

at line 87
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 JPEG, PNG, GIF, or WebP image, it returns the correct file extension. Do not blindly trust the value returned by this method.

Return Value

string

at line 109
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.

The full path is only available in PHP 8.1 and above. In previous versions, this method returns the file name.

Return Value

string

at line 119
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.

Return Value

string|null

at line 132
string|null getSuggestedExtension()

Returns the appropriate file extension (without the period) corresponding to the detected MIME type. Requires the PHP extension fileinfo.

Return Value

string|null

at line 153
int getSize()

Returns the size of the uploaded file in bytes.

Return Value

int

at line 162
string getTemporaryFile()

Returns the path of the temporary location of the uploaded file.

Return Value

string

at line 171
string __toString()

Returns the path of the temporary location of the uploaded file.

Return Value

string

at line 181
int getError()

Returns the error code. It is be one of UPLOAD_ERR_XXX constants.

Return Value

int

See also

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

at line 190
bool isOk()

Returns true if the file was uploaded successfully.

Return Value

bool

at line 199
bool hasFile()

Returns true if the user has uploaded a file.

Return Value

bool

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.

Parameters

string $dest

Return Value

FileUpload

at line 230
bool isImage()

Returns true if the uploaded file is an image and the format is supported by PHP, so it can be loaded using the toImage() method.

Detection is based on its signature, the integrity of the file is not checked. Requires PHP extensions fileinfo & gd.

Return Value

bool

at line 241
Image toImage()

Converts uploaded image to Nette\Utils\Image object.

Return Value

Image

Exceptions

ImageException

at line 250
array|null getImageSize()

Returns a pair of [width, height] with dimensions of the uploaded image.

Return Value

array|null

at line 262
string|null getImageFileExtension() deprecated

deprecated use getSuggestedExtension()

Returns image file extension based on detected content type (without dot).

Return Value

string|null

at line 271
string|null getContents()

Returns the contents of the uploaded file. If the upload was not successful, it returns null.

Return Value

string|null

Traits

SmartObject