function FileRepositoryInterface::writeData

Same name in other branches
  1. 9 core/modules/file/src/FileRepositoryInterface.php \Drupal\file\FileRepositoryInterface::writeData()
  2. 11.x core/modules/file/src/FileRepositoryInterface.php \Drupal\file\FileRepositoryInterface::writeData()

Writes a file to the specified destination and creates a file entity.

Parameters

string $data: A string containing the contents of the file.

string $destination: A string containing the destination URI. This must be a stream wrapper URI.

\Drupal\Core\File\FileExists|int $fileExists: (optional) The replace behavior when the destination file already exists.

Return value

\Drupal\file\FileInterface The file entity.

Throws

\Drupal\Core\File\Exception\FileException Thrown when there is an error writing to the file system.

\Drupal\Core\File\Exception\FileExistsException Thrown when the destination exists and $replace is set to FileExists::Error.

\Drupal\Core\File\Exception\InvalidStreamWrapperException Thrown when the destination is an invalid stream wrapper.

\Drupal\Core\Entity\EntityStorageException Thrown when there is an error saving the file.

See also

\Drupal\Core\File\FileSystemInterface::saveData()

File

core/modules/file/src/FileRepositoryInterface.php, line 38

Class

FileRepositoryInterface
Performs file system operations and updates database records accordingly.

Namespace

Drupal\file

Code

public function writeData(string $data, string $destination, FileExists|int $fileExists = FileExists::Rename) : FileInterface;

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