Anonymous avatar Anonymous committed e607d23

remove useless readme for sf site

Comments (0)

Files changed (2)

README

-# sfPropel15RatableBehaviorPlugin
-
-A ratable behavior based on Propel 15
-
-## Introduction
-
-This plugins depends on sfPropel15Plugin
-
-## Features
-
-  * designed for the magical propel 1.5
-  * easy integration in your model
-  * add a new table to your db for rating, so don't mess with your data.
-  * the base idea is from the nice sfPropelActAsRatable
-
-## Get it installed
-
-  * be sure to have sfPropel15Plugin installed and enabled
-  
-  * go to your project's root
-
-  * Install the plugin:
-
-         ./symfony plugin:install sfPropel15RatableBehaviorPlugin
-
-  * rebuild your model
-
-	 ./symfony propel:build-all-load --no-confirmation
-
-  * clear your cache:
-
-         ./symfony cc
-
-
-## Usage
-
-### Enable the behavior in your schema
-
-
-    [yaml]
-    article:
-      id:  ~
-      title:                 { type: varchar(150), required: true }
-      html_text:             { type: longvarchar }
-    propel_behavior:
-      ratable:               ~
-
-### Rebuild your model
-
-### Enjoy!
-
-    [php]
-    // $object->setRating($vote, $user_id = null, PropelPDO $con = null);
-    // $vote is an integer value from 1 to 5
-    // $user_id a unique id (usually the id from sf_guard_user table)
-    // use it if you want to allow one vote, per object, per user.
-    // if no user_id is provided votes are free
-    
-    // $object->getRating($max = 5, $round = false)
-    // $max is the maximum vote
-    // $round whether to round the result or not
-    
-    // create the article object
-    $art = new Article();
-    // set vote 4 on 5 to article $art by user_id 1
-    $art->setRating(4, 1); // return 4
-    // set vote 2 on 5 to article $art by user_id 2
-    $art->setRating(2, 2); // return 3
-    // set a duplicate vote
-    $art->setRating(3, 2); // no vote is set. return false
-    
-    // get the average
-    $art->getRating() // return 3
-    // get the average, with maxiumum at 10.
-    $art->getRating(10) // return 6
-
-
-## License and credits
-This plugin has been developed by Matteo Giachino and is licensed under the MIT license.

README con immagine

-# sfPropel15RatableBehaviorPlugin
-
-A ratable behavior based on Propel 15
-![ss1.png](http://trac.symfony-project.org/attachment/wiki/sfPropelTaggableWidgetPlugin/ss1.png?format=raw)
-
-## Introduction
-
-This plugins depends on sfPropel15Plugin
-
-## Features
-
-  * designed for the magical propel 1.5
-  * easy integration in your model
-  * add a new table to your db for rating, so don't mess with your data.
-  * the base idea is from the nice sfPropelActAsRatable
-
-## Get it installed
-
-  * be sure to have sfPropel15Plugin installed and enabled
-  
-  * go to your project's root
-
-  * Install the plugin:
-
-         ./symfony plugin:install sfPropel15RatableBehaviorPlugin
-
-  * rebuild your model
-
-	 ./symfony propel:build-all-load --no-confirmation
-
-  * clear your cache:
-
-         ./symfony cc
-
-
-## Usage
-
-### Enable the behavior in your schema
-
-
-    [yaml]
-    article:
-      id:  ~
-      title:                 { type: varchar(150), required: true }
-      html_text:             { type: longvarchar }
-    propel_behavior:
-      ratable:               ~
-
-### Rebuild your model
-
-### Enjoy!
-
-    [php]
-    // $object->setRating($vote, $user_id = null, PropelPDO $con = null);
-    // $vote is an integer value from 1 to 5
-    // $user_id a unique id (usually the id from sf_guard_user table)
-    // use it if you want to allow one vote, per object, per user.
-    // if no user_id is provided votes are free
-    
-    // $object->getRating($max = 5, $round = false)
-    // $max is the maximum vote
-    // $round whether to round the result or not
-    
-    // set vote 4 on 5 to article $art by user_id 1
-    $art = new Article();
-    $art->setRating(4, 1);
-    $art->setRating(2, 2);
-
-    // get the average
-    $art->getRating() // 3
-    $art->getRating(10) // 6
-
-
-## License and credits
-This plugin has been developed by Matteo Giachino and is licensed under the MIT license.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.