class UploadedFile
Same name in this branch
- 11.1.x vendor/guzzlehttp/psr7/src/UploadedFile.php \GuzzleHttp\Psr7\UploadedFile
- 11.1.x vendor/symfony/psr-http-message-bridge/Factory/UploadedFile.php \Symfony\Bridge\PsrHttpMessage\Factory\UploadedFile
A file uploaded through a form.
@author Bernhard Schussek <bschussek@gmail.com> @author Florian Eckerstorfer <florian@eckerstorfer.org> @author Fabien Potencier <fabien@symfony.com>
Hierarchy
- class \Symfony\Component\HttpFoundation\File\File extends \Symfony\Component\HttpFoundation\File\SplFileInfo
- class \Symfony\Component\HttpFoundation\File\UploadedFile extends \Symfony\Component\HttpFoundation\File\File
Expanded class hierarchy of UploadedFile
8 files declare their use of UploadedFile
- FileBag.php in vendor/
symfony/ http-foundation/ FileBag.php - FileValidator.php in vendor/
symfony/ validator/ Constraints/ FileValidator.php - FormUploadedFile.php in core/
modules/ file/ src/ Upload/ FormUploadedFile.php - HttpKernelBrowser.php in vendor/
symfony/ http-kernel/ HttpKernelBrowser.php - PsrHttpFactory.php in vendor/
symfony/ psr-http-message-bridge/ Factory/ PsrHttpFactory.php
File
-
vendor/
symfony/ http-foundation/ File/ UploadedFile.php, line 32
Namespace
Symfony\Component\HttpFoundation\FileView source
class UploadedFile extends File {
private string $originalName;
private string $mimeType;
private int $error;
private string $originalPath;
/**
* 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.
*
* @param string $path The full temporary path to the file
* @param string $originalName The original file name of the uploaded file
* @param string|null $mimeType The type of the file as provided by PHP; null defaults to application/octet-stream
* @param int|null $error The error constant of the upload (one of PHP's UPLOAD_ERR_XXX constants); null defaults to UPLOAD_ERR_OK
* @param bool $test Whether the test mode is active
* Local files are used in test mode hence the code should not enforce HTTP uploads
*
* @throws FileException If file_uploads is disabled
* @throws FileNotFoundException If the file does not exist
*/
public function __construct(string $path, string $originalName, ?string $mimeType = null, ?int $error = null, bool $test = false) {
$this->originalName = $this->getName($originalName);
$this->originalPath = strtr($originalName, '\\', '/');
$this->mimeType = $mimeType ?: 'application/octet-stream';
$this->error = $error ?: \UPLOAD_ERR_OK;
parent::__construct($path, \UPLOAD_ERR_OK === $this->error);
}
/**
* Returns the original file name.
*
* It is extracted from the request from which the file has been uploaded.
* This should not be considered as a safe value to use for a file name on your servers.
*/
public function getClientOriginalName() : string {
return $this->originalName;
}
/**
* Returns the original file extension.
*
* It is extracted from the original file name that was uploaded.
* This should not be considered as a safe value to use for a file name on your servers.
*/
public function getClientOriginalExtension() : string {
return pathinfo($this->originalName, \PATHINFO_EXTENSION);
}
/**
* Returns the original file full path.
*
* It is extracted from the request from which the file has been uploaded.
* This should not be considered as a safe value to use for a file name/path on your servers.
*
* If this file was uploaded with the "webkitdirectory" upload directive, this will contain
* the path of the file relative to the uploaded root directory. Otherwise this will be identical
* to getClientOriginalName().
*/
public function getClientOriginalPath() : string {
return $this->originalPath;
}
/**
* 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).
*
* @see getMimeType()
*/
public function getClientMimeType() : string {
return $this->mimeType;
}
/**
* 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).
*
* @see guessExtension()
* @see getClientMimeType()
*/
public function guessClientExtension() : ?string {
if (!class_exists(MimeTypes::class)) {
throw new \LogicException('You cannot guess the extension as the Mime component is not installed. Try running "composer require symfony/mime".');
}
return MimeTypes::getDefault()->getExtensions($this->getClientMimeType())[0] ?? null;
}
/**
* 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.
*/
public function getError() : int {
return $this->error;
}
/**
* Returns whether the file has been uploaded with HTTP and no error occurred.
*/
public function isValid() : bool {
$isOk = \UPLOAD_ERR_OK === $this->error;
return $this->test ? $isOk : $isOk && is_uploaded_file($this->getPathname());
}
/**
* Moves the file to a new location.
*
* @throws FileException if, for any reason, the file could not have been moved
*/
public function move(string $directory, ?string $name = null) : File {
if ($this->isValid()) {
if ($this->test) {
return parent::move($directory, $name);
}
$target = $this->getTargetFile($directory, $name);
set_error_handler(function ($type, $msg) use (&$error) {
$error = $msg;
});
try {
$moved = move_uploaded_file($this->getPathname(), $target);
} finally {
restore_error_handler();
}
if (!$moved) {
throw new FileException(\sprintf('Could not move the file "%s" to "%s" (%s).', $this->getPathname(), $target, strip_tags($error)));
}
@chmod($target, 0666 & ~umask());
return $target;
}
switch ($this->error) {
case \UPLOAD_ERR_INI_SIZE:
throw new IniSizeFileException($this->getErrorMessage());
case \UPLOAD_ERR_FORM_SIZE:
throw new FormSizeFileException($this->getErrorMessage());
case \UPLOAD_ERR_PARTIAL:
throw new PartialFileException($this->getErrorMessage());
case \UPLOAD_ERR_NO_FILE:
throw new NoFileException($this->getErrorMessage());
case \UPLOAD_ERR_CANT_WRITE:
throw new CannotWriteFileException($this->getErrorMessage());
case \UPLOAD_ERR_NO_TMP_DIR:
throw new NoTmpDirFileException($this->getErrorMessage());
case \UPLOAD_ERR_EXTENSION:
throw new ExtensionFileException($this->getErrorMessage());
}
throw new FileException($this->getErrorMessage());
}
/**
* Returns the maximum size of an uploaded file as configured in php.ini.
*
* @return int|float The maximum size of an uploaded file in bytes (returns float if size > PHP_INT_MAX)
*/
public static function getMaxFilesize() : int|float {
$sizePostMax = self::parseFilesize(\ini_get('post_max_size'));
$sizeUploadMax = self::parseFilesize(\ini_get('upload_max_filesize'));
return min($sizePostMax ?: \PHP_INT_MAX, $sizeUploadMax ?: \PHP_INT_MAX);
}
private static function parseFilesize(string $size) : int|float {
if ('' === $size) {
return 0;
}
$size = strtolower($size);
$max = ltrim($size, '+');
if (str_starts_with($max, '0x')) {
$max = \intval($max, 16);
}
elseif (str_starts_with($max, '0')) {
$max = \intval($max, 8);
}
else {
$max = (int) $max;
}
switch (substr($size, -1)) {
case 't':
$max *= 1024;
// no break
case 'g':
$max *= 1024;
// no break
case 'm':
$max *= 1024;
// no break
case 'k':
$max *= 1024;
}
return $max;
}
/**
* Returns an informative upload error message.
*/
public function getErrorMessage() : string {
static $errors = [
\UPLOAD_ERR_INI_SIZE => 'The file "%s" exceeds your upload_max_filesize ini directive (limit is %d KiB).',
\UPLOAD_ERR_FORM_SIZE => 'The file "%s" exceeds the upload limit defined in your form.',
\UPLOAD_ERR_PARTIAL => 'The file "%s" was only partially uploaded.',
\UPLOAD_ERR_NO_FILE => 'No file was uploaded.',
\UPLOAD_ERR_CANT_WRITE => 'The file "%s" could not be written on disk.',
\UPLOAD_ERR_NO_TMP_DIR => 'File could not be uploaded: missing temporary directory.',
\UPLOAD_ERR_EXTENSION => 'File upload was stopped by a PHP extension.',
];
$errorCode = $this->error;
$maxFilesize = \UPLOAD_ERR_INI_SIZE === $errorCode ? self::getMaxFilesize() / 1024 : 0;
$message = $errors[$errorCode] ?? 'The file "%s" was not uploaded due to an unknown error.';
return \sprintf($message, $this->getClientOriginalName(), $maxFilesize);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
File::getContent | public | function | |||
File::getMimeType | public | function | Returns the mime type of the file. | ||
File::getName | protected | function | Returns locale independent base name of the given path. | ||
File::getTargetFile | protected | function | |||
File::guessExtension | public | function | Returns the extension based on the mime type. | ||
UploadedFile::$error | private | property | |||
UploadedFile::$mimeType | private | property | |||
UploadedFile::$originalName | private | property | |||
UploadedFile::$originalPath | private | property | |||
UploadedFile::getClientMimeType | public | function | Returns the file mime type. | ||
UploadedFile::getClientOriginalExtension | public | function | Returns the original file extension. | ||
UploadedFile::getClientOriginalName | public | function | Returns the original file name. | ||
UploadedFile::getClientOriginalPath | public | function | Returns the original file full path. | ||
UploadedFile::getError | public | function | Returns the upload error. | ||
UploadedFile::getErrorMessage | public | function | Returns an informative upload error message. | ||
UploadedFile::getMaxFilesize | public static | function | Returns the maximum size of an uploaded file as configured in php.ini. | ||
UploadedFile::guessClientExtension | public | function | Returns the extension based on the client mime type. | ||
UploadedFile::isValid | public | function | Returns whether the file has been uploaded with HTTP and no error occurred. | ||
UploadedFile::move | public | function | Moves the file to a new location. | Overrides File::move | 1 |
UploadedFile::parseFilesize | private static | function | |||
UploadedFile::__construct | public | function | Accepts the information of the uploaded file as provided by the PHP global $_FILES. | Overrides File::__construct | 1 |