class.ilStudyProgramme.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 ilStudyProgramme extends ActiveRecord
{
    
    // There are two different modes the programs calculation of the learning
    // progress can run in. It is also possible, that the mode is not defined
    // yet.
    const MODE_UNDEFINED = 0;
    
    // User is successful if he collected enough points in the subnodes of
    // this node.
    const MODE_POINTS = 1;
    // User is successful if he has the "completed" learning progress in any
    // subobject.
    const MODE_LP_COMPLETED = 2;

    public static $MODES = array( ilStudyProgramme::MODE_UNDEFINED
                         , ilStudyProgramme::MODE_POINTS
                         , ilStudyProgramme::MODE_LP_COMPLETED
                         );


    // A program tree has a lifecycle during which it has three status.

    // The program is a draft, that is users won't be assigned to the program
    // already.
    const STATUS_DRAFT = 10;
    // The program is active, that is used can be assigned to it.
    const STATUS_ACTIVE = 20;
    // The program is outdated, that is user won't be assigned to it but can
    // still complete the program.
    const STATUS_OUTDATED = 30;

    public static $STATUS = array( ilStudyProgramme::STATUS_DRAFT
                          , ilStudyProgramme::STATUS_ACTIVE
                          , ilStudyProgramme::STATUS_OUTDATED
                          );

    
    // Defaults
    const DEFAULT_POINTS = 100;
    const DEFAULT_SUBTYPE = 0; // TODO: What should that be?
    
    public static function returnDbTableName()
    {
        return "prg_settings";
    }

    protected $obj_id;
    
    protected $last_change;

    protected $subtype_id;

    protected $points;

    protected $lp_mode;

    protected $status;
    
    
    public static function createForObject(ilObject $a_object)
    {
        if ($a_object->getType() != "prg") {
            throw new ilException("ilStudyProgramme::createSettingsForObject: "
                                 . "Object is no prg object.");
        }
        if (!$a_object->getId()) {
            throw new ilException("ilStudyProgramme::createSettingsForObject: "
                                 . "Object has no id.");
        }

        $prg = new ilStudyProgramme();
        $prg->subtype_id = self::DEFAULT_SUBTYPE;
        $prg->setObjId($a_object->getId())
            ->setStatus(self::STATUS_DRAFT)
            ->setLPMode(self::MODE_UNDEFINED)
            ->setPoints(self::DEFAULT_POINTS)
            ->create();
        return $prg;
    }

    
    protected function setObjId($a_id)
    {
        $this->obj_id = $a_id;
        return $this;
    }

    public function getObjId()
    {
        return (int) $this->obj_id;
    }

    public function getSubtypeId()
    {
        return $this->subtype_id;
    }


    public function setSubtypeId($subtype_id)
    {
        $this->subtype_id = $subtype_id;
    }

    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("ilStudyProgramme::setLastChange: Given "
                                 . "timestamp is before current timestamp. That "
                                 . "is logically impossible.");
        }
        
        $this->last_change = $a_timestamp->get(IL_CAL_DATETIME);
        return $this;
    }



    public function setPoints($a_points)
    {
        $a_points = (int) $a_points;
        if ($a_points < 0) {
            throw new ilException("ilStudyProgramme::setPoints: Points cannot "
                                 . "be smaller than zero.");
        }

        $this->points = $a_points;
        $this->updateLastChange();
        return $this;
    }

    public function getPoints()
    {
        return (int) $this->points;
    }

    public function setLPMode($a_mode)
    {
        $a_mode = (int) $a_mode;
        if (!in_array($a_mode, self::$MODES)) {
            throw new ilException("ilStudyProgramme::setLPMode: No lp mode: "
                                 . "'$a_mode'");
        }
        $this->lp_mode = $a_mode;
        $this->updateLastChange();
        return $this;
    }

    public function getLPMode()
    {
        return (int) $this->lp_mode;
    }

    public function setStatus($a_status)
    {
        $a_status = (int) $a_status;
        if (!in_array($a_status, self::$STATUS)) {
            throw new ilException("ilStudyProgramme::setStatus: No lp mode: "
                                 . "'$a_status'");
        }
        $this->status = $a_status;
        $this->updateLastChange();
        return $this;
    }

    public function getStatus()
    {
        return (int) $this->status;
    }
}