Same name in other branches

1. 10 core/modules/file/src/FileRepositoryInterface.php \Drupal\file\FileRepositoryInterface::copy()
2. 11.x core/modules/file/src/FileRepositoryInterface.php \Drupal\file\FileRepositoryInterface::copy()

Copies a file to a new location and adds a file record to the database.

This function should be used when manipulating files that have records stored in the database. This is a powerful function that in many ways performs like an advanced version of copy().

• Checks if $source and $destination are valid and readable/writable.
• If file already exists in $destination either the call will error out, replace the file or rename the file based on the $replace parameter.
• If the $source and $destination are equal, the behavior depends on the $replace parameter. FileSystemInterface::EXISTS_REPLACE will error out. FileSystemInterface::EXISTS_RENAME will rename the file until the $destination is unique.
• Adds the new file to the files database. If the source file is a temporary file, the resulting file will also be a temporary file. See file_save_upload() for details on temporary files.

Parameters

\Drupal\file\FileInterface $source: A file entity.

string $destination: A string containing the destination that $source should be copied to. This must be a stream wrapper URI.

int $replace: (optional) Replace behavior when the destination file already exists. Possible values include:

• FileSystemInterface::EXISTS_RENAME: (default) Append _{incrementing number} until the filename is unique.
• FileSystemInterface::EXISTS_REPLACE: Replace the existing file. If a managed file with the destination name exists, then its database entry will be updated. If no database entry is found, then a new one will be created.
• FileSystemInterface::EXISTS_ERROR: Do nothing and throw a \Drupal\Core\File\Exception\FileExistsException.

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 FileSystemInterface::EXISTS_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::copy()

hook_file_copy()

1 method overrides FileRepositoryInterface::copy()

FileRepository::copy in core/modules/file/src/FileRepository.php

Copies a file to a new location and adds a file record to the database.

File

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

Class

FileRepositoryInterface

Performs file system operations and updates database records accordingly.

Namespace

Drupal\file

Code

public function copy(FileInterface $source, string $destination, int $replace = FileSystemInterface::EXISTS_RENAME) : FileInterface;

---