class.ilObjPoll.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once "Services/Object/classes/class.ilObject2.php";
require_once "Services/Object/classes/class.ilObjectActivation.php";

class ilObjPoll extends ilObject2
{
        protected $online; // [bool]
        protected $access_type; // [int]
        protected $access_begin; // [timestamp]
        protected $access_end; // [timestamp]
        protected $access_visibility; // [bool]
        protected $question; // [string]
        protected $image; // [string]
        protected $view_results; // [int]
        protected $period; // [bool]
        protected $period_begin; // [timestamp]
        protected $period_end; // [timestamp]
        
        // 4.5
        protected $max_number_answers = 1; // [int]
        protected $result_sort_by_votes = false; // [bool]
        protected $mode_non_anonymous = false; // [bool]
    protected $show_comments = false; //[bool]
    protected $show_results_as = 1; //[int]
        
        const VIEW_RESULTS_ALWAYS = 1;
        const VIEW_RESULTS_NEVER = 2;
        const VIEW_RESULTS_AFTER_VOTE = 3;
        const VIEW_RESULTS_AFTER_PERIOD = 4;

        const SHOW_RESULTS_AS_BARCHART = 1;
        const SHOW_RESULTS_AS_PIECHART = 2;
        
        function __construct($a_id = 0, $a_reference = true) 
        {
                // default
                $this->setOnline(false);
                $this->setViewResults(self::VIEW_RESULTS_AFTER_VOTE);
                $this->setAccessType(ilObjectActivation::TIMINGS_DEACTIVATED);
                $this->setVotingPeriod(false);
                
                parent::__construct($a_id, $a_reference);                       
        }
        
        function initType()
        {
                $this->type = "poll";
        }
        
        function setOnline($a_value)
        {
                $this->online = (bool)$a_value;
        }
        
        function isOnline()
        {
                return $this->online;
        }
        
        function setAccessType($a_value)
        {
                $this->access_type = (int)$a_value;
        }
        
        function getAccessType()
        {
                return $this->access_type;
        }
        
        function setAccessBegin($a_value)
        {
                $this->access_begin = (int)$a_value;
        }
        
        function getAccessBegin()
        {
                return $this->access_begin;
        }
        
        function setAccessEnd($a_value)
        {
                $this->access_end = (int)$a_value;
        }
        
        function getAccessEnd()
        {
                return $this->access_end;
        }
        
        function setAccessVisibility($a_value)
        {
                $this->access_visibility = (bool)$a_value;
        }
        
        function getAccessVisibility()
        {
                return $this->access_visibility;
        }
        
        function setQuestion($a_value)
        {
                $this->question = (string)$a_value;
        }
        
        function getQuestion()
        {
                return $this->question;
        }
        
        function setImage($a_value)
        {
                $this->image = (string)$a_value;
        }
        
        function getImage()
        {
                return $this->image;
        }
        
        function setViewResults($a_value)
        {
                $this->view_results = (int)$a_value;
        }
        
        function getViewResults()
        {
                return $this->view_results;
        }
        
        function setVotingPeriod($a_value)
        {
                $this->period = (bool)$a_value;
        }
        
        function getVotingPeriod()
        {
                return $this->period;
        }
        
        function setVotingPeriodBegin($a_value)
        {
                $this->period_begin = (int)$a_value;
        }
        
        function getVotingPeriodBegin()
        {
                return $this->period_begin;
        }
        
        function setVotingPeriodEnd($a_value)
        {
                $this->period_end = (int)$a_value;
        }
        
        function getVotingPeriodEnd()
        {
                return $this->period_end;
        }
        
        function setMaxNumberOfAnswers($a_value)
        {
                $this->max_number_answers = (int)$a_value;
        }
        
        function getMaxNumberOfAnswers()
        {
                return $this->max_number_answers;
        }
        
        function setSortResultByVotes($a_value)
        {
                $this->result_sort_by_votes = (bool)$a_value;
        }
        
        function getSortResultByVotes()
        {
                return $this->result_sort_by_votes;
        }
        
        function setNonAnonymous($a_value)
        {
                $this->mode_non_anonymous = (bool)$a_value;
        }
        
        function getNonAnonymous()
        {
                return $this->mode_non_anonymous;
        }

        function setShowComments($a_value)
        {
        $this->show_comments = (bool)$a_value;
        }

        function getShowComments()
        {
                return $this->show_comments;
        }

        function setShowResultsAs($a_value)
        {
                $this->show_results_as = (int)$a_value;
        }

        function getShowResultsAs()
        {
                return $this->show_results_as;
        }

        protected function doRead()
        {
                global $ilDB;

                $set = $ilDB->query("SELECT * FROM il_poll".
                                " WHERE id = ".$ilDB->quote($this->getId(), "integer"));
                $row = $ilDB->fetchAssoc($set);
                $this->setQuestion($row["question"]);
                $this->setImage($row["image"]);
                $this->setOnline($row["online_status"]);
                $this->setViewResults($row["view_results"]);
                $this->setVotingPeriod($row["period"]);
                $this->setVotingPeriodBegin($row["period_begin"]);
                $this->setVotingPeriodEnd($row["period_end"]);
                $this->setMaxNumberOfAnswers($row["max_answers"]);
                $this->setSortResultByVotes($row["result_sort"]);
                $this->setNonAnonymous($row["non_anon"]);       
                $this->setShowResultsAs($row["show_results_as"]);
                
                // #14661
                include_once("./Services/Notes/classes/class.ilNote.php");
                $this->setShowComments(ilNote::commentsActivated($this->getId(), 0, $this->getType()));                         
                
                if($this->ref_id)
                {
                        $activation = ilObjectActivation::getItem($this->ref_id);                       
                        $this->setAccessType($activation["timing_type"]);
                        if($this->getAccessType() == ilObjectActivation::TIMINGS_ACTIVATION)
                        {
                                // default entry values should not be loaded if not activated
                                $this->setAccessBegin($activation["timing_start"]);
                                $this->setAccessEnd($activation["timing_end"]);                                                 
                                $this->setAccessVisibility($activation["visible"]);                                                     
                        }
                }
        }
        
        protected function propertiesToDB()
        {
                $fields = array(
                        "question" => array("text", $this->getQuestion()),
                        "image" => array("text", $this->getImage()),
                        "online_status" => array("integer", $this->isOnline()),
                        "view_results" => array("integer", $this->getViewResults()),
                        "period" => array("integer", $this->getVotingPeriod()),
                        "period_begin" => array("integer", $this->getVotingPeriodBegin()),
                        "period_end" => array("integer", $this->getVotingPeriodEnd()),
                        "max_answers" => array("integer", $this->getMaxNumberOfAnswers()),
                        "result_sort" => array("integer", $this->getSortResultByVotes()),
                        "non_anon" => array("integer", $this->getNonAnonymous()),               
                        "show_results_as" => array("integer", $this->getShowResultsAs()),
                );
                                                
                return $fields;
        }

        protected function doCreate()
        {
                global $ilDB;
                
                if($this->getId())
                {
                        $fields = $this->propertiesToDB();
                        $fields["id"] = array("integer", $this->getId());

                        $ilDB->insert("il_poll", $fields);
                        
                        
                        // object activation default entry will be created on demand
                        
                        
                        // block handling                       
                        include_once "Modules/Poll/classes/class.ilPollBlock.php";
                        $block = new ilPollBlock();
                        $block->setType("poll");                
                        $block->setContextObjId($this->getId());
                        $block->setContextObjType("poll");
                        $block->create();
                }
        }
                
        protected function doUpdate()
        {
                global $ilDB;
        
                if($this->getId())
                {
                        $fields = $this->propertiesToDB();
                        
                        $ilDB->update("il_poll", $fields,
                                array("id"=>array("integer", $this->getId())));                 
                        
                        // #14661
                        include_once("./Services/Notes/classes/class.ilNote.php");
                        ilNote::activateComments($this->getId(), 0, $this->getType(), $this->getShowComments());
                        
                        if($this->ref_id)
                        {
                                $activation = new ilObjectActivation();
                                $activation->setTimingType($this->getAccessType());
                                $activation->setTimingStart($this->getAccessBegin());
                                $activation->setTimingEnd($this->getAccessEnd());
                                $activation->toggleVisible($this->getAccessVisibility());
                                $activation->update($this->ref_id);
                        }
                        
                }
        }
        
        protected function doDelete()
        {
                global $ilDB;
                
                if($this->getId())
                {               
                        $this->deleteImage();
                        $this->deleteAllAnswers();
                        
                        if($this->ref_id)
                        {
                                ilObjectActivation::deleteAllEntries($this->ref_id);
                        }
                        
                        $ilDB->manipulate("DELETE FROM il_poll".
                                " WHERE id = ".$ilDB->quote($this->id, "integer"));
                }
        }
        
        public function doCloneObject($new_obj, $a_target_id, $a_copy_id = 0)
        {               
                assert($new_obj instanceof ilObjPoll);
                
                // question/image
                $new_obj->setQuestion($this->getQuestion());            
                $image = $this->getImageFullPath();
                if($image)
                {
                        $image = array("tmp_name"=>$image,
                                "name"=>$this->getImage());             
                        $new_obj->uploadImage($image, true);
                }

                //copy online status if object is not the root copy object
                $cp_options = ilCopyWizardOptions::_getInstance($a_copy_id);

                if(!$cp_options->isRootNode($this->getRefId()))
                {
                        $new_obj->setOnline($this->isOnline());
                }

                $new_obj->setViewResults($this->getViewResults());
                $new_obj->setShowComments($this->getShowComments());
                $new_obj->setShowResultsAs($this->getShowResultsAs());
                $new_obj->update();
                
                // answers
                $answers = $this->getAnswers();
                if($answers)
                {
                        foreach($answers as $item)
                        {
                           $new_obj->saveAnswer($item["answer"]);                                       
                        }                                               
                }                               
                
                return $new_obj;
        }
                
        
        //
        // image
        // 
        
        function getImageFullPath($a_as_thumb = false)
        {               
                $img = $this->getImage();
                if($img)
                {
                        $path = $this->initStorage($this->id);
                        if(!$a_as_thumb)
                        {
                                return $path.$img;
                        }
                        else
                        {
                                return $path."thb_".$img;
                        }
                }
        }
        
        public function deleteImage()
        {
                if($this->id)
                {
                        include_once "Modules/Poll/classes/class.ilFSStoragePoll.php";
                        $storage = new ilFSStoragePoll($this->id);
                        $storage->delete();
                        
                        $this->setImage(null);
                }
        }

        public static function initStorage($a_id, $a_subdir = null)
        {               
                include_once "Modules/Poll/classes/class.ilFSStoragePoll.php";
                $storage = new ilFSStoragePoll($a_id);
                $storage->create();
                
                $path = $storage->getAbsolutePath()."/";
                
                if($a_subdir)
                {
                        $path .= $a_subdir."/";
                        
                        if(!is_dir($path))
                        {
                                mkdir($path);
                        }
                }
                                
                return $path;
        }
        
        function uploadImage(array $a_upload, $a_clone = false)
        {
                if(!$this->id)
                {
                        return false;
                }
                
                $this->deleteImage();
                
                // #10074
                $clean_name = preg_replace("/[^a-zA-Z0-9\_\.\-]/", "", $a_upload["name"]);
        
                $path = $this->initStorage($this->id);
                $original = "org_".$this->id."_".$clean_name;
                $thumb = "thb_".$this->id."_".$clean_name;
                $processed = $this->id."_".$clean_name;
                
                $success = false;
                if(!$a_clone)
                {
                        $success = ilUtil::moveUploadedFile($a_upload["tmp_name"], $original, $path.$original);
                }
                else
                {
                        $success = copy($a_upload["tmp_name"], $path.$original);
                }
                
                if($success)
                {
                        chmod($path.$original, 0770);

                        // take quality 100 to avoid jpeg artefacts when uploading jpeg files
                        // taking only frame [0] to avoid problems with animated gifs
                        $original_file = ilUtil::escapeShellArg($path.$original);
                        $thumb_file = ilUtil::escapeShellArg($path.$thumb);
                        $processed_file = ilUtil::escapeShellArg($path.$processed);
                        ilUtil::execConvert($original_file."[0] -geometry \"100x100>\" -quality 100 PNG:".$thumb_file);
                        ilUtil::execConvert($original_file."[0] -geometry \"".self::getImageSize().">\" -quality 100 PNG:".$processed_file);
                        
                        $this->setImage($processed);
                        return true;
                }
                return false;
        }       
        
        public static function getImageSize()
        {
                // :TODO:
                return "300x300";
        }
        
        
        //
        // Answer
        // 
        
        function getAnswers()
        {
                global $ilDB;
                
                $res = array();
                
                $sql = "SELECT * FROM il_poll_answer".
                        " WHERE poll_id = ".$ilDB->quote($this->getId(), "integer").
                        " ORDER BY pos ASC";
                $set = $ilDB->query($sql);
                while($row = $ilDB->fetchAssoc($set))
                {
                        $res[] = $row;
                }
                return $res;
        }
        
        function getAnswer($a_id)
        {
                global $ilDB;
                
                $sql = "SELECT * FROM il_poll_answer".
                        " WHERE id = ".$ilDB->quote($a_id, "integer");
                $set = $ilDB->query($sql);
                return (array)$ilDB->fetchAssoc($set);
        }       
        
        function saveAnswer($a_text, $a_pos = null)
        {
                global $ilDB;
                
                if(!trim($a_text))
                {
                        return;
                }
                
                $id = $ilDB->nextId("il_poll_answer");
                
                if(!$a_pos)
                {
                        // append
                        $sql = "SELECT max(pos) pos".
                                " FROM il_poll_answer".
                                " WHERE poll_id = ".$ilDB->quote($this->getId(), "integer");
                        $set = $ilDB->query($sql);
                        $a_pos = $ilDB->fetchAssoc($set);
                        $a_pos = (int)$a_pos["pos"]+10;         
                }
                
                $fields = array(
                        "id" => array("integer", $id),
                        "poll_id" => array("integer", $this->getId()),
                        "answer" => array("text", trim($a_text)),
                        "pos" => array("integer", $a_pos)
                );                              
                $ilDB->insert("il_poll_answer", $fields);       
                
                return $id;
        }
        
        function updateAnswer($a_id, $a_text)
        {
                global $ilDB;
                                        
                $ilDB->update("il_poll_answer",
                        array("answer" => array("text", $a_text)),
                        array("id" => array("integer", $a_id)));        
        }
        
        function rebuildAnswerPositions()
        {
                $answers = $this->getAnswers();
                
                $pos = array();
                foreach($answers as $item)
                {
                        $pos[$item["id"]] = $item["pos"];
                }
                
                $this->updateAnswerPositions($pos);
        }
        
        function updateAnswerPositions(array $a_pos)
        {
                global $ilDB;
                
                asort($a_pos);
                
                $pos = 0;
                foreach(array_keys($a_pos) as $id)
                {
                        $pos += 10;
                        
                        $ilDB->update("il_poll_answer",
                                array("pos" => array("integer", $pos)),
                                array("id" => array("integer", $id)));  
                }
        }
        
        function deleteAnswer($a_id)
        {
                global $ilDB;
                
                if($a_id)
                {
                        $ilDB->manipulate("DELETE FROM il_poll_vote".
                                " WHERE answer_id = ".$ilDB->quote($this->getId(), "integer"));
                        
                        $ilDB->manipulate("DELETE FROM il_poll_answer".
                                " WHERE id = ".$ilDB->quote($a_id, "integer"));
                }
        }
        
        protected function deleteAllAnswers()
        {
                global $ilDB;
                
                if($this->getId())
                {
                        $this->deleteAllVotes();
                        
                        $ilDB->manipulate("DELETE FROM il_poll_answer".
                                " WHERE poll_id = ".$ilDB->quote($this->getId(), "integer"));
                }
        }
        
        public function deleteAllVotes()
        {
                global $ilDB;
                
                if($this->getId())
                {
                        $ilDB->manipulate("DELETE FROM il_poll_vote".
                                " WHERE poll_id = ".$ilDB->quote($this->getId(), "integer"));
                }                       
        }
                
        function saveAnswers(array $a_answers)
        {
                $existing = $this->getAnswers();
                                                
                $ids = array();
                $pos = 0;
                foreach($a_answers as $answer)
                {
                        if(trim($answer))
                        {
                                // existing answer?
                                $found = false;
                                foreach($existing as $idx => $item)
                                {
                                        if(trim($answer) == $item["answer"])
                                        {
                                                $found = true;                                  
                                                unset($existing[$idx]);

                                                $id = $item["id"];
                                        }
                                }

                                // create new answer
                                if(!$found)
                                {
                                        $id = $this->saveAnswer($answer);
                                }

                                // add existing answer id to order
                                if($id)
                                {                               
                                        $ids[$id] = ++$pos;
                                }
                        }
                }                       
                
                // remove obsolete answers
                if(sizeof($existing))
                {
                        foreach($existing as $item)
                        {
                                $this->deleteAnswer($item["id"]);
                        }
                }
                
                // save current order
                if(sizeof($ids))
                {
                        $this->updateAnswerPositions($ids);
                }
                
                return sizeof($ids);
        }
        
        
        //
        // votes
        //
        
        function saveVote($a_user_id, $a_answers)
        {
                global $ilDB;
                
                if($this->hasUserVoted($a_user_id))
                {
                        return;
                }
                
                if(!is_array($a_answers))
                {
                        $a_answers = array($a_answers);
                }
                
                foreach($a_answers as $answer_id)
                {
                        $fields = array("user_id" => array("integer", $a_user_id),
                                "poll_id" => array("integer", $this->getId()),
                                "answer_id" => array("integer", $answer_id));
                        $ilDB->insert("il_poll_vote", $fields);
                }                               
        }
        
        function hasUserVoted($a_user_id)
        {
                global $ilDB;
                
                $sql = "SELECT user_id".
                        " FROM il_poll_vote".
                        " WHERE poll_id = ".$ilDB->quote($this->getId(), "integer").
                        " AND user_id = ".$ilDB->quote($a_user_id, "integer");
                $ilDB->setLimit(1);
            $set = $ilDB->query($sql);
                return (bool)$ilDB->numRows($set);
        }
        
        function countVotes()
        {
                global $ilDB;
                
                $sql = "SELECT COUNT(DISTINCT(user_id)) cnt".
                        " FROM il_poll_vote".
                        " WHERE poll_id = ".$ilDB->quote($this->getId(), "integer");
                $set = $ilDB->query($sql);
                $row = $ilDB->fetchAssoc($set);
                return (int)$row["cnt"];
        }
        
        function getVotePercentages()
        {
                global $ilDB;
                
                $res = array();
                $cnt = 0;
                
                $sql = "SELECT answer_id, count(*) cnt".
                        " FROM il_poll_vote".
                        " WHERE poll_id = ".$ilDB->quote($this->getId(), "integer").
                        " GROUP BY answer_id";
                $set = $ilDB->query($sql);
                while($row = $ilDB->fetchAssoc($set))
                {
                        $cnt += $row["cnt"];
                        $res[$row["answer_id"]] = array("abs"=>$row["cnt"], "perc"=>0);
                }
                
                foreach($res as $id => $item)
                {
                        $res[$id]["perc"] = $item["abs"]/$cnt*100;
                }
                
                return array("perc"=>$res, "total"=>$this->countVotes());
        }       
        
        public function getVotesByUsers()
        {
                global $ilDB;
                
                $res = array();
                
                $sql = "SELECT answer_id, user_id, firstname, lastname, login".
                        " FROM il_poll_vote".
                        " JOIN usr_data ON (usr_data.usr_id = il_poll_vote.user_id)".
                        " WHERE poll_id = ".$ilDB->quote($this->getId(), "integer");
                $set = $ilDB->query($sql);
                while($row = $ilDB->fetchAssoc($set))
                {                       
                        if(!isset($res[$row["user_id"]]))
                        {
                                $res[$row["user_id"]] = $row;
                        }                       
                        $res[$row["user_id"]]["answers"][] = $row["answer_id"];
                }
        
                return $res;
        }
}

?>