FormUploadedFile.php

Same filename in other branches
  1. 9 core/modules/file/src/Upload/FormUploadedFile.php
  2. 11.x core/modules/file/src/Upload/FormUploadedFile.php

Namespace

Drupal\file\Upload

File

core/modules/file/src/Upload/FormUploadedFile.php

View source
<?php

namespace Drupal\file\Upload;

use Drupal\file\Validation\Constraint\UploadedFileConstraint;
use Symfony\Component\HttpFoundation\File\UploadedFile;
use Symfony\Component\Validator\ConstraintViolationListInterface;
use Symfony\Component\Validator\Validator\ValidatorInterface;

/**
 * Provides a bridge to Symfony UploadedFile.
 */
class FormUploadedFile implements UploadedFileInterface {
    
    /**
     * The wrapped uploaded file.
     *
     * @var \Symfony\Component\HttpFoundation\File\UploadedFile
     */
    protected $uploadedFile;
    
    /**
     * Creates a new FormUploadedFile.
     *
     * @param \Symfony\Component\HttpFoundation\File\UploadedFile $uploadedFile
     *   The wrapped Symfony uploaded file.
     */
    public function __construct(UploadedFile $uploadedFile) {
        $this->uploadedFile = $uploadedFile;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getClientOriginalName() : string {
        return $this->uploadedFile
            ->getClientOriginalName();
    }
    
    /**
     * {@inheritdoc}
     */
    public function isValid() : bool {
        @trigger_error(__METHOD__ . '() is deprecated in drupal:10.3.0 and is removed from drupal:11.0.0. Use \\Drupal\\file\\Validation\\UploadedFileValidatorInterface::validate() instead. See https://www.drupal.org/node/3375456', E_USER_DEPRECATED);
        return $this->uploadedFile
            ->isValid();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getErrorMessage() : string {
        @trigger_error(__METHOD__ . '() is deprecated in drupal:10.3.0 and is removed from drupal:11.0.0. Use \\Drupal\\file\\Validation\\UploadedFileValidatorInterface::validate() instead. See https://www.drupal.org/node/3375456', E_USER_DEPRECATED);
        return $this->uploadedFile
            ->getErrorMessage();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getError() : int {
        @trigger_error(__METHOD__ . '() is deprecated in drupal:10.3.0 and is removed from drupal:11.0.0. Use \\Drupal\\file\\Validation\\UploadedFileValidatorInterface::validate() instead. See https://www.drupal.org/node/3375456', E_USER_DEPRECATED);
        return $this->uploadedFile
            ->getError();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getSize() : int {
        return $this->uploadedFile
            ->getSize();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getRealPath() {
        return $this->uploadedFile
            ->getRealPath();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getPathname() : string {
        return $this->uploadedFile
            ->getPathname();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFilename() : string {
        return $this->uploadedFile
            ->getFilename();
    }
    
    /**
     * {@inheritdoc}
     */
    public function validate(ValidatorInterface $validator, array $options = []) : ConstraintViolationListInterface {
        $constraint = new UploadedFileConstraint($options);
        return $validator->validate($this->uploadedFile, $constraint);
    }

}

Classes

Title Deprecated Summary
FormUploadedFile Provides a bridge to Symfony UploadedFile.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.