Skip to content

Commit

Permalink
DeleteWhenDestroyed documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
cosmastech authored Sep 25, 2023
1 parent 228a3c3 commit d70bffd
Showing 1 changed file with 22 additions and 0 deletions.
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

0 comments on commit d70bffd

Please sign in to comment.