function DirectoryTest::testFileCreateNewFilepath

This will take a directory and path, and find a valid filepath that is not taken by another file.

File

core/tests/Drupal/KernelTests/Core/File/DirectoryTest.php, line 132

Class

DirectoryTest

Tests operations dealing with directories.

Namespace

Code

public function testFileCreateNewFilepath() {
    // First we test against an imaginary file that does not exist in a
    // directory.
    $basename = 'xyz.txt';
    $directory = 'core/misc';
    $original = $directory . '/' . $basename;
    
    /** @var \Drupal\Core\File\FileSystemInterface $file_system */
    $file_system = \Drupal::service('file_system');
    $path = $file_system->createFilename($basename, $directory);
    $this->assertEqual($path, $original, new FormattableMarkup('New filepath %new equals %original.', [
        '%new' => $path,
        '%original' => $original,
    ]), 'File');
    // Then we test against a file that already exists within that directory.
    $basename = 'druplicon.png';
    $original = $directory . '/' . $basename;
    $expected = $directory . '/druplicon_0.png';
    $path = $file_system->createFilename($basename, $directory);
    $this->assertEqual($path, $expected, new FormattableMarkup('Creating a new filepath from %original equals %new (expected %expected).', [
        '%new' => $path,
        '%original' => $original,
        '%expected' => $expected,
    ]), 'File');
    // @TODO: Finally we copy a file into a directory several times, to ensure a properly iterating filename suffix.
}