function InputStreamFileWriter::writeStreamToFile

Same name and namespace in other branches
  1. 11.x core/modules/file/src/Upload/InputStreamFileWriter.php \Drupal\file\Upload\InputStreamFileWriter::writeStreamToFile()

Write the input stream to a temporary file.

Parameters

string $stream: (optional) The input stream.

int $bytesToRead: (optional) The length of bytes to read in each iteration.

Return value

string The temporary file path.

Overrides InputStreamFileWriterInterface::writeStreamToFile

File

core/modules/file/src/Upload/InputStreamFileWriter.php, line 25

Class

InputStreamFileWriter
Writes files from a input stream to a temporary file.

Namespace

Drupal\file\Upload

Code

public function writeStreamToFile(string $stream = self::DEFAULT_STREAM, int $bytesToRead = self::DEFAULT_BYTES_TO_READ) : string {
  // 'rb' is needed so reading works correctly on Windows environments too.
  $fileData = fopen($stream, 'rb');
  $tempFilePath = $this->fileSystem
    ->tempnam('temporary://', 'file');
  $tempFile = fopen($tempFilePath, 'wb');
  if ($tempFile) {
    while (!feof($fileData)) {
      $read = fread($fileData, $bytesToRead);
      if ($read === FALSE) {
        // Close the file streams.
        fclose($tempFile);
        fclose($fileData);
        throw new UploadException('Input file data could not be read');
      }
      if (fwrite($tempFile, $read) === FALSE) {
        // Close the file streams.
        fclose($tempFile);
        fclose($fileData);
        throw new CannotWriteFileException(sprintf('Temporary file data for "%s" could not be written', $tempFilePath));
      }
    }
    // Close the temp file stream.
    fclose($tempFile);
  }
  else {
    // Close the input file stream since we can't proceed with the upload.
    // Don't try to close $tempFile since it's FALSE at this point.
    fclose($fileData);
    throw new NoFileException(sprintf('Temporary file "%s" could not be opened for file upload', $tempFilePath));
  }
  // Close the input stream.
  fclose($fileData);
  return $tempFilePath;
}

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