class UploadedFilesExtractor

Same name and namespace in other branches
  1. main core/lib/Drupal/Core/File/UploadedFilesExtractor.php \Drupal\Core\File\UploadedFilesExtractor

Helper class for getting the uploaded files for a given form element name.

Hierarchy

Expanded class hierarchy of UploadedFilesExtractor

2 files declare their use of UploadedFilesExtractor
ConfigImportForm.php in core/modules/config/src/Form/ConfigImportForm.php
file.module in core/modules/file/file.module

File

View on git.drupalcode.org

core/lib/Drupal/Core/File/UploadedFilesExtractor.php, line 12

Namespace

Drupal\Core\File
View source 
class UploadedFilesExtractor {
  public function __construct(protected readonly RequestStack $requestStack) {
  }
  
  /**
   * Extracts the uploaded files from the request.
   *
   * @param string $name
   *   The form element name.
   *
   * @return \Symfony\Component\HttpFoundation\File\UploadedFile[]
   *   The uploaded files.
   */
  public function extractUploadedFiles(string $name) : array {
    $allFiles = $this->requestStack
      ->getCurrentRequest()->files
      ->get('files', []);
    if (empty($allFiles[$name])) {
      return [];
    }
    // Ensure we return an array.
    $uploadedFiles = $allFiles[$name];
    if (!is_array($uploadedFiles)) {
      $uploadedFiles = [
        $uploadedFiles,
      ];
    }
    return $uploadedFiles;
  }

}

Members

Title Modifiers Object type Summary
UploadedFilesExtractor::extractUploadedFiles public function Extracts the uploaded files from the request.
UploadedFilesExtractor::__construct public function

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