class.ilStudyProgrammeAssignment.php

Go to the documentation of this file.

<?php

/* Copyright (c) 2015 Richard Klees <richard.klees@concepts-and-training.de> Extended GPL, see docs/LICENSE */

require_once(dirname(__FILE__)."/../../../../Services/ActiveRecord/class.ActiveRecord.php");

class ilStudyProgrammeAssignment extends ActiveRecord {
        static function returnDbTableName() {
                return "prg_usr_assignments";
        }

        protected $id;
 
        protected $usr_id;

        protected $root_prg_id;


        protected $last_change; 

        protected $last_change_by;
        
        
        static public function createFor(ilStudyProgramme $a_prg, $a_usr_id, $a_assigning_usr_id) {
                if (ilObject::_lookupType($a_usr_id) != "usr") {
                        throw new ilException("ilStudyProgrammeAssignment::createFor: '$a_usr_id' "
                                                                 ."is no id of a user.");
                }
                
                $ass = new ilStudyProgrammeAssignment();
                $ass->setRootId($a_prg->getObjId())
                        ->setUserId($a_usr_id)
                        ->setLastChangeBy($a_assigning_usr_id)
                        ->updateLastChange()
                        ->create();
                return $ass;
        }
        
        public function getId() {
                return $this->id;
        }
        
        public function getRootId() {
                return $this->root_prg_id;
        }
        
        protected function setRootId($a_id) {
                $this->root_prg_id = $a_id;
                return $this;
        }
        
        public function getUserId() {
                return $this->usr_id;
        }
        
        protected function setUserId($a_usr_id) {
                $this->usr_id = $a_usr_id;
                return $this;
        }
        
        public function getLastChangeBy() {
                return $this->last_change_by;
        }
        
        public function setLastChangeBy($a_usr_id) {
                if (ilObject::_lookupType($a_usr_id) != "usr") {
                        throw new ilException("ilStudyProgrammeAssignment::setLastChangeBy: '$a_usr_id' "
                                                                 ."is no id of a user.");
                }
                $this->last_change_by = $a_usr_id;
                return $this;
        }
        
        public function getLastChange() {
                return new ilDateTime($this->last_change, IL_CAL_DATETIME);
        }

        public function updateLastChange() {
                $this->setLastChange(new ilDateTime(ilUtil::now(), IL_CAL_DATETIME)); 
                return $this;
        }

        public function setLastChange(ilDateTime $a_timestamp) {
                if (ilDateTime::_before($a_timestamp, $this->getLastChange())) {
                        throw new ilException("ilStudyProgrammeAssignment::setLastChange: Given "
                                                                 ."timestamp is before current timestamp. That "
                                                                 ."is logically impossible.");
                }
                
                $this->last_change = $a_timestamp->get(IL_CAL_DATETIME);
                return $this;
        }
}

?>