spatie/temporary-directory

Easily create, use and destroy temporary directories

Tuesday, May 22, 2018
by Spatie
Repository
6 Watchers
231 Stars
875,978 Installations

PHP
19 Dependents
0 Suggesters
12 Forks
1 Open issues
13 Versions
26 % Grown

The README.md

Quickly create, use and delete temporary directories

, _(*1)

This package allows you to quickly create, use and delete a temporary directory in the system's temporary directory., _(*2)

Here's a quick example on how to create a temporary directory and delete it:, _(*3)

use Spatie\TemporaryDirectory\TemporaryDirectory;

$temporaryDirectory = (new TemporaryDirectory())->create();

// Get a path inside the temporary directory
$temporaryDirectory->path('temporaryfile.txt');

// Delete the temporary directory and all the files inside it
$temporaryDirectory->delete();

Support us

, _(*4)

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products., _(*5)

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall., _(*6)

Installation

You can install the package via composer:, _(*7)

composer require spatie/temporary-directory

Usage

Creating a temporary directory

To create a temporary directory simply call the create method on a TemporaryDirectory object., _(*8)

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

Alternatively, use the static make method on a TemporaryDirectory object., _(*9)

TemporaryDirectory::make();

By default, the temporary directory will be created in a timestamped directory in your system's temporary directory (usually /tmp)., _(*10)

Naming your temporary directory

If you want to use a custom name for your temporary directory instead of the timestamp call the name method with a string $name argument before the create method., _(*11)

(new TemporaryDirectory())
   ->name($name)
   ->create();

By default an exception will be thrown if a directory already exists with the given argument. You can override this behaviour by calling the force method in combination with the name method., _(*12)

(new TemporaryDirectory())
   ->name($name)
   ->force()
   ->create();

Setting a custom location for a temporary directory

You can set a custom location in which your temporary directory will be created by passing a string $location argument to the TemporaryDirectory constructor., _(*13)

(new TemporaryDirectory($location))
   ->create();

The make method also accepts a $location argument., _(*14)

TemporaryDirectory::make($location);

Finally, you can call the location method with a $location argument., _(*15)

(new TemporaryDirectory())
   ->location($location)
   ->create();

Determining paths within the temporary directory

You can use the path method to determine the full path to a file or directory in the temporary directory:, _(*16)

$temporaryDirectory = (new TemporaryDirectory())->create();
$temporaryDirectory->path('dumps/datadump.dat'); // return  /tmp/1485941876276/dumps/datadump.dat

Emptying a temporary directory

Use the empty method to delete all the files inside the temporary directory., _(*17)

$temporaryDirectory->empty();

Deleting a temporary directory

Once you're done processing your temporary data you can delete the entire temporary directory using the delete method. All files inside of it will be deleted., _(*18)

$temporaryDirectory->delete();

Deleting a temporary directory when the object is destroyed

If you want to automatically have the filesystem directory deleted when the object instance has no more references in its defined scope, you can enable deleteWhenDestroyed() on the TemporaryDirectory object., _(*19)

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

    // ... use the temporary directory

    return; // no need to manually call $temporaryDirectory->delete()!
}

handleTemporaryFiles();

You can also call unset() on an object instance., _(*20)

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently., _(*21)

Contributing

Please see CONTRIBUTING for details., _(*22)

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities., _(*23)

Postcardware

You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using., _(*24)

Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium., _(*25)

We publish all received postcards on our company website., _(*26)