30 users Sign-in to change your status

Paranoid behavior for Propel.

• Repository
• Report a bug
• Download package
• Browse source

Developers

Name	Status	Email
Fabien POTENCIER	lead	moc.tcejorp-ynofmys <<ta>> reicnetop.neibaf

License

Copyright (c) 2004-2006 Fabien Potencier

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.

Releases for sf 1.2

Releases for sf 1.1

Releases for sf 1.0

Join this plugin team

Other releases

Release 1.2.0 - 26/02/2009

Release 1.0.3 - 15/05/2008

Release 1.0.2 - 28/02/2008

Release 1.0.1 - 01/12/2006

Release 1.0.0 - 21/10/2006

sfPropelParanoidBehaviorPlugin plugin

The sfPropelParanoidBehaviorPlugin is a symfony plugin that provides a new Propel behavior.

If you enable this behavior for one of your model class, deletion of any object of this class is disabled and replaced with the updating of the deleted_at column of the object.

The plugin also adds a new method forceDelete to force object deletion.

Installation

• Install the plugin

    symfony plugin-install http://plugins.symfony-project.com/sfPropelParanoidBehaviorPlugin
  

• Enable Propel behavior support in propel.ini:

    propel.builder.AddBehaviors = true
  

  If you have to enable the behavior support, rebuild your model:

    symfony propel-build-model
  

• Activate the behavior for one of your Propel model:

    // lib/model/Article.php
    class Article
    {
    }
  
    sfPropelBehavior::add('Article', array('paranoid'));
  

  By default, the plugin will update the deleted_at column for this model. You can also specify another column:

    sfPropelBehavior::add('Article', array('paranoid' => array('column' => 'deleted_at')));
  

Usage

Here are some examples of Propel calls and the generated SQL:

  $article = Article::retrieveByPK(1);

  // SELECT blog_article.ID, blog_article.AUTHOR_ID, blog_article.CREATED_AT, blog_article.DELETED_AT FROM blog_article
  // WHERE blog_article.ID=1 AND blog_article.DELETED_AT IS NULL

  $article->delete();

  // UPDATE blog_article SET DELETED_AT = '2006-10-21 10:58:56' WHERE blog_article.ID=1

  $article->forceDelete();

  // DELETE FROM blog_article WHERE blog_article.ID=1

  $articles = ArticlePeer::doCount(new Criteria());

  // SELECT COUNT(blog_article.ID) FROM blog_article WHERE blog_article.DELETED_AT IS NULL 

You can also disable the behavior with:

  sfPropelParanoidBehavior::disable();

The paranoid behavior will be disabled for the very next request.

  $article->delete();

  // UPDATE blog_article SET DELETED_AT = '2006-10-21 10:58:56' WHERE blog_article.ID=1

  sfPropelParanoidBehavior::disable();
  $article->delete();

  // DELETE FROM blog_article WHERE blog_article.ID=1

  $article->delete();

  // UPDATE blog_article SET DELETED_AT = '2006-10-21 10:58:56' WHERE blog_article.ID=1