class.ilObjSession.php

Go to the documentation of this file.

<?php

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

include_once('./Modules/Session/classes/class.ilSessionAppointment.php');
include_once './Services/Membership/classes/class.ilMembershipRegistrationSettings.php';

class ilObjSession extends ilObject
{
        const CAL_REG_START = 1;
        
        protected $db;
        
        protected $location;
        protected $name;
        protected $phone;
        protected $email;
        protected $details;
        protected $registration;
        protected $event_id;
        
        protected $reg_type = ilMembershipRegistrationSettings::TYPE_NONE;
        protected $reg_limited = 0;
        protected $reg_min_users = 0;
        protected $reg_limited_users = 0;
        protected $reg_waiting_list = 0;
        protected $reg_waiting_list_autofill; // [bool]

        protected $appointments;
        protected $files = array();
        

        
        public function __construct($a_id = 0,$a_call_by_reference = true)
        {
                global $ilDB;

                $this->db = $ilDB;
                $this->type = "sess";
                parent::__construct($a_id,$a_call_by_reference);
        }
        
        public static function _lookupRegistrationEnabled($a_obj_id)
        {
                global $ilDB;
                
                $query = "SELECT reg_type FROM event ".
                        "WHERE obj_id = ".$ilDB->quote($a_obj_id ,'integer')." ";
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
                {
                        return (bool) $row->reg_type != ilMembershipRegistrationSettings::TYPE_NONE;
                }
                return false;
        }
        
        public static function lookupSession($a_obj_id)
        {
                global $ilDB;
                
                $query = "SELECT * FROM event ".
                        "WHERE obj_id = ".$ilDB->quote($a_obj_id);
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
                {
                        $data['location']       = $row->location ? $row->location : '';
                        $data['details']        = $row->details ? $row->details : '';
                        $data['name']           = $row->tutor_name ? $row->tutor_name : '';
                        $data['email']          = $row->tutor_email ? $row->tutor_email : '';
                        $data['phone']          = $row->tutor_phone ? $row->tutor_phone : '';
                }
                return (array) $data;
        }
        
        public function getPresentationTitle()
        {
                $date = new ilDate($this->getFirstAppointment()->getStart()->getUnixTime(),IL_CAL_UNIX);
                if($this->getTitle())
                {
                        return ilDatePresentation::formatDate($this->getFirstAppointment()->getStart()).': '.$this->getTitle();                 
                }
                else
                {
                        return ilDatePresentation::formatDate($date);                   
                }

        }
        
        
        
        public function getEventId()
        {
                return $this->event_id;
        }
        
        public function setLocation($a_location)
        {
                $this->location = $a_location;
        }
        
        public function getLocation()
        {
                return $this->location;
        }
        
        public function setName($a_name)
        {
                $this->name = $a_name;
        }
        
        public function getName()
        {
                return $this->name;
        }
        
        public function setPhone($a_phone)
        {
                $this->phone = $a_phone;
        }
        
        public function getPhone()
        {
                return $this->phone;
        }
        
        public function setEmail($a_email)
        {
                $this->email = $a_email;
        }
        
        public function getEmail()
        {
                return $this->email;
        }
        
        public function hasTutorSettings()
        {
                return strlen($this->getName()) or 
                        strlen($this->getEmail()) or
                        strlen($this->getPhone());
        }
        
        
        public function setDetails($a_details)
        {
                $this->details = $a_details;
        }
        
        public function getDetails()
        {
                return $this->details;
        }
        
        public function setRegistrationType($a_type)
        {
                $this->reg_type = $a_type;
        }
        
        public function getRegistrationType()
        {
                return $this->reg_type;
        }
        
        public function isRegistrationUserLimitEnabled()
        {
                return $this->reg_limited;
        }
        
        public function enableRegistrationUserLimit($a_limit)
        {
                $this->reg_limited = $a_limit;
        }
        
        public function getRegistrationMinUsers()
        {
                return $this->reg_min_users;
        }
        
        public function setRegistrationMinUsers($a_users)
        {
                $this->reg_min_users = $a_users;
        }
        
        public function getRegistrationMaxUsers()
        {
                return $this->reg_limited_users;
        }
        
        public function setRegistrationMaxUsers($a_users)
        {
                $this->reg_limited_users = $a_users;
        }
        
        public function isRegistrationWaitingListEnabled()
        {
                return $this->reg_waiting_list;
        }
        
        public function enableRegistrationWaitingList($a_stat)
        {
                $this->reg_waiting_list = $a_stat;
        }
        
        public function setWaitingListAutoFill($a_value)
        {
                $this->reg_waiting_list_autofill = (bool)$a_value;
        }
        
        public function hasWaitingListAutoFill()
        {
                return (bool)$this->reg_waiting_list_autofill;
        }
        
        public function enabledRegistration()
        {
                return $this->reg_type != ilMembershipRegistrationSettings::TYPE_NONE;
        }
        
        public function getAppointments()
        {
                return $this->appointments ? $this->appointments : array();
        }
        
        public function addAppointment($appointment)
        {
                $this->appointments[] = $appointment;
        }
        
        public function setAppointments($appointments)
        {
                $this->appointments = $appointments;
        }

        public function getFirstAppointment()
        {
                return is_object($this->appointments[0]) ? $this->appointments[0] : ($this->appointments[0] = new ilSessionAppointment());
        }
        
        public function getFiles()
        {
                return $this->files ? $this->files : array();
        }
        
        public function validate()
        {
                global $ilErr;
                
                // #17114
                if($this->isRegistrationUserLimitEnabled() &&
                        !$this->getRegistrationMaxUsers())
                {                       
                        $ilErr->appendMessage($this->lng->txt("sess_max_members_needed"));
                        return false;
                }
                
                return true;
        }
        
        public function cloneObject($a_target_id,$a_copy_id = 0, $a_omit_tree = false)
        {
                global $ilDB,$ilUser,$ilAppEventHandler;
                
                $new_obj = parent::cloneObject($a_target_id,$a_copy_id, $a_omit_tree);
                
                $this->read();
                
                // Copy settings
                $this->cloneSettings($new_obj);
                
                // Clone appointment
                $new_app = $this->getFirstAppointment()->cloneObject($new_obj->getId());
                $new_obj->setAppointments(array($new_app));
                $new_obj->update();

                // Clone session files
                foreach($this->files as $file)
                {
                        $file->cloneFiles($new_obj->getEventId());
                }
                
                // Raise update forn new appointments
                
                
        
                // Copy learning progress settings
                include_once('Services/Tracking/classes/class.ilLPObjSettings.php');
                $obj_settings = new ilLPObjSettings($this->getId());
                $obj_settings->cloneSettings($new_obj->getId());
                unset($obj_settings);
                
                return $new_obj;
        }
        
        public function cloneSettings(ilObjSession $new_obj)
        {
                // @var 
                $new_obj->setLocation($this->getLocation());
                $new_obj->setName($this->getName());
                $new_obj->setPhone($this->getPhone());
                $new_obj->setEmail($this->getEmail());
                $new_obj->setDetails($this->getDetails());
                
                $new_obj->setRegistrationType($this->getRegistrationType());
                $new_obj->enableRegistrationUserLimit($this->isRegistrationUserLimitEnabled());
                $new_obj->enableRegistrationWaitingList($this->isRegistrationWaitingListEnabled());
                $new_obj->setWaitingListAutoFill($this->hasWaitingListAutoFill());
                $new_obj->setRegistrationMinUsers($this->getRegistrationMinUsers());
                $new_obj->setRegistrationMaxUsers($this->getRegistrationMaxUsers());
                
                $new_obj->update();
                
                return true;
        }
        
        public function cloneDependencies($a_target_id,$a_copy_id)
        {
                global $ilObjDataCache;
                
                parent::cloneDependencies($a_target_id,$a_copy_id);

                $target_obj_id = $ilObjDataCache->lookupObjId($a_target_id);
                
                include_once('./Modules/Session/classes/class.ilEventItems.php');
                $session_materials = new ilEventItems($target_obj_id);
                $session_materials->cloneItems($this->getId(),$a_copy_id);

                return true;
        }
        
        
        
        public function create()
        {
                global $ilDB;
                global $ilAppEventHandler;
        
                parent::create();
                
                $next_id = $ilDB->nextId('event');
                $query = "INSERT INTO event (event_id,obj_id,location,tutor_name,tutor_phone,tutor_email,details,registration, ".
                        'reg_type, reg_limit_users, reg_limited, reg_waiting_list, reg_min_users, reg_auto_wait) '.
                        "VALUES( ".
                        $ilDB->quote($next_id,'integer').", ".
                        $this->db->quote($this->getId() ,'integer').", ".
                        $this->db->quote($this->getLocation() ,'text').",".
                        $this->db->quote($this->getName() ,'text').", ".
                        $this->db->quote($this->getPhone() ,'text').", ".
                        $this->db->quote($this->getEmail() ,'text').", ".
                        $this->db->quote($this->getDetails() ,'text').",".
                        $this->db->quote($this->enabledRegistration() ,'integer').", ".
                        $this->db->quote($this->getRegistrationType(),'integer').', '.
                        $this->db->quote($this->getRegistrationMaxUsers(),'integer').', '.
                        $this->db->quote($this->isRegistrationUserLimitEnabled(),'integer').', '.
                        $this->db->quote($this->isRegistrationWaitingListEnabled(),'integer').', '.
                        $this->db->quote($this->getRegistrationMinUsers(),'integer').', '.
                        $this->db->quote($this->hasWaitingListAutoFill(),'integer').' '.
                        ")";
                $res = $ilDB->manipulate($query);
                $this->event_id = $next_id;
                
                $ilAppEventHandler->raise('Modules/Session',
                        'create',
                        array('object' => $this,
                                'obj_id' => $this->getId(),
                                'appointments' => $this->prepareCalendarAppointments('create')));

                return $this->getId();
        }
        
        public function update()
        {
                global $ilDB;
                global $ilAppEventHandler;

                if(!parent::update())
                {
                        return false;
                }
                $query = "UPDATE event SET ".
                        "location = ".$this->db->quote($this->getLocation() ,'text').",".
                        "tutor_name = ".$this->db->quote($this->getName() ,'text').", ".
                        "tutor_phone = ".$this->db->quote($this->getPhone() ,'text').", ".
                        "tutor_email = ".$this->db->quote($this->getEmail() ,'text').", ".
                        "details = ".$this->db->quote($this->getDetails() ,'text').", ".
                        "registration = ".$this->db->quote($this->enabledRegistration() ,'integer').", ".
                        "reg_type = ".$this->db->quote($this->getRegistrationType() ,'integer').", ".
                        "reg_limited = ".$this->db->quote($this->isRegistrationUserLimitEnabled() ,'integer').", ".
                        "reg_limit_users = ".$this->db->quote($this->getRegistrationMaxUsers() ,'integer').", ".
                        "reg_min_users = ".$this->db->quote($this->getRegistrationMinUsers() ,'integer').", ".
                        "reg_waiting_list = ".$this->db->quote($this->isRegistrationWaitingListEnabled(),'integer').", ".
                        "reg_auto_wait = ".$this->db->quote($this->hasWaitingListAutoFill(),'integer')." ".
                        "WHERE obj_id = ".$this->db->quote($this->getId() ,'integer')." ";
                $res = $ilDB->manipulate($query);
                
                $ilAppEventHandler->raise('Modules/Session',
                        'update',
                        array('object' => $this,
                                'obj_id' => $this->getId(),
                                'appointments' => $this->prepareCalendarAppointments('update')));
                return true;
        }
        
        public function delete()
        {
                global $ilDB;
                global $ilAppEventHandler;
                
                if(!parent::delete())
                {
                        return false;
                }
                $query = "DELETE FROM event ".
                        "WHERE obj_id = ".$this->db->quote($this->getId() ,'integer')." ";
                $res = $ilDB->manipulate($query);
                
                include_once('./Modules/Session/classes/class.ilSessionAppointment.php');
                ilSessionAppointment::_deleteBySession($this->getId());
                
                include_once('./Modules/Session/classes/class.ilEventItems.php');
                ilEventItems::_delete($this->getId());
                
                include_once('./Modules/Session/classes/class.ilEventParticipants.php');
                ilEventParticipants::_deleteByEvent($this->getId());
                
                foreach($this->getFiles() as $file)
                {
                        $file->delete();
                }
                
                $ilAppEventHandler->raise('Modules/Session',
                        'delete',
                        array('object' => $this,
                                'obj_id' => $this->getId(),
                                'appointments' => $this->prepareCalendarAppointments('delete')));
                
                
                return true;
        }
        
        public function read()
        {
                parent::read();
                
                $query = "SELECT * FROM event WHERE ".
                        "obj_id = ".$this->db->quote($this->getId() ,'integer')." ";
                $res = $this->db->query($query);
                
                while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
                {
                        $this->setLocation($row->location);
                        $this->setName($row->tutor_name);
                        $this->setPhone($row->tutor_phone);
                        $this->setEmail($row->tutor_email);
                        $this->setDetails($row->details);
                        $this->setRegistrationType($row->reg_type);
                        $this->enableRegistrationUserLimit($row->reg_limited);
                        $this->enableRegistrationWaitingList($row->reg_waiting_list);
                        $this->setWaitingListAutoFill($row->reg_auto_wait);
                        $this->setRegistrationMaxUsers($row->reg_limit_users);
                        $this->setRegistrationMinUsers($row->reg_min_users);
                        $this->event_id = $row->event_id;
                }

                $this->initAppointments();
                $this->initFiles();
        }
        
        protected function initAppointments()
        {
                // get assigned appointments
                include_once('./Modules/Session/classes/class.ilSessionAppointment.php');
                $this->appointments = ilSessionAppointment::_readAppointmentsBySession($this->getId());
        }
        
        public function initFiles()
        {
                include_once('./Modules/Session/classes/class.ilSessionFile.php');
                $this->files = ilSessionFile::_readFilesByEvent($this->getEventId());
        }
        
        
        public function prepareCalendarAppointments($a_mode = 'create')
        {
                include_once('./Services/Calendar/classes/class.ilCalendarAppointmentTemplate.php');
                
                switch($a_mode)
                {
                        case 'create':
                        case 'update':

                                $app = new ilCalendarAppointmentTemplate(self::CAL_REG_START);
                                $app->setTranslationType(IL_CAL_TRANSLATION_NONE);
                                $app->setTitle($this->getTitle() ? $this->getTitle() : $this->lng->txt('obj_sess'));
                                $app->setDescription($this->getLongDescription());
                                
                                $sess_app = $this->getFirstAppointment();
                                $app->setFullday($sess_app->isFullday());
                                $app->setStart($sess_app->getStart());
                                $app->setEnd($sess_app->getEnd());
                                $apps[] = $app;

                                return $apps;
                                
                        case 'delete':
                                // Nothing to do: The category and all assigned appointments will be deleted.
                                return array();
                }
        }
        
        public function handleAutoFill()
        {       
                if($this->isRegistrationWaitingListEnabled() &&
                        $this->hasWaitingListAutoFill())
                {                                       
                        // :TODO: what about ilSessionParticipants?
                        
                        include_once './Modules/Session/classes/class.ilEventParticipants.php'; 
                        $part_obj = new ilEventParticipants($this->getId());                    
                        $all_reg = $part_obj->getRegistered();
                        $now = sizeof($all_reg);
                        $max = $this->getRegistrationMaxUsers();
                        if($max > $now)
                        {                               
                                include_once('./Modules/Session/classes/class.ilSessionWaitingList.php');
                                $waiting_list = new ilSessionWaitingList($this->getId());

                                foreach($waiting_list->getUserIds() as $user_id)
                                {
                                        if(!$tmp_obj = ilObjectFactory::getInstanceByObjId($user_id,false))
                                        {
                                                continue;
                                        }
                                        if(in_array($user_id, $all_reg))
                                        {
                                                continue;
                                        }
                                        
                                        ilEventParticipants::_register($user_id, $this->getId());                                       
                                        $waiting_list->removeFromList($user_id);

                                        $now++;
                                        if($now >= $max)
                                        {
                                                break;
                                        }
                                }
                        }
                }               
        }
}

?>