function FileSystem::delete

File

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

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)) {
            throw new FileException("Failed to unlink file '{$path}'.");
        }
        return TRUE;
    }
    if (is_dir($path)) {
        throw new NotRegularFileException("Cannot delete '{$path}' because it is a directory. Use deleteRecursive() instead.");
    }
    // Return TRUE for non-existent file as the current state is the intended
    // result.
    if (!file_exists($path)) {
        return TRUE;
    }
    // We cannot handle anything other than files and directories.
    // Throw an exception for everything else (sockets, symbolic links, etc).
    throw new NotRegularFileException("The file '{$path}' is not of a recognized type so it was not deleted.");
}