josegonzalez / cakephp-deleted-at
Handles soft-deletion of database records
Installs: 17
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 2
Forks: 1
Open Issues: 0
Type:cakephp-plugin
Requires
This package is not auto-updated.
Last update: 2022-02-01 12:29:24 UTC
README
DeletedAt
Handles soft-deletion of database records
Background
Written for the CakeAdvent post on Build Behaviors
Requirements
- CakePHP 2.x
- PHP 5.3
Installation
[Using Composer]
Add the plugin to your project's composer.json
- something like this:
{
"require": {
"josegonzalez/cakephp-deleted-at": "dev-master"
}
}
Because this plugin has the type cakephp-plugin
set in its own composer.json
, Composer will install it inside your /Plugins
directory, rather than in the usual vendors file. It is recommended that you add /Plugins/DeletedAt
to your .gitignore file. (Why? read this.)
[Manual]
- Download this: http://github.com/josegonzalez/cakephp-deleted-at/zipball/master
- Unzip that download.
- Copy the resulting folder to
app/Plugin
- Rename the folder you just copied to
DeletedAt
[GIT Submodule]
In your app directory type:
git submodule add -b master git://github.com/josegonzalez/cakephp-deleted-at.git Plugin/DeletedAt git submodule init git submodule update
[GIT Clone]
In your Plugin
directory type:
git clone -b master git://github.com/josegonzalez/cakephp-deleted-at.git DeletedAt
Enable plugin
In 2.0 you need to enable the plugin in your app/Config/bootstrap.php
file:
CakePlugin::load('DeletedAt');
If you are already using CakePlugin::loadAll();
, then this is not necessary.
Usage
Add the column deleted
to your model's table. It should be of type datetime
, with a default of null.
And add the behavior to your model:
<?php class Post extends AppModel { public $actsAs = array('DeletedAt.DeletedAt'); } ?>
Now just softdelete()
or undelete()
to see the magic in action!
We' also added the custom finders deleted
and non_deleted
for your use.
TODO
- More usage
License
The MIT License (MIT)
Copyright (c) 2013 Jose Diaz-Gonzalez
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.