Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/usemuffin/trash
Adds soft-delete support to CakePHP ORM.
https://github.com/usemuffin/trash
Last synced: 3 months ago
JSON representation
Adds soft-delete support to CakePHP ORM.
- Host: GitHub
- URL: https://github.com/usemuffin/trash
- Owner: UseMuffin
- License: mit
- Created: 2015-07-21T06:28:36.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-05-01T11:42:22.000Z (6 months ago)
- Last Synced: 2024-07-25T12:46:14.369Z (4 months ago)
- Language: PHP
- Homepage:
- Size: 127 KB
- Stars: 85
- Watchers: 11
- Forks: 34
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cakephp - Muffin/Trash plugin - Soft-delete behavior for CakePHP. (ORM / Database / Datamapping)
README
# Trash
[](https://github.com/UseMuffin/Trash/actions?query=workflow%3ACI+branch%3Amaster)
[](https://codecov.io/github/UseMuffin/Trash)
[](https://packagist.org/packages/muffin/trash)
[](LICENSE)
Adds "soft"-delete support to CakePHP tables.
## Install
Using [Composer][composer]:
```
composer require muffin/trash
```
You then need to load the plugin. You can use the shell command:
```
bin/cake plugin load Muffin/Trash
```
## Usage
In your table(s), add the behavior like you would for any other behavior:
```php
// in the initialize() method
$this->addBehavior('Muffin/Trash.Trash');
```
By default, the behavior will auto-detect the `DATETIME` column used to track
trashed (soft-deleted) records but only if you are using `deleted` or `trashed`
as names. Otherwise, you could customize that when adding the behavior:
```php
// in the initialize() method
$this->addBehavior('Muffin/Trash.Trash', [
'field' => 'deleted_at'
]);
```
or, at the global level, in `bootstrap.php`:
```php
Configure::write('Muffin/Trash.field', 'deleted_at');
```
Finally, if you would like to keep the default cake behavior when running
`find()` or `delete()` operations and explicitly call the behavior when you need
'trash'-ing functionality, just disable the event(s):
```php
// in the initialize() method
$this->addBehavior('Muffin/Trash.Trash', [
'events' => ['Model.beforeFind'] // enables the beforeFind event only, false to disable both
]);
```
or use the purge option:
```php
$table->delete($entity, ['purge' => true]);
```
### Cascading deletion
If you'd like to have related records marked as trashed when deleting a parent
item, you can just attach the behavior to the related table classes, and set the
`'dependent' => true, 'cascadeCallbacks' => true` options in the table relationships.
This works on relationships where the item being deleted in the owning side of
the relationship. Which means that the related table should contain the foreign key.
### Custom Finders
- **onlyTrashed** - helps getting only those trashed records.
- **withTrashed** - when filtering out the trashed records by default, this method comes in handy to have them included
as part of certain calls.
### Extras
- **emptyTrash()** - permanently deletes all trashed records.
- **restoreTrash($entity = null, array $options = [])** - restores one (or all) trashed records.
- **cascadingRestoreTrash($entity = null, array $options = [])** - restores one (or all) trashed records including
those of dependent associations.
- **trash($entity, array $options = [])** - like `delete()` but for a soft-delete (handy when `Model.beforeDelete` is
disabled by default).
- **trashAll(array $conditions)** - like `deleteAll()` but for soft-deletes.
## Patches & Features
* Fork
* Mod, fix
* Test - this is important, so it's not unintentionally broken
* Commit - do not mess with license, todo, version, etc. (if you do change any, bump them into commits of
their own that I can ignore when I pull)
* Pull request - bonus point for topic branches
To ensure your PRs are considered for upstream, you MUST follow the CakePHP coding standards.
## Bugs & Feedback
http://github.com/usemuffin/trash/issues
## License
Copyright (c) 2015-present, [Use Muffin][muffin] and licensed under [The MIT License][mit].
[cakephp]:http://cakephp.org
[composer]:http://getcomposer.org
[mit]:http://www.opensource.org/licenses/mit-license.php
[muffin]:http://usemuffin.com