interface FileUploadHandlerInterface

Handles validating and creating file entities from file uploads.

Hierarchy

Expanded class hierarchy of FileUploadHandlerInterface

All classes that implement FileUploadHandlerInterface

4 files declare their use of FileUploadHandlerInterface
CKEditor5ImageController.php in core/modules/ckeditor5/src/Controller/CKEditor5ImageController.php
CKEditor5ImageControllerTest.php in core/modules/ckeditor5/tests/src/Unit/CKEditor5ImageControllerTest.php
file.module in core/modules/file/file.module
FileUpload.php in core/modules/jsonapi/src/Controller/FileUpload.php

File

core/modules/file/src/Upload/FileUploadHandlerInterface.php, line 12

Namespace

Drupal\file\Upload
View on git.drupalcode.org
View source 
interface FileUploadHandlerInterface {
  
  /**
   * Creates a file from an upload.
   *
   * @param \Drupal\file\Upload\UploadedFileInterface $uploadedFile
   *   The uploaded file object.
   * @param array $validators
   *   The validators to run against the uploaded file.
   * @param string $destination
   *   The destination directory.
   * @param \Drupal\Core\File\FileExists|int $fileExists
   *   The behavior when the destination file already exists.
   *
   * @return \Drupal\file\Upload\FileUploadResult
   *   The created file entity.
   *
   * @throws \Symfony\Component\HttpFoundation\File\Exception\FileException
   *    Thrown when a file upload error occurred and $throws is TRUE.
   * @throws \Drupal\Core\File\Exception\FileWriteException
   *    Thrown when there is an error moving the file and $throws is TRUE.
   * @throws \Drupal\Core\File\Exception\FileException
   *    Thrown when a file system error occurs and $throws is TRUE.
   * @throws \Drupal\file\Upload\FileValidationException
   *    Thrown when file validation fails and $throws is TRUE.
   * @throws \Drupal\Core\Lock\LockAcquiringException
   *   Thrown when a lock cannot be acquired.
   * @throws \ValueError
   *   Thrown if $fileExists is a legacy int and not a valid value.
   */
  public function handleFileUpload(UploadedFileInterface $uploadedFile, array $validators = [], string $destination = 'temporary://', $fileExists = FileExists::Replace) : FileUploadResult;

}

Members

Title Modifiers Object type Summary Overrides
FileUploadHandlerInterface::handleFileUpload public function Creates a file from an upload. 1

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