RatingManager Class Reference

Provides a central management class for event handlers and common functionality for the rating component. More...

Public Member Functions
	RatingManager ()

Static Public Member Functions
static	setDefaults ()
static	getCurrentUserPageRating ()
static	getCurrentPageRatingStatistics ()
static	drawRatingWidget ($obj=null)
static	upgradeComponent ($version)

Detailed Description

Provides a central management class for event handlers and common functionality for the rating component.

Definition at line 13 of file rating_manager.inc.

Member Function Documentation

drawRatingWidget()

static RatingManager::drawRatingWidget (   $obj = null )

static

Definition at line 63 of file rating_manager.inc.

     {
          global $user;
          global $script;
          
          $ratingStats = RatingManager::getCurrentPageRatingStatistics();
          $userRating = RatingManager::getCurrentUserPageRating();
          
          $options = "readOnly: ". (($userRating || !$user) ? "true" : "false");
     
          if ($obj)
          {
               $name = $obj->prettifyClassName();
               $options .= ", title: 'Rate this $name', readOnlyTitle: '$name Rating', loginMessage: 'Log in to rate this $name'";
          }
               
          $url = Fakoli::$requestURI;
          
          $script .= <<<ENDSCRIPT
<script type='text/javascript'>
window.addEvent('load', function()
{
     new PageRating("page_rating_widget", '{$url}', {$ratingStats->average_rating}, {$ratingStats->number_of_ratings}, {{$options}});
});
</script>
ENDSCRIPT;
?>
<div id="page_rating_widget"></div>
<?
     }

getCurrentPageRatingStatistics()

static RatingManager::getCurrentPageRatingStatistics ( )

static

Definition at line 46 of file rating_manager.inc.

     {
          $url = Fakoli::$requestURI;
          
          try
          {
               $rating = PageRatingStatistics::fromURL($url);
          }
          catch(DataNotFoundException $e)
          {
               $rating = new PageRatingStatistics();
               $rating->url = $url;
          }
          
          return $rating;
     }

getCurrentUserPageRating()

static RatingManager::getCurrentUserPageRating ( )

static

Definition at line 25 of file rating_manager.inc.

     {
          global $user;
          $url = Fakoli::$requestURI;
 
          if (!$user) return null;
          
          try 
          {
               $rating = Query::create(PageRating, "WHERE url=:u and user_id=:id")
                                 ->bind(":u", $url, ":id", $user->get($user->getPrimaryKey()))
                                 ->executeSingle();
          } 
          catch (DataNotFoundException $e) 
          {
               return null;
          }
          
          return $rating;
     }

RatingManager()

RatingManager::RatingManager

(

)

Definition at line 15 of file rating_manager.inc.

     {
 
     }

setDefaults()

static RatingManager::setDefaults ( )

static

Definition at line 20 of file rating_manager.inc.

     {
          //TODO: Set default configuration parameters here
     }

upgradeComponent()

static RatingManager::upgradeComponent (   $version )

static

Definition at line 94 of file rating_manager.inc.

     {
          $mgr = new RatingUpgradeManager();
          $mgr->upgrade($version);
     }

---

The documentation for this class was generated from the following file:

• C:/code/cms.sonjara.com/cms/components/rating/rating_manager.inc