class.ilStudyProgrammeUserAssignment.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("./Modules/StudyProgramme/classes/model/class.ilStudyProgrammeAssignment.php");

class ilStudyProgrammeUserAssignment
{
    public $assignment; // ilStudyProgrammeAssignment

    private $sp_user_progress_db;

    public function __construct($a_id_or_model, \ilStudyProgrammeUserProgressDB $sp_user_progress_db)
    {
        if ($a_id_or_model instanceof ilStudyProgrammeAssignment) {
            $this->assignment = $a_id_or_model;
        } else {
            $this->assignment = ilStudyProgrammeAssignment::find($a_id_or_model);
        }
        if ($this->assignment === null) {
            throw new ilException("ilStudyProgrammeUserAssignment::__construct: "
                                 . "Unknown assignmemt id '$a_id_or_model'.");
        }
        $this->sp_user_progress_db = $sp_user_progress_db;
    }

    public static function getInstance($a_id)
    {
        return new ilStudyProgrammeUserAssignment($a_id, ilObjStudyProgramme::_getStudyProgrammeUserProgressDB());
    }

    public static function getInstancesOfUser($a_user_id)
    {
        global $DIC;
        $tree = $DIC['tree'];

        $assignments = ilStudyProgrammeAssignment::where(array( "usr_id" => $a_user_id ))
                                                    ->get();

        //if parent object is deleted or in trash
        //the assignment for the user should not be returned
        $ret = array();
        foreach ($assignments as $ass) {
            $ass_obj = new ilStudyProgrammeUserAssignment($ass, ilObjStudyProgramme::_getStudyProgrammeUserProgressDB());
            foreach (ilObject::_getAllReferences($ass_obj->assignment->getRootId()) as $value) {
                if ($tree->isInTree($value)) {
                    $ret[] = $ass_obj;
                    break;
                }
            }
        }

        return $ret;
    }

    public static function getInstancesForProgram($a_program_id)
    {
        $assignments = ilStudyProgrammeAssignment::where(array( "root_prg_id" => $a_program_id ))
                                                    ->get();
        return array_map(function ($ass) {
            return new ilStudyProgrammeUserAssignment($ass, ilObjStudyProgramme::_getStudyProgrammeUserProgressDB());
        }, array_values($assignments)); // use array values since we want keys 0...
    }

    public function getId()
    {
        return $this->assignment->getId();
    }

    public function getStudyProgramme()
    {
        require_once("./Modules/StudyProgramme/classes/class.ilObjStudyProgramme.php");
        $refs = ilObject::_getAllReferences($this->assignment->getRootId());
        if (!count($refs)) {
            throw new ilException("ilStudyProgrammeUserAssignment::getStudyProgramme: "
                                 . "could not find ref_id for program '"
                                 . $this->assignment->getRootId() . "'.");
        }
        return ilObjStudyProgramme::getInstanceByRefId(array_shift($refs));
    }

    public function getRootProgress()
    {
        return $this->getStudyProgramme()->getProgressForAssignment($this->getId());
    }

    public function getUserId()
    {
        return $this->assignment->getUserId();
    }

    public function deassign()
    {
        $this->getStudyProgramme()->removeAssignment($this);
    }

    public function delete()
    {
        $progresses = $this->sp_user_progress_db->getInstancesForAssignment($this->getId());
        foreach ($progresses as $progress) {
            $progress->delete();
        }

        $this->assignment->delete();
    }

    public function updateFromProgram()
    {
        $prg = $this->getStudyProgramme();
        $id = $this->getId();

        $prg->applyToSubTreeNodes(function ($node) use ($id) {
            $progress = $node->getProgressForAssignment($id);
            return $progress->updateFromProgramNode();
        });

        return $this;
    }

    public function addMissingProgresses()
    {
        require_once("Modules/StudyProgramme/classes/exceptions/class.ilStudyProgrammeNoProgressForAssignmentException.php");

        $prg = $this->getStudyProgramme();
        $id = $this->getId();

        // Make $this->assignment protected again afterwards.
        $prg->applyToSubTreeNodes(function ($node) use ($id) {
            try {
                $node->getProgressForAssignment($id);
            } catch (ilStudyProgrammeNoProgressForAssignmentException $e) {
                global $DIC;
                $ilLog = $DIC['ilLog'];
                $ilLog->write("Adding progress for: " . $this->getId() . " " . $node->getId());
                require_once("Modules/StudyProgramme/classes/model/class.ilStudyProgrammeProgress.php");
                $progress = ilStudyProgrammeProgress::createFor($node->getRawSettings(), $this->assignment);
                $progress->setStatus(ilStudyProgrammeProgress::STATUS_NOT_RELEVANT)
                         ->update();
            }
        });

        return $this;
    }
}