class.ilStudyProgrammeUserProgressDB.php

Go to the documentation of this file.

<?php
require_once("./Modules/StudyProgramme/classes/model/class.ilStudyProgrammeProgress.php");
require_once("./Modules/StudyProgramme/classes/class.ilStudyProgrammeUserProgress.php");

class ilStudyProgrammeUserProgressDB
{

    public function getInstance($a_assignment_id, $a_program_id, $a_user_id)
    {
        return new ilStudyProgrammeUserProgress(array($a_assignment_id, $a_program_id, $a_user_id));
    }

    public function getInstanceById($a_prgrs_id)
    {
        $prgrs = ilStudyProgrammeProgress::find($a_prgrs_id);
        if ($prgrs === null) {
            throw new ilException("Unknown progress id $a_prgrs_id.");
        }
        return new ilStudyProgrammeUserProgress($prgrs);
    }

    public function getInstancesForUser($a_program_id, $a_user_id)
    {
        $progresses = ilStudyProgrammeProgress::where(array( "prg_id" => $a_program_id
                            , "usr_id" => $a_user_id
                            ))->get();
        return array_values(array_map(function ($dat) {
            return new ilStudyProgrammeUserProgress($dat);
        }, $progresses));
    }

    public static function getInstanceForAssignment($a_program_id, $a_assignment_id)
    {
        $progresses = ilStudyProgrammeProgress::where(array( "prg_id" => $a_program_id
                            , "assignment_id" => $a_assignment_id
                            ))->get();
        if (count($progresses) == 0) {
            require_once("Modules/StudyProgramme/classes/exceptions/class.ilStudyProgrammeNoProgressForAssignmentException.php");
            throw new ilStudyProgrammeNoProgressForAssignmentException("ilStudyProgrammeUserProgress::getInstanceForAssignment: "
                                . "Assignment '$a_assignment_id' does not belong to program "
                                . "'$a_program_id'");
        }
        return new ilStudyProgrammeUserProgress(array_shift($progresses));
    }

    public static function getInstancesForAssignment($a_assignment_id)
    {
        $progresses = ilStudyProgrammeProgress::where(array( "assignment_id" => $a_assignment_id
                            ))->get();
        if (count($progresses) == 0) {
            require_once("Modules/StudyProgramme/classes/exceptions/class.ilStudyProgrammeNoProgressForAssignmentException.php");
            throw new ilStudyProgrammeNoProgressForAssignmentException("ilStudyProgrammeUserProgress::getInstancesForAssignment: "
                                . "Can't find progresses for assignment '$a_assignment_id'.");
        }
        return array_map(function ($dat) {
            return new ilStudyProgrammeUserProgress($dat);
        }, $progresses);
    }

    public static function getInstancesForProgram($a_program_id)
    {
        $progresses = ilStudyProgrammeProgress::where(array( "prg_id" => $a_program_id
                            ))->get();
        return array_values(array_map(function ($dat) {
            return new ilStudyProgrammeUserProgress($dat);
        }, $progresses));
    }

    public function statusToRepr($a_status)
    {
        global $DIC;
        $lng = $DIC['lng'];
        $lng->loadLanguageModule("prg");

        if ($a_status == ilStudyProgrammeProgress::STATUS_IN_PROGRESS) {
            return $lng->txt("prg_status_in_progress");
        }
        if ($a_status == ilStudyProgrammeProgress::STATUS_COMPLETED) {
            return $lng->txt("prg_status_completed");
        }
        if ($a_status == ilStudyProgrammeProgress::STATUS_ACCREDITED) {
            return $lng->txt("prg_status_accredited");
        }
        if ($a_status == ilStudyProgrammeProgress::STATUS_NOT_RELEVANT) {
            return $lng->txt("prg_status_not_relevant");
        }
        if ($a_status == ilStudyProgrammeProgress::STATUS_FAILED) {
            return $lng->txt("prg_status_failed");
        }
        throw new ilException("Unknown status: '$a_status'");
    }
}