public function FileSystemInterface::copy in Drupal 9

Same name and namespace in other branches

Copies a file to a new location without invoking the file API.

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 replace the existing file. FileSystemInterface::EXISTS_ERROR will error out. FileSystemInterface::EXISTS_RENAME will rename the file until the $destination is unique.
Provides a fallback using realpaths if the move fails using stream wrappers. This can occur because PHP's copy() function does not properly support streams if open_basedir is enabled. See https://bugs.php.net/bug.php?id=60456

string $source: A string specifying the filepath or URI of the source file.

string $destination: A URI containing the destination that $source should be copied to. The URI may be a bare filepath (without a scheme).

int $replace: Replace behavior when the destination file already exists:

FileSystemInterface::EXISTS_REPLACE - Replace the existing file.
FileSystemInterface::EXISTS_RENAME - Append _{incrementing number} until the filename is unique.
FileSystemInterface::EXISTS_ERROR - Throw an exception.

string The path to the new file.

\Drupal\Core\File\Exception\FileException Implementation may throw FileException or its subtype on failure.

1 method overrides FileSystemInterface::copy()

FileSystem::copy in core/lib/Drupal/Core/File/FileSystem.php: Copies a file to a new location without invoking the file API.

FileSystemInterface: Provides an interface for helpers that operate on files and stream wrappers.

public function copy($source, $destination, $replace = self::EXISTS_RENAME);

You are here