Download the PHP package spatie/temporary-directory without Composer
On this page you can find all versions of the php package spatie/temporary-directory. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download spatie/temporary-directory
More information about spatie/temporary-directory
Files in spatie/temporary-directory
Package temporary-directory
Short Description Easily create, use and destroy temporary directories
License MIT
Homepage https://github.com/spatie/temporary-directory
Informations about the package temporary-directory
Quickly create, use and delete temporary directories
This package allows you to quickly create, use and delete a temporary directory in the system's temporary directory.
Here's a quick example on how to create a temporary directory and delete it:
Support us
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.
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.
Installation
You can install the package via composer:
Usage
Creating a temporary directory
To create a temporary directory simply call the create
method on a TemporaryDirectory
object.
Alternatively, use the static make
method on a TemporaryDirectory
object.
By default, the temporary directory will be created in a timestamped directory in your system's temporary directory (usually /tmp
).
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.
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.
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.
The make
method also accepts a $location
argument.
Finally, you can call the location
method with a $location
argument.
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:
Emptying a temporary directory
Use the empty
method to delete all the files inside the temporary directory.
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.
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.
You can also call unset()
on an object instance.
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
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.
Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.
We publish all received postcards on our company website.
Credits
- Alex Vanderbist
- All Contributors
License
The MIT License (MIT). Please see License File for more information.