1 user Sign-in to change your status

sfPropelAuthoredBehaviorPlugin is an addon to sfGuard that automatically logs the authenticated user's profile when calling save() on an object with the behavior enabled.

• Download package

Developers

Name	Status	Email
Jon Collins	lead	eman.snillocnoj <<ta>> ynofmys

License

Copyright (c) 2007 Jonathan Collins

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.0

Join this plugin team

Other releases

Release 0.1.1 - 26/08/2007

Release 0.1.0 - 27/06/2007

sfGuardPropelAuthoredBehaviorPlugin

A common task for read/write websites is to save the user that is creating or modifying a record.

sfGuardPropelAuthoredBehaviorPlugin is an addon to sfGuard that automatically logs the authenticated user's profile. The profile id is written to the table with the behavior enabled when calling save() on a model instance.

Installation

• Install sfGuardPlugin using the instructions:

http://trac.symfony-project.com/trac/wiki/sfGuardPlugin

You must complete the steps to add user profiles to your application. This plugin uses the profile model because it is in your application schema's package, making friendly relations possible.

• Install this plugin:

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

• Enable Propel behavior support in propel.ini:

  propel.builder.AddBehaviors = true

• Activate the behavior for one of your Propel models:

  // lib/model/Article.php class Article { }

  sfPropelBehavior::add('Article', array('sfGuardPropelAuthoredBehavior'));

• Add a column to the model that will hold the profile id of the user that created or edited the record.

By default, it should follow the convention of "foreign_table_name_id", where the foreign table is your sfGuard user profile table. This can be sfGaurd's default, or the one that you defined in your settings.yml config file.

For example, consider the following schema using the default profile table:

propel:
  sf_guard_user_profile:
    _attributes: { phpName: sfGuardUserProfile }
    id:
    user_id:     { type: integer, index: unique }
    name:  varchar(100)
  article:
    id:
    sf_guard_user_profile_id:
    title: varchar(100)
    body: longvarchar

You may define another column to use on a per-table basis:

  sfPropelBehavior::add('Article', array('sfGuardPropelAuthoredBehavior' => array('column' => 'author_id')));

• Rebuild your model and update your database schema, then load fixtures if desired.

  symfony propel-build-all symfony propel-load-data

Usage

With every call to save(), the column you added will be set to the profile id of the currently authenticated user.

You can disable the behavior for all subsequent calls to save() with:

  sfPropelAuthoredBehavior::disable();

And then enable the behavior again:

  sfPropelAuthoredBehavior::enable();

Changelog

0.1.1

• Fixed an instance of the old behavior name (authored). This was causing you to not be able to specify an alternate column where the profile id is stored. (Felix Eckhofer)