function FileSystem::delete

Overrides FileSystemInterface::delete

File

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

Class

FileSystem

Provides helpers to operate on files and stream wrappers.

Namespace

Code

public function delete($path) {
    if (is_file($path)) {
        if (!$this->unlink($path)) {
            $this->logger
                ->error("Failed to unlink file '%path'.", [
                '%path' => $path,
            ]);
            throw new FileException("Failed to unlink file '{$path}'.");
        }
        return TRUE;
    }
    if (is_dir($path)) {
        $this->logger
            ->error("Cannot delete '%path' because it is a directory. Use deleteRecursive() instead.", [
            '%path' => $path,
        ]);
        throw new NotRegularFileException("Cannot delete '{$path}' because it is a directory. Use deleteRecursive() instead.");
    }
    // Return TRUE for non-existent file, but log that nothing was actually
    // deleted, as the current state is the intended result.
    if (!file_exists($path)) {
        $this->logger
            ->notice('The file %path was not deleted because it does not exist.', [
            '%path' => $path,
        ]);
        return TRUE;
    }
    // We cannot handle anything other than files and directories.
    // Throw an exception for everything else (sockets, symbolic links, etc).
    $this->logger
        ->error("The file '%path' is not of a recognized type so it was not deleted.", [
        '%path' => $path,
    ]);
    throw new NotRegularFileException("The file '{$path}' is not of a recognized type so it was not deleted.");
}