UploadedFilesExtractor.php

Same filename and directory in other branches
  1. 11.x core/lib/Drupal/Core/File/UploadedFilesExtractor.php

Namespace

Drupal\Core\File

File

core/lib/Drupal/Core/File/UploadedFilesExtractor.php

View source
<?php

declare (strict_types=1);
namespace Drupal\Core\File;

use Symfony\Component\HttpFoundation\RequestStack;

/**
 * Helper class for getting the uploaded files for a given form element name.
 */
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;
  }

}

Classes

Title Deprecated Summary
UploadedFilesExtractor Helper class for getting the uploaded files for a given form element name.

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