course/classes/class.ilObjCourseGrouping.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2005 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. |
        +-----------------------------------------------------------------------------+
*/

require_once "./classes/class.ilObject.php";

class ilObjCourseGrouping
{
        var $db;

        function ilObjCourseGrouping($a_id = 0)
        {
                global $ilDB;

                $this->setType('crsg');
                $this->db =& $ilDB;

                $this->setId($a_id);

                if($a_id)
                {
                        $this->read();
                }
        }
        function setId($a_id)
        {
                $this->id = $a_id;
        }
        function getId()
        {
                return $this->id;
        }

        function setContainerRefId($a_ref_id)
        {
                $this->ref_id = $a_ref_id;
        }
        function getContainerRefId()
        {
                return $this->ref_id;
        }
        function setContainerObjId($a_obj_id)
        {
                $this->obj_id = $a_obj_id;
        }
        function getContainerObjId()
        {
                return $this->obj_id;
        }
        function getContainerType()
        {
                return $this->container_type;
        }
        function setContainerType($a_type)
        {
                $this->container_type = $a_type;
        }

        function setType($a_type)
        {
                $this->type = $a_type;
        }
        function getType()
        {
                return $this->type;
        }

        function setTitle($a_title)
        {
                $this->title = $a_title;
        }
        function getTitle()
        {
                return $this->title;
        }
        function setDescription($a_desc)
        {
                $this->description = $a_desc;
        }
        function getDescription()
        {
                return $this->description;
        }
        function setUniqueField($a_uni)
        {
                $this->unique_field = $a_uni;
        }
        function getUniqueField()
        {
                return $this->unique_field;
        }

        function getCountAssignedItems()
        {
                return count($this->getAssignedItems());
        }

        function getAssignedItems()
        {
                global $tree;

                include_once './classes/class.ilConditionHandler.php';
                $condition_data = ilConditionHandler::_getConditionsOfTrigger($this->getType(),$this->getId());
                $conditions = array();
                foreach($condition_data as $condition)
                {
                        if($tree->isDeleted($condition['target_ref_id']))
                        {
                                continue;
                        }
                        $conditions[] = $condition;
                }
                return count($conditions) ? $conditions : array();
        }

        function delete()
        {
                include_once './classes/class.ilConditionHandler.php';

                if($this->getId() and $this->getType() === 'crsg')
                {
                        $query = "DELETE FROM object_data WHERE obj_id = '".$this->getId()."'";
                        $this->db->query($query);

                        $query = "DELETE FROM crs_groupings ".
                                "WHERE crs_grp_id = '".$this->getId()."'";
                        $this->db->query($query);

                        // Delete conditions
                        $condh =& new ilConditionHandler();
                        $condh->deleteByObjId($this->getId());

                        return true;
                }
                return false;
        }

        function create($a_course_ref_id,$a_course_id)
        {
                global $ilUser;

                // INSERT IN object_data
                $query = "INSERT INTO object_data ".
                        "(type,title,description,owner,create_date,last_update,import_id) ".
                        "VALUES ".
                        "('".$this->type."',".$this->db->quote($this->getTitle()).",'".ilUtil::prepareDBString($this->getDescription())."',".
                        "'".$ilUser->getId()."',now(),now(),'')";
                        
                $this->db->query($query);

                // READ this id
                $query = "SELECT LAST_INSERT_ID() as last";
                $res = $this->db->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $this->setId($row->last);
                }


                // INSERT in crs_groupings
                $query = "INSERT INTO crs_groupings ".
                        "SET crs_ref_id = '".$a_course_ref_id."', ".
                        "crs_id = '".$a_course_id."',".
                        "crs_grp_id = '".$this->getId()."', ".
                        "unique_field = '".$this->getUniqueField()."'";

                $this->db->query($query);

                return $this->getId();
        }

        function update()
        {
                if($this->getId() and $this->getType() === 'crsg')
                {
                        // UPDATe object_data
                        $query = "UPDATE object_data ".
                                "SET title = '".ilUtil::prepareDBString($this->getTitle())."', ".
                                "description = '".ilUtil::prepareDBString($this->getDescription())."' ".
                                "WHERE obj_id = '".$this->getId()."' ".
                                "AND type = '".$this->getType()."'";

                        $this->db->query($query);

                        // UPDATE crs_groupings
                        $query = "UPDATE crs_groupings ".
                                "SET unique_field = '".$this->getUniqueField()."' ".
                                "WHERE crs_grp_id = '".$this->getId()."'";

                        $this->db->query($query);

                        // UPDATE conditions
                        $query = "UPDATE conditions ".
                                "SET value = '".$this->getUniqueField()."' ".
                                "WHERE trigger_obj_id = '".$this->getId()."' ".
                                "AND trigger_type = 'crsg'";
                        $this->db->query($query);

                        return true;
                }
                return false;
        }

        function isAssigned($a_course_id)
        {
                foreach($this->getAssignedItems() as $condition_data)
                {
                        if($a_course_id == $condition_data['target_obj_id'])
                        {
                                return true;
                        }
                }
                return false;
        }

        function read()
        {
                global $ilObjDataCache;

                $query = "SELECT * FROM object_data ".
                        "WHERE obj_id = '".$this->getId()."'";

                $res = $this->db->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $this->setTitle($row->title);
                        $this->setDescription($row->description);
                }

                $query = "SELECT * FROM crs_groupings ".
                        "WHERE crs_grp_id = '".$this->getId()."'";
                $res = $this->db->query($query);

                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $this->setUniqueField($row->unique_field);
                        $this->setContainerRefId($row->crs_ref_id);
                        $this->setContainerObjId($row->crs_id);
                        $this->setContainerType($ilObjDataCache->lookupType($this->getContainerObjId()));
                }

                return true;
        }

        function _checkAccess($grouping_id)
        {
                global $ilAccess,$tree;

                $tmp_grouping_obj = new ilObjCourseGrouping($grouping_id);

                $found_invisible = false;
                foreach($tmp_grouping_obj->getAssignedItems() as $condition)
                {
                        if(!$ilAccess->checkAccess('write','',$condition['target_ref_id']))
                        {
                                $found_invisible = true;
                                break;
                        }
                }
                return $found_invisible ? false : true;
        }

        function _getVisibleGroupings($a_obj_id)
        {
                global $ilObjDataCache,$ilAccess,$ilDB;

                $container_type = $ilObjDataCache->lookupType($a_obj_id) == 'grp' ? 'grp' : 'crs';


                // First get all groupings
                $query = "SELECT * FROM object_data WHERE type = 'crsg' ORDER BY title";
                $res = $ilDB->query($query);
                $groupings = array();
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $groupings[] = $row->obj_id;
                }

                //check access
                foreach($groupings as $grouping_id)
                {
                        $tmp_grouping_obj = new ilObjCourseGrouping($grouping_id);

                        // Check container type
                        if($tmp_grouping_obj->getContainerType() != $container_type)
                        {
                                continue;
                        }
                        // Check if container is current container
                        if($tmp_grouping_obj->getContainerObjId() == $a_obj_id)
                        {
                                $visible_groupings[] = $grouping_id;
                                continue;
                        }
                        // check if items are assigned
                        if(count($items = $tmp_grouping_obj->getAssignedItems()))
                        {
                                foreach($items as $condition_data)
                                {
                                        if($ilAccess->checkAccess('write','',$condition_data['target_ref_id']))
                                        {
                                                $visible_groupings[] = $grouping_id;
                                                break;
                                        }
                                }
                                
                        }                               
                }
                return $visible_groupings ? $visible_groupings : array();
        }

        function assign($a_crs_ref_id,$a_course_id)
        {
                // Add the parent course of grouping
                $this->__addCondition($this->getContainerRefId(),$this->getContainerObjId());
                $this->__addCondition($a_crs_ref_id,$a_course_id);

                return true;
        }

        function deassign($a_crs_ref_id,$a_course_id)
        {
                include_once './classes/class.ilConditionHandler.php';


                $condh =& new ilConditionHandler();

                // DELETE also original course if its the last
                if($this->getCountAssignedCourses() == 2)
                {
                        $condh->deleteByObjId($this->getId());

                        return true;
                }
                
                foreach(ilConditionHandler::_getConditionsOfTrigger('crsg',$this->getId()) as $cond_data)
                {

                        if($cond_data['target_ref_id'] == $a_crs_ref_id and
                           $cond_data['target_obj_id'] == $a_course_id)
                        {
                                $condh->deleteCondition($cond_data['id']);
                        }
                }

                return true;
                        
        }
        // PRIVATE
        function __addCondition($a_target_ref_id,$a_target_obj_id)
        {
                include_once './classes/class.ilConditionHandler.php';

                $tmp_condh =& new ilConditionHandler();
                $tmp_condh->enableAutomaticValidation(false);

                $tmp_condh->setTargetRefId($a_target_ref_id);
                $tmp_condh->setTargetObjId($a_target_obj_id);
                $tmp_condh->setTargetType('crs');
                $tmp_condh->setTriggerRefId(0);
                $tmp_condh->setTriggerObjId($this->getId());
                $tmp_condh->setTriggerType('crsg');
                $tmp_condh->setOperator('not_member');
                $tmp_condh->setValue($this->getUniqueField());

                if(!$tmp_condh->checkExists())
                {
                        $tmp_condh->storeCondition();

                        return true;
                }
                return false;
        }
        
        // STATIC
        function _deleteAll($a_course_id)
        {
                global $ilDB;

                // DELETE CONDITIONS
                foreach($groupings = ilObjCourseGrouping::_getGroupings($a_course_id) as $grouping_id)
                {
                        include_once './classes/class.ilConditionHandler.php';

                        $condh =& new ilConditionHandler();
                        $condh->deleteByObjId($grouping_id);
                }

                $query = "DELETE FROM crs_groupings ".
                        "WHERE crs_id = '".$a_course_id."'";

                $ilDB->query($query);

                return true;
        }

        function _getGroupings($a_course_id)
        {
                global $ilDB;

                $query = "SELECT * FROM crs_groupings ".
                        "WHERE crs_id = '".$a_course_id."'";

                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $groupings[] = $row->crs_grp_id;
                }
                return $groupings ? $groupings : array();
        }

        function _isInGrouping($a_crs_id)
        {
                include_once './classes/class.ilConditionHandler.php';

                foreach(ilConditionHandler::_getConditionsOfTarget($a_crs_id,'crs') as $cond)
                {
                        if($cond['operator'] == 'not_member')
                        {
                                return true;
                        }
                }
                return false;
        }

        function _checkCondition($trigger_obj_id,$operator,$value)
        {
                // in the moment i alway return true, there are some problems with presenting the condition if it fails,
                // only course register class check manually if this condition is fullfilled
                return true;
        }


        function _getGroupingCourseIds($a_course_id)
        {
                include_once './classes/class.ilConditionHandler.php';

                // get all grouping ids the course is assigned to
                foreach(ilConditionHandler::_getConditionsOfTarget($a_course_id,'crs') as $condition)
                {
                        if($condition['trigger_type'] == 'crsg')
                        {
                                foreach(ilConditionHandler::_getConditionsOfTrigger('crsg',$condition['trigger_obj_id']) as $target_condition)
                                {
                                        $course_ids[] = array('id'                      => $target_condition['target_obj_id'],
                                                                                  'unique'              => $target_condition['value']);
                                }
                        }
                }
                return $course_ids ? $course_ids : array();
        }

        function _checkGroupingDependencies(&$container_obj)
        {
                global $ilUser,$lng,$tree;

                include_once './classes/class.ilConditionHandler.php';

                $trigger_ids = array();
                foreach(ilConditionHandler::_getConditionsOfTarget($container_obj->getId(),$container_obj->getType()) as $condition)
                {
                        if($condition['operator'] == 'not_member')
                        {
                                $trigger_ids[] = $condition['trigger_obj_id'];
                                break;
                        }
                }
                if(!count($trigger_ids))
                {
                        return true;
                }

                foreach($trigger_ids as $trigger_id)
                {
                        foreach(ilConditionHandler::_getConditionsOfTrigger('crsg',$trigger_id) as $condition)
                        {
                                // Handle deleted items
                                if($tree->isDeleted($condition['target_ref_id']))
                                {
                                        continue;
                                }
                                if($condition['operator'] == 'not_member')
                                {
                                        switch($condition['value'])
                                        {
                                                case 'matriculation':
                                                        if(!strlen($ilUser->getMatriculation()))
                                                        {
                                                                if(!$matriculation_message)
                                                                {
                                                                        $matriculation_message = $lng->txt('crs_grp_matriculation_required');
                                                                }
                                                        }
                                        }
                                        if($container_obj->getType() == 'crs')
                                        {
                                                if(ilCourseMembers::_isMember($ilUser->getId(),$condition['target_obj_id'],$condition['value']))
                                                {
                                                        if(!$assigned_message)
                                                        {
                                                                $assigned_message = $lng->txt('crs_grp_already_assigned');
                                                        }
                                                }
                                        }
                                        else
                                        {
                                                if(ilObjGroup::_isMember($ilUser->getId(),$condition['target_ref_id'],$condition['value']))
                                                {
                                                        if(!$assigned_message)
                                                        {
                                                                $assigned_message = $lng->txt('crs_grp_already_assigned');
                                                        }
                                                }

                                        }
                                }
                        }
                }
                if($matriculation_message)
                {
                        $container_obj->appendMessage($matriculation_message);
                        return false;
                }
                elseif($assigned_message)
                {
                        $container_obj->appendMessage($assigned_message);
                        return false;
                }
                return true;
        }

        function _getGroupingItemsAsString(&$container_obj)
        {
                global $tree,$ilObjDataCache,$ilAccess,$tree;

                include_once './classes/class.ilConditionHandler.php';

                $trigger_ids = array();
                foreach(ilConditionHandler::_getConditionsOfTarget($container_obj->getId(),$container_obj->getType()) as $condition)
                {
                        if($condition['operator'] == 'not_member')
                        {
                                $trigger_ids[] = $condition['trigger_obj_id'];
                        }
                }
                if(!count($trigger_ids))
                {
                        return false;
                }
                foreach($trigger_ids as $trigger_id)
                {
                        foreach(ilConditionHandler::_getConditionsOfTrigger('crsg',$trigger_id) as $condition)
                        {
                                // Continue if trigger is deleted
                                if($tree->isDeleted($condition['target_ref_id']))
                                {
                                        continue;
                                }

                                if($condition['operator'] == 'not_member')
                                {
                                        if(!$hash_table[$condition['target_ref_id']])
                                        {
                                                $courses .= (' <br/>'.$ilObjDataCache->lookupTitle($condition['target_obj_id']));
                                        }
                                        $hash_table[$condition['target_ref_id']] = true;
                                }
                        }
                }
                return $courses;
        }

} // END class.ilObjCourseGrouping
?>