class.ilStudyProgrammeProgress.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 ilStudyProgrammeProgress extends ActiveRecord
{
    
    // The progress of a user on a program node can have different status that
    // determine how the node is taken into account for calculation of the learning
    // progress.
    
    // User needs to be successful in the node, but currently isn't.
    const STATUS_IN_PROGRESS = 1;
    // User has completed the node successfully according to the program nodes
    // mode.
    const STATUS_COMPLETED = 2;
    // User was marked as successful in the node without actually having
    // successfully completed the program node according to his mode.
    const STATUS_ACCREDITED = 3;
    // The user does not need to be successful in this node.
    const STATUS_NOT_RELEVANT = 4;
    // The user does not need to be successful in this node.
    const STATUS_FAILED = 5;

    public static $STATUS = array( ilStudyProgrammeProgress::STATUS_IN_PROGRESS
                          , ilStudyProgrammeProgress::STATUS_COMPLETED
                          , ilStudyProgrammeProgress::STATUS_ACCREDITED
                          , ilStudyProgrammeProgress::STATUS_NOT_RELEVANT
                          , ilStudyProgrammeProgress::STATUS_FAILED
                          );

    public static function returnDbTableName()
    {
        return "prg_usr_progress";
    }

    protected $id;

    protected $assignment_id;

    protected $prg_id;

    protected $usr_id;
    protected $points;

    protected $points_cur;
 
    protected $status;

    protected $completion_by;
    

    protected $last_change;

    protected $last_change_by;

    protected $deadline;

    public static function createFor(ilStudyProgramme $a_prg, ilStudyProgrammeAssignment $a_ass)
    {
        $prg = new ilStudyProgrammeProgress();
        $prg->setAssignmentId($a_ass->getId())
            ->setNodeId($a_prg->getObjId())
            ->setUserId($a_ass->getUserId())
            ->setStatus(ilStudyProgrammeProgress::STATUS_IN_PROGRESS)
            ->setAmountOfPoints($a_prg->getPoints())
            ->setCurrentAmountOfPoints(0)
            ->setCompletionBy(null)
            ->setLastChangeBy(null)
            ->updateLastChange()
            ->create();
        return $prg;
    }
    
    public function getAssignmentId()
    {
        return $this->assignment_id;
    }
    
    protected function setAssignmentId($a_id)
    {
        $this->assignment_id = $a_id;
        return $this;
    }
    
    public function getNodeId()
    {
        return $this->prg_id;
    }
    
    protected function setNodeId($a_id)
    {
        $this->prg_id = $a_id;
        return $this;
    }
    
    public function getUserId()
    {
        return $this->usr_id;
    }
    
    protected function setUserId($a_id)
    {
        $this->usr_id = $a_id;
        return $this;
    }
    
    public function getAmountOfPoints()
    {
        return $this->points;
    }
    
    public function setAmountOfPoints($a_points)
    {
        if (!is_numeric($a_points) || $a_points < 0) {
            throw new ilException("ilStudyProgrammeProgress::setAmountOfPoints: "
                                 . "Expected a number >= 0 as argument, got '$a_points'");
        }
        
        $this->points = (int) $a_points;

        $this->updateLastChange();
        return $this;
    }
    
    public function getCurrentAmountOfPoints()
    {
        return $this->points_cur;
    }
    
    public function setCurrentAmountOfPoints($a_points)
    {
        if (!is_numeric($a_points) || $a_points < 0) {
            throw new ilException("ilStudyProgrammeProgress::setCurrentAmountOfPoints: "
                                 . "Expected a number >= 0 as argument, got '$a_points'.");
        }
        
        $this->points_cur = (int) $a_points;
        $this->updateLastChange();
        return $this;
    }
    
    public function getStatus()
    {
        return $this->status;
    }
    
    public function setStatus($a_status)
    {
        $a_status = (int) $a_status;
        if (!in_array($a_status, self::$STATUS)) {
            throw new ilException("ilStudyProgrammeProgress::setStatus: No status: "
                                 . "'$a_status'");
        }

        $this->status = $a_status;
        $this->updateLastChange();
        return $this;
    }
    
    public function setCompletionBy($a_id)
    {
        if ($a_id !== null) {
            $a_id = (int) $a_id;
        }
        $this->completion_by = $a_id;
        $this->updateLastChange();
        return $this;
    }
    
    public function getCompletionBy()
    {
        return $this->completion_by;
    }
    public function getLastChangeBy()
    {
        return $this->last_change_by;
    }
    
    public function setLastChangeBy($a_usr_id)
    {
        if ($a_usr_id !== null && ilObject::_lookupType($a_usr_id) != "usr") {
            throw new ilException("ilStudyProgrammeProgress::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("ilStudyProgrammeProgress::setLastChange: Given "
                                 . "timestamp is before current timestamp. That "
                                 . "is logically impossible.");
        }
        
        $this->last_change = $a_timestamp->get(IL_CAL_DATETIME);
        return $this;
    }

    public function getDeadline()
    {
        if ($this->deadline !== null) {
            return new ilDateTime($this->deadline, IL_CAL_DATE);
        }
        return $this->deadline;
    }

    public function setDeadline(ilDateTime $deadline = null)
    {
        if ($deadline === null) {
            $this->deadline = $deadline;
        } else {
            $this->deadline = $deadline->get(IL_CAL_DATE);
        }

        return $this;
    }
}