class.ilRatingGUI.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2011 ILIAS open source, Extended GPL, see docs/LICENSE */

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

class ilRatingGUI
{
        protected $id = "rtg_";

        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->id = "rtg_".$this->obj_id."_".$this->obj_type."_".$this->sub_obj_id."_".
                        $this->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 setYourRatingText($a_val)
        {
                $this->your_rating_text = $a_val;
        }
        
        function getYourRatingText()
        {
                return $this->your_rating_text;
        }

        function getHTML()
        {
                global $lng, $ilCtrl;

                $ttpl = new ilTemplate("tpl.rating_input.html", true, true, "Services/Rating");

                // user rating
                $user_rating = 0;
                if ($this->getUserId() != ANONYMOUS_USER_ID)
                {
                        $user_rating = ilRating::getRatingForUserAndObject($this->obj_id, $this->obj_type,
                                $this->sub_obj_id, $this->sub_obj_type, $this->getUserId());
                }

                
                // (1) overall rating
                $rating = ilRating::getOverallRatingForObject($this->obj_id, $this->obj_type,
                        $this->sub_obj_id, $this->sub_obj_type);

                for($i = 1; $i <= 5; $i++)
                {
                        if ($i == $user_rating)
                        {
                                $ttpl->setCurrentBlock("rating_mark");
                                $ttpl->setVariable("SRC_MARK",
                                        ilUtil::getImagePath("icon_rate_marker.png"));
                                $ttpl->parseCurrentBlock();
                        }

                        $ttpl->setCurrentBlock("rating_icon");
                        if ($rating["avg"] >= $i)
                        {
                                $ttpl->setVariable("SRC_ICON",
                                        ilUtil::getImagePath("icon_rate_on.png"));
                        }
                        else if ($rating["avg"] + 1 <= $i)
                        {
                                $ttpl->setVariable("SRC_ICON",
                                        ilUtil::getImagePath("icon_rate_off.png"));
                        }
                        else
                        {
                                $nr = round(($rating["avg"] + 1 - $i) * 10);
                                $ttpl->setVariable("SRC_ICON",
                                        ilUtil::getImagePath("icon_rate_$nr.png"));
                        }
                        $ttpl->setVariable("ALT_ICON", "(".$i."/5)");
                        $ttpl->parseCurrentBlock();
                }
                $ttpl->setCurrentBlock("rating_icon");
                if ($rating["cnt"] == 0)
                {
                        $tt = $lng->txt("rat_not_rated_yet");
                }
                else if ($rating["cnt"] == 1)
                {
                        $tt = $lng->txt("rat_one_rating");
                }
                else
                {
                        $tt =
                                sprintf($lng->txt("rat_nr_ratings"), $rating["cnt"]);
                }
                include_once("./Services/UIComponent/Tooltip/classes/class.ilTooltipGUI.php");
                ilTooltipGUI::addTooltip($this->id."_tt", $tt);
                if ($rating["cnt"] > 0)
                {
                        $ttpl->setCurrentBlock("rat_nr");
                        $ttpl->setVariable("RT_NR", $rating["cnt"]);
                        $ttpl->parseCurrentBlock();
                }

                if ($this->getUserId() != ANONYMOUS_USER_ID)
                {
                        include_once("./Services/UIComponent/Overlay/classes/class.ilOverlayGUI.php");
                        $ov = new ilOverlayGUI($this->id);
                        $ov->setTrigger("tr_".$this->id, "click", "tr_".$this->id);
                        $ov->add();
                        
                        $ttpl->setCurrentBlock("act_rat_start");
                        $ttpl->setVariable("ID", $this->id);
                        $ttpl->setVariable("SRC_ARROW", ilUtil::getImagePath("mm_down_arrow_dark.gif"));
                        $ttpl->parseCurrentBlock();

                        //$ttpl->touchBlock("act_rat_end");
                        $ttpl->setCurrentBlock("act_rat_end");
                        $ttpl->setVariable("SRC_ARROW", ilUtil::getImagePath("mm_down_arrow_dark.gif"));
                        $ttpl->parseCurrentBlock();
                }

                $ttpl->parseCurrentBlock();
                
                // (2) user rating
                if ($this->getUserId() != ANONYMOUS_USER_ID)
                {
                        $rating = $user_rating;
                        
                        // 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.png"));
                                }
                                else
                                {
                                        $ttpl->setVariable("SRC_ICON",
                                                ilUtil::getImagePath("icon_rate_off.png"));
                                }
                                $ttpl->setVariable("ALT_ICON", "(".$i."/5)");
                                $ttpl->parseCurrentBlock();
                        }
                        $ttpl->setCurrentBlock("user_rating");
                        $ttpl->setVariable("ID", $this->id);
                        
                        // user rating text
                        $rate_text = ($this->getYourRatingText() != "")
                                ? $this->getYourRatingText()
                                : $lng->txt("rating_your_rating");
                        $ttpl->setVariable("TXT_YOUR_RATING", $rate_text);
                        $ttpl->parseCurrentBlock();
                }

                $ttpl->setVariable("TTID", $this->id);

                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"]));
        }
}

?>