| name file | size | edit | permission | action |
|---|---|---|---|---|
| .env | 2733 KB | December 22 2024 06:20:07 | 0644 | |
| 404.html | 58370 KB | November 20 2024 15:32:22 | 0644 | |
| 502.html | 58368 KB | November 20 2024 15:32:22 | 0644 | |
| Modules | - | December 11 2024 21:02:56 | 0755 | |
| README.md | 4158 KB | February 14 2023 12:31:56 | 0644 | |
| app | - | December 11 2024 17:57:48 | 0755 | |
| artisan | 1686 KB | February 14 2023 12:31:56 | 0644 | |
| bootstrap | - | December 11 2024 20:23:36 | 0755 | |
| composer.json | 3761 KB | December 11 2024 22:15:00 | 0644 | |
| composer.lock | 512048 KB | December 11 2024 22:13:28 | 0644 | |
| config | - | June 15 2025 02:09:36 | 0755 | |
| database | - | December 05 2024 20:18:12 | 0755 | |
| dfsdf dfds fd fds findex.html | 1420 KB | November 20 2024 15:32:24 | 0644 | |
| error_log | 17023559 KB | July 18 2025 18:36:36 | 0644 | |
| firoz | - | December 23 2024 13:24:46 | 0755 | |
| index.php | 1667 KB | December 14 2024 05:20:36 | 0644 | |
| lang | - | December 11 2024 21:02:48 | 0755 | |
| modules_statuses.json | 472 KB | November 20 2024 15:32:24 | 0644 | |
| mpos | - | March 31 2025 02:36:31 | 0755 | |
| package.json | 226 KB | February 14 2023 12:31:56 | 0644 | |
| phpunit.xml | 1146 KB | February 14 2023 12:31:56 | 0644 | |
| public | - | March 31 2025 02:36:31 | 0755 | |
| resources | - | December 11 2024 21:10:22 | 0755 | |
| routes | - | June 15 2025 02:09:31 | 0755 | |
| storage | - | December 11 2024 21:12:44 | 0755 | |
| tests | - | December 05 2024 20:18:12 | 0755 | |
| vendor | - | December 11 2024 22:13:30 | 0755 | |
| vite.config.js | 263 KB | February 14 2023 12:31:56 | 0644 |
](https://spatie.be/github-ad-click/temporary-directory)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
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](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Installation
You can install the package via composer:
```bash
composer require spatie/temporary-directory
```
## Usage
### Creating a temporary directory
To create a temporary directory simply call the `create` method on a `TemporaryDirectory` object.
```php
(new TemporaryDirectory())->create();
```
Alternatively, use the static `make` method on a `TemporaryDirectory` object.
```php
TemporaryDirectory::make();
```
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.
```php
(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.
```php
(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.
```php
(new TemporaryDirectory($location))
->create();
```
The `make` method also accepts a `$location` argument.
```php
TemporaryDirectory::make($location);
```
Finally, you can call the `location` method with a `$location` argument.
```php
(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:
```php
$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.
```php
$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.
```php
$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.
```php
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.
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../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](https://spatie.be/en/opensource/postcards).
## Credits
- [Alex Vanderbist](https://github.com/AlexVanderbist)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.