<?php declare(strict_types=1); namespace GuzzleHttp\Psr7; use InvalidArgumentException; use Psr\Http\Message\StreamInterface; use Psr\Http\Message\UploadedFileInterface; use RuntimeException; class UploadedFile implements UploadedFileInterface { private const ERRORS = [ UPLOAD_ERR_OK, UPLOAD_ERR_INI_SIZE, UPLOAD_ERR_FORM_SIZE, UPLOAD_ERR_PARTIAL, UPLOAD_ERR_NO_FILE, UPLOAD_ERR_NO_TMP_DIR, UPLOAD_ERR_CANT_WRITE, UPLOAD_ERR_EXTENSION, ]; /** * @var string|null */ private $clientFilename; /** * @var string|null */ private $clientMediaType; /** * @var int */ private $error; /** * @var string|null */ private $file; /** * @var bool */ private $moved = false; /** * @var int|null */ private $size; /** * @var StreamInterface|null */ private $stream; /** * @param StreamInterface|string|resource $streamOrFile */ public function __construct( $streamOrFile, ?int $size, int $errorStatus, string $clientFilename = null, string $clientMediaType = null ) { $this->setError($errorStatus); $this->size = $size; $this->clientFilename = $clientFilename; $this->clientMediaType = $clientMediaType; if ($this->isOk()) { $this->setStreamOrFile($streamOrFile); } } /** * Depending on the value set file or stream variable * * @param StreamInterface|string|resource $streamOrFile * * @throws InvalidArgumentException */ private function setStreamOrFile($streamOrFile): void { if (is_string($streamOrFile)) { $this->file = $streamOrFile; } elseif (is_resource($streamOrFile)) { $this->stream = new Stream($streamOrFile); } elseif ($streamOrFile instanceof StreamInterface) { $this->stream = $streamOrFile; } else { throw new InvalidArgumentException( 'Invalid stream or file provided for UploadedFile' ); } } /** * @throws InvalidArgumentException */ private function setError(int $error): void { if (false === in_array($error, UploadedFile::ERRORS, true)) { throw new InvalidArgumentException( 'Invalid error status for UploadedFile' ); } $this->error = $error; } private function isStringNotEmpty($param): bool { return is_string($param) && false === empty($param); } /** * Return true if there is no upload error */ private function isOk(): bool { return $this->error === UPLOAD_ERR_OK; } public function isMoved(): bool { return $this->moved; } /** * @throws RuntimeException if is moved or not ok */ private function validateActive(): void { if (false === $this->isOk()) { throw new RuntimeException('Cannot retrieve stream due to upload error'); } if ($this->isMoved()) { throw new RuntimeException('Cannot retrieve stream after it has already been moved'); } } public function getStream(): StreamInterface { $this->validateActive(); if ($this->stream instanceof StreamInterface) { return $this->stream; } /** @var string $file */ $file = $this->file; return new LazyOpenStream($file, 'r+'); } public function moveTo($targetPath): void { $this->validateActive(); if (false === $this->isStringNotEmpty($targetPath)) { throw new InvalidArgumentException( 'Invalid path provided for move operation; must be a non-empty string' ); } if ($this->file) { $this->moved = PHP_SAPI === 'cli' ? rename($this->file, $targetPath) : move_uploaded_file($this->file, $targetPath); } else { Utils::copyToStream( $this->getStream(), new LazyOpenStream($targetPath, 'w') ); $this->moved = true; } if (false === $this->moved) { throw new RuntimeException( sprintf('Uploaded file could not be moved to %s', $targetPath) ); } } public function getSize(): ?int { return $this->size; } public function getError(): int { return $this->error; } public function getClientFilename(): ?string { return $this->clientFilename; } public function getClientMediaType(): ?string { return $this->clientMediaType; } }
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
Exception | Folder | 0755 |
|
|
AppendStream.php | File | 5.84 KB | 0644 |
|
BufferStream.php | File | 3.17 KB | 0644 |
|
CachingStream.php | File | 4.48 KB | 0644 |
|
DroppingStream.php | File | 1.17 KB | 0644 |
|
FnStream.php | File | 4.4 KB | 0644 |
|
Header.php | File | 3.84 KB | 0644 |
|
HttpFactory.php | File | 3.02 KB | 0644 |
|
InflateStream.php | File | 1.36 KB | 0644 |
|
LazyOpenStream.php | File | 1.06 KB | 0644 |
|
LimitStream.php | File | 4.2 KB | 0644 |
|
Message.php | File | 8.13 KB | 0644 |
|
MessageTrait.php | File | 7.57 KB | 0644 |
|
MimeType.php | File | 52.9 KB | 0644 |
|
MultipartStream.php | File | 4.92 KB | 0644 |
|
NoSeekStream.php | File | 524 B | 0644 |
|
PumpStream.php | File | 4.5 KB | 0644 |
|
Query.php | File | 3.57 KB | 0644 |
|
Request.php | File | 3.81 KB | 0644 |
|
Response.php | File | 4.79 KB | 0644 |
|
Rfc7230.php | File | 665 B | 0644 |
|
ServerRequest.php | File | 9.4 KB | 0644 |
|
Stream.php | File | 7.23 KB | 0644 |
|
StreamDecoratorTrait.php | File | 3.28 KB | 0644 |
|
StreamWrapper.php | File | 4.01 KB | 0644 |
|
UploadedFile.php | File | 4.75 KB | 0644 |
|
Uri.php | File | 21.36 KB | 0644 |
|
UriComparator.php | File | 1.12 KB | 0644 |
|
UriNormalizer.php | File | 8.22 KB | 0644 |
|
UriResolver.php | File | 8.36 KB | 0644 |
|
Utils.php | File | 15.2 KB | 0644 |
|