function FileSystem::getDestinationFilename

Same name in other branches
  1. 9 core/lib/Drupal/Core/File/FileSystem.php \Drupal\Core\File\FileSystem::getDestinationFilename()
  2. 10 core/lib/Drupal/Core/File/FileSystem.php \Drupal\Core\File\FileSystem::getDestinationFilename()
  3. 11.x core/lib/Drupal/Core/File/FileSystem.php \Drupal\Core\File\FileSystem::getDestinationFilename()

Overrides FileSystemInterface::getDestinationFilename

1 call to FileSystem::getDestinationFilename()
FileSystem::prepareDestination in core/lib/Drupal/Core/File/FileSystem.php
Prepares the destination for a file copy or move operation.

File

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

Class

FileSystem
Provides helpers to operate on files and stream wrappers.

Namespace

Drupal\Core\File

Code

public function getDestinationFilename($destination, $replace) {
    $basename = $this->basename($destination);
    if (!Unicode::validateUtf8($basename)) {
        throw new FileException(sprintf("Invalid filename '%s'", $basename));
    }
    if (file_exists($destination)) {
        switch ($replace) {
            case FileSystemInterface::EXISTS_REPLACE:
                // Do nothing here, we want to overwrite the existing file.
                break;
            case FileSystemInterface::EXISTS_RENAME:
                $directory = $this->dirname($destination);
                $destination = $this->createFilename($basename, $directory);
                break;
            case FileSystemInterface::EXISTS_ERROR:
                // Error reporting handled by calling function.
                return FALSE;
        }
    }
    return $destination;
}

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