License GPLv2
#!#!#!#!#!#IMPORTANT!#!#!#!#!#!#!#!#!#!#!#!#!IMPORTANT!#!#!#!#!#!#!#!#!#!#!#!#!IMPORTANT#!#!#!#!#!#
This extension stores topic rating data in a file. If this is NOT your first install, and you are updating from a previous version, DO THIS FIRST:
- Thru FTP, Go to the extensions' (thetopfew/ratekit/) and BACKUP the entire /data/ folder. Save it to your desktop for instance. THEN, after updating the extension,
re-upload your backup /data/ folder, overwriting the new one that comes with this package. OR, simply remove this packages /data/ folder before uploading the update.
You get the picture.
The 'data' folder is where your current star ratings are if you have this extension installed already! You do not want to over-write them do you and start over, or do you?
#!#!#!#!#!#IMPORTANT!#!#!#!#!#!#!#!#!#!#!#!#!IMPORTANT!#!#!#!#!#!#!#!#!#!#!#!#!IMPORTANT#!#!#!#!#!#
RateKit is a simple PHP / jQuery plugin that adds ratings stars to an existing site. Converted specifically for phpBB forums software in this extension!
On loading RateKit transforms any input with class "rating" into a group of ratings stars. The plugin stores ratings in a local SQLIte database: when it loads RateKit
checks the existing rating for each input and displays it. When a user clicks to leave a rating, RateKit checks their IP address. If they've tried to rate that item
before within a set period (5-years by default), the new rating isn't registered. Instead, it displays their existing rating, then switches back to the overall rating and
disables the input. (You can set the period for this check by changing THROTTLE_TIME in config.php.) If the user hasn't rated that item before, RateKit adds their rating
to the overall score and displays the updated star rating.
Allows every visitor to leave a 5-star rating per topic! RateKit is an easy-to-use, ultra low maintenance PHP and jQuery plugin. NO creating/altering phpBB database tables. Instead, tracks by visitors' by IP address and stores ratings in a local SQLIte database file: when it loads, it checks the existing rating for each topic, whether or not IP has rated before, and displays an average rating. - NEW in version 1.1.0, rating now displays in viewforum per topic overall rating, AND an average & total reviews in viewtopic! - NEW in version 1.2.0, ACP module added, admins may set permissions per users and forums. - NEW in version 1.3.0, ACP option added, admins may choose to not display Ratekit in Global, Announement, Sticky or Locked topics.
Pre. If updating this extension, FIRST: Look for 5-Star Topic RateKit under the Enabled Extensions list, and click its Disable link. Continue on.
(FYI: deleting data will do nothing for this extension, remember your saved data is in the /data/ folder!!)
- Download the latest release.
- Unzip the downloaded release locally on your desktop.
- Copy the
thetopfewfolder tophpBB/ext/(if done correctly, you'll have the main extension class at (your forum root)/ext/thetopfew/ratekit/composer.json). - Navigate in the ACP to
Customise tab -> Manage Extensions. - Look for
5-Star Topic RateKitunder the Disabled Extensions list, and click itsEnablelink. - Navigate in the ACP to 'Extensions tab -> RateKit 'Settings', to disable star ratings per each forum.
- Customize your star's title, size and/or color by simply editing the extensions/language/en/common.php file (instructions inside).
- Navigate in the ACP to
Customise tab -> Manage Extensions. - Look for
5-Star Topic RateKitunder the Enabled Extensions list, and click itsDisablelink. - To permanently uninstall, click
Delete Dataand then delete the/ext/thetopfew/ratekitfolder.
#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!##!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!##!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#!#
The RateKit front end includes parts of Kartik Visweswaran's splendid Bootstrap Star Rating jQuery plugin. Thank you Kartik!
Please consider a small donation to help me maintain RateKit and create other useful stuff.
