Download the PHP package muffin/trash without Composer
On this page you can find all versions of the php package muffin/trash. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package trash
Trash
Adds "soft"-delete support to CakePHP tables.
Install
Using Composer:
You then need to load the plugin. You can use the shell command:
Usage
In your table(s), add the behavior like you would for any other behavior:
By default, the behavior expects your table to have a nullable DATETIME column
named deleted or trashed. Or you could customize the name when adding the behavior:
or, at the global level, in bootstrap.php:
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):
or use the purge option:
Detecting trashing
If you need to distinguish between deletion and trashing the behavior adds the ['trash' => true ] option to the afterDelete event it creates when trashing.
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.
If you don't want to cascade on trash:
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 whenModel.beforeDeleteis 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 and licensed under The MIT License.
