Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DeleteWhenDestroyed documentation #74

Merged
merged 1 commit into from
Sep 27, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,28 @@ Once you're done processing your temporary data you can delete the entire tempor
$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
Expand Down