22 users Sign-in to change your status

This Symfony plugin allow rating capacity to a Propel object through a Propel behavior. Prototype WebServices Applications

• Repository
• Download package
• Browse source

This plugin aims at providing rating capabilities to any Propel object with the help of a dedicated Propel behavior.

Developers

Name	Status	Email
Nicolas Perriault	lead	moc.liamg <<ta>> tluairrepn

License

Copyright (c) 2007 Nicolas Perriault

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.7.2 - 10/02/2008

Release 0.7.1 - 29/10/2007

Release 0.6.2 - 12/09/2007

Release 0.6.1 - 09/09/2007

Release 0.6.0 - 07/09/2007

Release 0.5.0 - 05/09/2007

sfPropelActAsRatableBehaviorPlugin

This plugin aims at providing rating capabilities to any Propel object with the help of a dedicated Propel behavior.

Installation

To install the plugin, run this command within your symfony project :

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

To activate this Propel behavior in Symfony, you must first activate behaviors in your propel.ini file :

propel.builder.addBehaviors = true

Add the behavior to one or more of your existing model object classes, eg. an Article object :

<?php
class Article extends BaseArticle
{
}

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

Then, rebuild your model :

symfony propel-build-all

And clear the cache :

symfony cc

Usage

You can rate your previously configured Article objects through the plugin API. Note that you can provide a user PK to determine if one of your user has already rated the object.

Here we imagine a User object instance $user which represent a member, an author, a person or anything like this.

To set a rating for a given user :

$article->setRating(10, $user->getId());

To retrieve user rating for this object :

$article->getUserRating($user->getId());

To get the average rating of the object :

$article->getRating();

To clear user rating :

$article->clearRating($user->getId());

To clear all ratings for the object :

$article->clearRatings();

You can test if the object has already been rated :

$article->hasBeenRated();

You can also test if the object has already been rated by a particular user:

$article->hasBeenRatedByUser($user->getId());

Unit testing

The plugin is provided with a unit tests suite located here. To run the tests, type this line from the root of your project :

$ php plugins/sfPropelActAsRatableBehaviorPlugin/test/sfPropelActAsRatableBehaviorTest.php

Note that you have to provide a test object to run the test. By default its an Article object with a title field which the behavior is supposed to be applied, but feel free to edit the tests file to adapt it to your need and your existing schema.