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 */
 
 
class ilStudyProgrammeProgress
{
    
    // 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( self::STATUS_IN_PROGRESS
                          , self::STATUS_COMPLETED
                          , self::STATUS_ACCREDITED
                          , self::STATUS_NOT_RELEVANT
                          , self::STATUS_FAILED
                          );
 
    const DATE_TIME_FORMAT = 'Y-m-d H:i:s';
    const DATE_FORMAT = 'Y-m-d';
 
    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 $assignment_date;
 
    protected $completion_date;
 
    protected $deadline;
 
    protected $vq_date;
 
 
    protected $invalidated = false;
    public function __construct(int $id)
    {
        $this->id = $id;
    }
 
    public function getId()
    {
        return $this->id;
    }
 
    public function getAssignmentId() : int
    {
        return $this->assignment_id;
    }
    public function setAssignmentId(int $a_id) : ilStudyProgrammeProgress
    {
        $this->assignment_id = $a_id;
        return $this;
    }
    public function getNodeId() : int
    {
        return $this->prg_id;
    }
    public function setNodeId(int $a_id) : ilStudyProgrammeProgress
    {
        $this->prg_id = $a_id;
        return $this;
    }
    public function getUserId() : int
    {
        return $this->usr_id;
    }
    public function setUserId(int $a_id) : ilStudyProgrammeProgress
    {
        $this->usr_id = $a_id;
        return $this;
    }
    
    public function getAmountOfPoints() : int
    {
        return $this->points;
    }
    
    public function setAmountOfPoints(int $a_points) : ilStudyProgrammeProgress
    {
        if ($a_points < 0) {
            throw new ilException("ilStudyProgrammeProgress::setAmountOfPoints: "
                                 . "Expected a number >= 0 as argument, got '$a_points'");
        }
        
        $this->points = $a_points;
 
        $this->updateLastChange();
        return $this;
    }
    
    public function getCurrentAmountOfPoints() : int
    {
        return $this->points_cur;
    }
    
    public function setCurrentAmountOfPoints(int $a_points) : ilStudyProgrammeProgress
    {
        if ($a_points < 0) {
            throw new ilException("ilStudyProgrammeProgress::setCurrentAmountOfPoints: "
                                 . "Expected a number >= 0 as argument, got '$a_points'.");
        }
        
        $this->points_cur = $a_points;
        $this->updateLastChange();
        return $this;
    }
    
    public function getStatus() : int
    {
        return $this->status;
    }
    
    public function setStatus(int $a_status) : ilStudyProgrammeProgress
    {
        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(int $a_id = null) : ilStudyProgrammeProgress
    {
        $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(int $a_usr_id = null) : ilStudyProgrammeProgress
    {
        if (is_null($a_usr_id) || $a_usr_id < 0) {
            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() : DateTime
    {
        return DateTime::createFromFormat(self::DATE_TIME_FORMAT, $this->last_change);
    }
 
    public function updateLastChange()
    {
        $this->setLastChange(new DateTime());
        return $this;
    }
 
    public function setLastChange(DateTime $a_timestamp) : ilStudyProgrammeProgress
    {
        $this->last_change = $a_timestamp->format(self::DATE_TIME_FORMAT);
        return $this;
    }
 
    public function setAssignmentDate(DateTime $assignment_date) : ilStudyProgrammeProgress
    {
        $this->assignment_date = $assignment_date;
        return $this;
    }
 
    public function getAssignmentDate() : DateTime
    {
        return $this->assignment_date;
    }
 
    public function setCompletionDate(DateTime $completion_date = null) : ilStudyProgrammeProgress
    {
        $this->completion_date = $completion_date;
        return $this;
    }
 
    public function getCompletionDate()
    {
        return $this->completion_date;
    }
 
    public function getDeadline()
    {
        return $this->deadline;
    }
 
    public function setDeadline(DateTime $deadline = null) : ilStudyProgrammeProgress
    {
        $this->deadline = $deadline;
        return $this;
    }
 
    public function setValidityOfQualification(DateTime $date = null) : ilStudyProgrammeProgress
    {
        $this->vq_date = $date;
        return $this;
    }
 
    public function getValidityOfQualification() : ?DateTime
    {
        return $this->vq_date;
    }
 
    public function invalidate() : ilStudyProgrammeProgress
    {
        if (!$this->vq_date || $this->vq_date->format('Y-m-d') > date('Y-m-d')) {
            throw new ilException("may not invalidate non-expired progress");
        }
        $this->invalidated = true;
        return $this;
    }
 
    public function isInvalidated() : bool
    {
        return $this->invalidated;
    }
}