Wiki

Clone wiki

badger.yii / Home

Badger.yii

Yii framework application module. Adds badge functionality into your Yii app.

Module. With small configuration adds badges (gamification logic) to your app. Custom badge giving logic and custom images.

InstallationAdd custom badgeEventsImagesUpgradeEntertainment

Requirements

  • PHP 5
  • tested with Yii 1.1.10
  • MySQL, PostgreSQL, SQLite.. (used Yii functions to create tables and insert data)

Features

  • Different database platforms: MySQL, PostgreSQL, SQLite..
  • Assign badges to custom user table (default is "user" but it can be changed)
  • Using custom layout (default: layouts/main)
  • Add your own logic how specific badge is given to user. Your conditions - Add custom badge
  • Given default style for badges, but it's 100% customizable - Images
  • Create your own view files (it will not be overwritten on next version) - Upgrade
  • Cache badges (listed from db)

Installation

Copy contents into protected/modules/badger/ (so it comes as protected/modules/badger/).

OR clone it with mercurial

$ cd protected/modules
$ hg clone https://briiC@bitbucket.org/briiC/badger.yii badger

Make your own files (copy from *.original)

Before using badger you must copy some default files and make your own

$ cd protected/modules/badger
$ cp controllers/BadgeController.php.original controllers/BadgeController.php
$ cp models/Badge.php.original models/Badge.php
$ cp views/badge/_list.php.original  views/badge/_list.php
$ cp views/badge/list.php.original  views/badge/list.php
$ cp views/badge/my.php.original  views/badge/my.php
$ cp assets/css/badger.css.original assets/css/badger.css

Permissions

Module creates new files so you need to give permissions (only for installing part. After that you can set to default permissions)

$ cd protected/modules/
$ sudo chmod -R 0775 badger/
$ sudo chown -R myuser:www-data badger/

Configuration

protected/config/main.php

<?php

      //..
      'import'=>array(
              //..
              // Badger
              'application.modules.badger.models.*',
              //..
      ),

      //..
      'modules'=> array(

            'badger' => array(
                  //'layout' => '//layouts/mainx', //default: "//layouts/main"
                  //'userTable' => 'userx', // default: "user"
                  'cacheSec' => 3600 * 24, // cache duration. default: 3600

                  // Creates tables and copy necessary files
                  'install' => true, // remove/comment after succesful install
                   // drop all badger tables before installing (fresh install)
                  'dropBeforeInstall' => false, 
            ),
            //..
      ),
//..

?>

There is two params that better must be removed or commented after you successfully run badge module.

  • install - Created tables (two: badge and _user_badge)
  • dropBeforeInstall - Try to drop badger tables before installing

Add your custom badge

Read Add custom badge how to create new bages with custom logic

Give badge to user

<?php

$Badge = new Badge;
//$Badge->onSuccess = array( $object, 'notifyUser'); // add custom event after giving badge to user
$badgeIdArr = $Badge->checkAndGiveGroup( get_class($this) );

?>

Feedback

Please give feedback about installation/configuration process. Which part is not so easy to understand I will try get it more clear for everybody.

Also send bugs, ideas: https://bitbucket.org/briiC/badger.yii/issues/new

Updated