Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x

UploadedFile.php

Same filename in this branch
  1. 11.1.x vendor/symfony/psr-http-message-bridge/Factory/UploadedFile.php
  2. 11.1.x vendor/symfony/http-foundation/File/UploadedFile.php

Namespace

GuzzleHttp\Psr7

File

vendor/guzzlehttp/psr7/src/UploadedFile.php

View source
<?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 static 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 === self::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;
    }

}

Classes

Title Deprecated Summary
UploadedFile
RSS feed
Powered by Drupal