class.ilRatingGUI.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2008 ILIAS open source, University of Cologne            |
        |                                                                             |
        | This program is free software; you can redistribute it and/or               |
        | modify it under the terms of the GNU General Public License                 |
        | as published by the Free Software Foundation; either version 2              |
        | of the License, or (at your option) any later version.                      |
        |                                                                             |
        | This program is distributed in the hope that it will be useful,             |
        | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
        | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
        | GNU General Public License for more details.                                |
        |                                                                             |
        | You should have received a copy of the GNU General Public License           |
        | along with this program; if not, write to the Free Software                 |
        | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
        +-----------------------------------------------------------------------------+
*/

include_once("./Services/Rating/classes/class.ilRating.php");

class ilRatingGUI
{
        function __construct()
        {
                global $lng;
                
                $lng->loadLanguageModule("rating");
        }
        
        function &executeCommand()
        {
                global $ilCtrl;
                
                $next_class = $ilCtrl->getNextClass($this);
                $cmd = $ilCtrl->getCmd();
                
                switch($next_class)
                {
                        default:
                                return $this->$cmd();
                                break;
                }
        }

        function setObject($a_obj_id, $a_obj_type, $a_sub_obj_id = 0, $a_sub_obj_type = "")
        {
                global $ilUser;

                $this->obj_id = $a_obj_id;
                $this->obj_type = $a_obj_type;
                $this->sub_obj_id = $a_sub_obj_id;
                $this->sub_obj_type = $a_sub_obj_type;
                
                //$this->setSaveCmd("saveTags");
                $this->setUserId($ilUser->getId());
                //$this->setInputFieldName("il_tags");
        }
        
        function setUserId($a_userid)
        {
                $this->userid = $a_userid;
        }

        function getUserId()
        {
                return $this->userid;
        }

        function getHTML()
        {
                global $lng, $ilCtrl;
                
                $ttpl = new ilTemplate("tpl.rating_input.html", true, true, "Services/Rating");
                
                // (1) overall rating
                $rating = ilRating::getOverallRatingForObject($this->obj_id, $this->obj_type,
                        $this->sub_obj_id, $this->sub_obj_type);
                if ($rating["cnt"] >= 1)
                {
                        for($i = 1; $i <= 5; $i++)
                        {
                                $ttpl->setCurrentBlock("rating_icon");
                                if ($rating["avg"] >= $i)
                                {
                                        $ttpl->setVariable("SRC_ICON",
                                                ilUtil::getImagePath("icon_rate_on.gif"));
                                }
                                else if ($rating["avg"] + 1 <= $i)
                                {
                                        $ttpl->setVariable("SRC_ICON",
                                                ilUtil::getImagePath("icon_rate_off.gif"));
                                }
                                else
                                {
                                        $nr = round(($rating["avg"] + 1 - $i) * 10);
                                        $ttpl->setVariable("SRC_ICON",
                                                ilUtil::getImagePath("icon_rate_$nr.gif"));
                                }
                                $ttpl->setVariable("ALT_ICON", "(".$i."/5)");
                                $ttpl->parseCurrentBlock();
                        }
                        $ttpl->setCurrentBlock("rating_icon");
                        $ttpl->setVariable("TXT_OVERALL_RATING", $lng->txt("rating_average_rating"));
                        $ttpl->setVariable("NR_USERS",
                                sprintf($lng->txt("rating_nr_users"), $rating["cnt"]));
                        $ttpl->setVariable("VAL_OVERALL_RATING", "(".round($rating["avg"], 1)."/5)");
                        $ttpl->parseCurrentBlock();
                }
                
                // (2) user rating
                if ($this->getUserId() != ANONYMOUS_USER_ID)
                {
                        $rating = ilRating::getRatingForUserAndObject($this->obj_id, $this->obj_type,
                                $this->sub_obj_id, $this->sub_obj_type, $this->getUserId());
                        
                        // user rating links
                        for($i = 1; $i <= 5; $i++)
                        {
                                $ttpl->setCurrentBlock("rating_link");
                                $ilCtrl->setParameter($this, "rating", $i);
                                $ttpl->setVariable("HREF_RATING", $ilCtrl->getLinkTarget($this, "saveRating"));
                                if ($rating >= $i)
                                {
                                        $ttpl->setVariable("SRC_ICON",
                                                ilUtil::getImagePath("icon_rate_on.gif"));
                                }
                                else
                                {
                                        $ttpl->setVariable("SRC_ICON",
                                                ilUtil::getImagePath("icon_rate_off.gif"));
                                }
                                $ttpl->setVariable("ALT_ICON", "(".$i."/5)");
                                $ttpl->parseCurrentBlock();
                        }
                        $ttpl->setCurrentBlock("user_rating");
                                
                        // user rating text
                        $ttpl->setVariable("TXT_YOUR_RATING", $lng->txt("rating_your_rating"));
                        if ($rating > 0)
                        {
                                $ttpl->setVariable("VAL_RATING", "(".$rating."/5)");
                        }
                        $ttpl->parseCurrentBlock();
                }
                
                return $ttpl->get();
        }
        
        function saveRating()
        {
                ilRating::writeRatingForUserAndObject($this->obj_id, $this->obj_type,
                        $this->sub_obj_id, $this->sub_obj_type, $this->getUserId(),
                        ilUtil::stripSlashes($_GET["rating"]));
        }
}

?>