function FileSystem::move

File

core/lib/Drupal/Core/File/FileSystem.php, line 371

Class

FileSystem

Provides helpers to operate on files and stream wrappers.

Namespace

Code

public function move($source, $destination, $fileExists = FileExists::Rename) {
    if (!$fileExists instanceof FileExists) {
        // @phpstan-ignore-next-line
        $fileExists = FileExists::fromLegacyInt($fileExists, __METHOD__);
    }
    $this->prepareDestination($source, $destination, $fileExists);
    // Ensure compatibility with Windows.
    // @see \Drupal\Core\File\FileSystemInterface::unlink().
    if (!$this->streamWrapperManager
        ->isValidUri($source) && str_starts_with(PHP_OS, 'WIN')) {
        chmod($source, 0600);
    }
    // Attempt to resolve the URIs. This is necessary in certain
    // configurations (see above) and can also permit fast moves across local
    // schemes.
    $real_source = $this->realpath($source) ?: $source;
    $real_destination = $this->realpath($destination) ?: $destination;
    // Perform the move operation.
    if (!@rename($real_source, $real_destination)) {
        // Fall back to slow copy and unlink procedure. This is necessary for
        // renames across schemes that are not local, or where rename() has not
        // been implemented. It's not necessary to use FileSystem::unlink() as the
        // Windows issue has already been resolved above.
        if (!@copy($real_source, $real_destination)) {
            throw new FileWriteException("The specified file '{$source}' could not be moved to '{$destination}'.");
        }
        if (!@unlink($real_source)) {
            throw new FileException("The source file '{$source}' could not be unlinked after copying to '{$destination}'.");
        }
    }
    // Set the permissions on the new file.
    $this->chmod($destination);
    return $destination;
}