class.ilExerciseMembers.php

Go to the documentation of this file.

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

class ilExerciseMembers
{
        var $ref_id;
        var $obj_id;
        var $members;
        var $status;
//      var $status_feedback;
//      var $status_sent;
//      var $status_returned;
//      var $notice;

        function __construct($a_exc)
        {
                $this->exc = $a_exc;
                $this->obj_id = $a_exc->getId();
                $this->ref_id = $a_exc->getRefId();
                $this->read();
        }

        function getRefId()
        {
                return $this->ref_id;
        }

        function getObjId()
        {
                return $this->obj_id;
        }
        
        function setObjId($a_obj_id)
        {
                $this->obj_id = $a_obj_id;
        }

        function getMembers()
        {
                return $this->members ? $this->members : array();
        }
        
        function setMembers($a_members)
        {
                $this->members = $a_members;
        }

        function assignMember($a_usr_id)
        {
                global $ilDB;

                if($this->exc->hasAddToDesktop())
                {
                        $tmp_user = ilObjectFactory::getInstanceByObjId($a_usr_id);
                        $tmp_user->addDesktopItem($this->getRefId(),"exc");
                }

                $ilDB->manipulate("DELETE FROM exc_members ".
                        "WHERE obj_id = ".$ilDB->quote($this->getObjId(), "integer")." ".
                        "AND usr_id = ".$ilDB->quote($a_usr_id, "integer")." ");

// @todo: some of this fields may not be needed anymore
                $ilDB->manipulateF("INSERT INTO exc_members (obj_id, usr_id, status, sent, feedback) ".
                        " VALUES (%s,%s,%s,%s,%s)",
                        array("integer", "integer", "text", "integer", "integer"),
                        array($this->getObjId(), $a_usr_id, 'notgraded', 0, 0));

                include_once("./Modules/Exercise/classes/class.ilExAssignment.php");
                ilExAssignment::createNewUserRecords($a_usr_id, $this->getObjId());
                
                $this->read();
                
                include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
                ilLPStatusWrapper::_updateStatus($this->getObjId(), $a_usr_id);

                return true;
        }
        
        function isAssigned($a_id)
        {
                return in_array($a_id,$this->getMembers());
        }

        function assignMembers($a_members)
        {
                $assigned = 0;
                if(is_array($a_members))
                {
                        foreach($a_members as $member)
                        {
                                if(!$this->isAssigned($member))
                                {
                                        $this->assignMember($member);
                                }
                                else
                                {
                                        ++$assigned;
                                }
                        }
                }
                if($assigned == count($a_members))
                {
                        return false;
                }
                else
                {
                        return true;
                }
        }

        function deassignMember($a_usr_id)
        {
                global $ilDB;

                $tmp_user = ilObjectFactory::getInstanceByObjId($a_usr_id);
                $tmp_user->dropDesktopItem($this->getRefId(),"exc");

                $query = "DELETE FROM exc_members ".
                        "WHERE obj_id = ".$ilDB->quote($this->getObjId(), "integer")." ".
                        "AND usr_id = ".$ilDB->quote($a_usr_id, "integer")." ";

                $ilDB->manipulate($query);
                
                $this->read();
                
                include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
                ilLPStatusWrapper::_updateStatus($this->getObjId(), $a_usr_id);
                
                // delete all delivered files of the member
                include_once("./Modules/Exercise/classes/class.ilExSubmission.php");
                ilExSubmission::deleteUser($this->exc->getId(), $a_usr_id);

// @todo: delete all assignment associations (and their files)
                
                return false;
        }

        function deassignMembers($a_members)
        {
                if(is_array($a_members))
                {
                        foreach($a_members as $member)
                        {
                                $this->deassignMember($member);
                        }
                }
                else
                {
                        return false;
                }
        }

        function read()
        {
                global $ilDB;

                $tmp_arr_members = array();

                $query = "SELECT * FROM exc_members ".
                        "WHERE obj_id = ".$ilDB->quote($this->getObjId(), "integer");

                $res = $ilDB->query($query);
                while($row = $ilDB->fetchObject($res))
                {
                        $tmp_arr_members[] = $row->usr_id;
                }
                $this->setMembers($tmp_arr_members);

                return true;
        }

// @todo: clone also assignments
        function ilClone($a_new_id)
        {
                global $ilDB;

                $data = array();

                $query = "SELECT * FROM exc_members ".
                        "WHERE obj_id = ".$ilDB->quote($this->getObjId(), "integer");

                $res = $ilDB->query($query);
                while($row = $ilDB->fetchObject($res))
                {
                        $data[] = array("usr_id" => $row->usr_id,
                                                        "notice" => $row->notice,
                                                        "returned" => $row->returned,
                                                        "status" => $row->status,
                                                        "sent"   => $row->sent,
                                                        "feedback"       => $row->feedback
                                                        );
                }
                foreach($data as $row)
                {
                        $ilDB->manipulateF("INSERT INTO exc_members ".
                                " (obj_id, usr_id, notice, returned, status, feedback, sent) VALUES ".
                                " (%s,%s,%s,%s,%s,%s,%s)",
                                array ("integer", "integer", "text", "integer", "text", "integer", "integer"),
                                array ($a_new_id, $row["usr_id"], $row["notice"], (int) $row["returned"],
                                        $row["status"], (int) $row["feedback"], (int) $row["sent"])
                                        );
                        
                        include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
                        ilLPStatusWrapper::_updateStatus($a_new_id, $row["usr_id"]);
                }
                return true;
        }

// @todo: delete also assignments
        function delete()
        {
                global $ilDB;

                $query = "DELETE FROM exc_members WHERE obj_id = ".
                        $ilDB->quote($this->getObjId(), "integer");
                $ilDB->manipulate($query);
                
                include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
                ilLPStatusWrapper::_refreshStatus($this->getObjId());

                return true;
        }

        static function _getMembers($a_obj_id)
        {
                global $ilDB;

                // #14963 - see ilExAssignment::getMemberListData()
                $query = "SELECT DISTINCT(excm.usr_id) ud".
                        " FROM exc_members excm".
                        " JOIN object_data od ON (od.obj_id = excm.usr_id)".
                        " WHERE excm.obj_id = ".$ilDB->quote($a_obj_id, "integer").
                        " AND od.type = ".$ilDB->quote("usr", "text");

                $res = $ilDB->query($query);
                while($row = $ilDB->fetchObject($res))
                {
                        $usr_ids[] = $row->ud;
                }

                return $usr_ids ? $usr_ids : array();
        }

        static function _lookupStatus($a_obj_id, $a_user_id)
        {
                global $ilDB;

                $query = "SELECT status FROM exc_members ".
                        "WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer").
                        " AND usr_id = ".$ilDB->quote($a_user_id, "integer");

                $res = $ilDB->query($query);
                if($row = $ilDB->fetchAssoc($res))
                {
                        return $row["status"];
                }

                return false;
        }

        static function _writeStatus($a_obj_id, $a_user_id, $a_status)
        {
                global $ilDB;
                
                $ilDB->manipulate("UPDATE exc_members SET ".
                        " status = ".$ilDB->quote($a_status, "text").
                        " WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer").
                        " AND usr_id = ".$ilDB->quote($a_user_id, "integer")
                        );
                
                include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
                ilLPStatusWrapper::_updateStatus($a_obj_id, $a_user_id);
        }
        
        static function _writeReturned($a_obj_id, $a_user_id, $a_status)
        {
                global $ilDB;
                
                $ilDB->manipulate("UPDATE exc_members SET ".
                        " returned = ".$ilDB->quote($a_status, "integer").
                        " WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer").
                        " AND usr_id = ".$ilDB->quote($a_user_id, "integer")
                        );
                
                include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
                ilLPStatusWrapper::_updateStatus($a_obj_id, $a_user_id);
        }
        
        
        // 
        // LP
        //
        
        static function _getReturned($a_obj_id)
        {
                global $ilDB;

                $query = "SELECT DISTINCT(usr_id) as ud FROM exc_members ".
                        "WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer")." ".
                        "AND returned = 1";

                $res = $ilDB->query($query);
                while($row = $ilDB->fetchObject($res))
                {
                        $usr_ids[] = $row->ud;
                }

                return $usr_ids ? $usr_ids : array();
        }

        static function _hasReturned($a_obj_id, $a_user_id)
        {
                global $ilDB;
        
                $set = $ilDB->query("SELECT DISTINCT(usr_id) FROM exc_members WHERE ".
                        " obj_id = ".$ilDB->quote($a_obj_id, "integer")." AND ".
                        " returned = ".$ilDB->quote(1, "integer")." AND ".
                        " usr_id = ".$ilDB->quote($a_user_id, "integer")
                        );
                if ($rec = $ilDB->fetchAssoc($set))
                {
                        return true;
                }
                return false;
        }

        static function _getPassedUsers($a_obj_id)
        {
                global $ilDB;

                $query = "SELECT DISTINCT(usr_id) FROM exc_members ".
                        "WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer")." ".
                        "AND status = ".$ilDB->quote("passed", "text");
                $res = $ilDB->query($query);
                while($row = $ilDB->fetchObject($res))
                {
                        $usr_ids[] = $row->usr_id;
                }
                return $usr_ids ? $usr_ids : array();
        }

        static function _getFailedUsers($a_obj_id)
        {
                global $ilDB;

                $query = "SELECT DISTINCT(usr_id) FROM exc_members ".
                        "WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer")." ".
                        "AND status = ".$ilDB->quote("failed", "text");
                $res = $ilDB->query($query);
                while($row = $ilDB->fetchObject($res))
                {
                        $usr_ids[] = $row->usr_id;
                }
                return $usr_ids ? $usr_ids : array();
        }

} //END class.ilObjExercise
?>