spatie/temporary-directory

If you want the directory to be automatically deleted when the TemporaryDirectory object is no longer referenced (e.g., when it goes out of scope or is unset()), call deleteWhenDestroyed() before creating it. This removes the need to manually call delete().

function handleTemporaryFiles()
{
    $temporaryDirectory = (new TemporaryDirectory())
        ->deleteWhenDestroyed()
        ->create();

    // ... use the temporary directory

    return; // The directory is automatically deleted here
}

handleTemporaryFiles();

Install the package via Composer to use it in your PHP project.

composer require spatie/temporary-directory

The default permissions are 0777. You can customize this by calling the permission($permission) method with an integer argument before calling create().

(new TemporaryDirectory())
   ->permission(0755)
   ->create();

Use the path($path) method to get the full absolute path to a file or subdirectory inside your temporary directory.

$temporaryDirectory = (new TemporaryDirectory())->create();
$filePath = $temporaryDirectory->path('dumps/datadump.dat'); 
// Returns something like: /tmp/1485941876276/dumps/datadump.dat

To remove all files inside the directory without deleting the directory itself, use empty(). To delete the entire directory and all its contents, use delete().

// Delete all files inside the directory
$temporaryDirectory->empty();

// Delete the entire directory and its contents
$temporaryDirectory->delete();

To use a specific name instead of a timestamp, call the name($name) method before create(). If a directory with that name already exists, an exception will be thrown unless you also call force() to override this behavior.

// Using a custom name
(new TemporaryDirectory())
   ->name($name)
   ->create();

// Using a custom name and forcing creation if it already exists
(new TemporaryDirectory())
   ->name($name)
   ->force()
   ->create();

You can specify where the temporary directory should be created using one of three ways: passing a $location string to the constructor, passing it to the make() method, or calling the location($location) method.

// Via constructor
(new TemporaryDirectory($location))->create();

// Via static make() method
TemporaryDirectory::make($location);

// Via location() method
(new TemporaryDirectory())->location($location)->create();

You can create a temporary directory using the create() method on a TemporaryDirectory instance, or by using the static make() method. By default, the directory is created in your system's temporary directory (e.g., /tmp) with a timestamped name.

use Spatie\TemporaryDirectory\TemporaryDirectory;

// Option 1: Using create()
$temporaryDirectory = (new TemporaryDirectory())->create();

// Option 2: Using the static make() method
$temporaryDirectory = TemporaryDirectory::make();

The quickest way to create a temporary directory is using the static make() method. This method instantiates the class and immediately calls create(). If no location is provided, it defaults to the system's temporary directory and generates a unique random name.

use Spatie\TemporaryDirectory\TemporaryDirectory;

$temporaryDirectory = TemporaryDirectory::make();

$path = $temporaryDirectory->path();

Use the exists() method to verify if the directory has been successfully created on the filesystem.

$directory = TemporaryDirectory::make();

if ($directory->exists()) {
    // Do something
}

Use the path() method to retrieve the absolute path of the temporary directory or to generate paths for files/subdirectories within it.

• Calling path() without arguments returns the full path of the temporary directory.
• Calling path('filename.txt') returns the path to that specific file inside the temporary directory. If the parent directory for that path does not exist, it will be created automatically.

$directory = TemporaryDirectory::make();

// Get the directory path
$dirPath = $directory->path();

// Get a path for a specific file inside
$filePath = $directory->path('reports/daily_report.pdf');