class.ilStudyProgrammeUserProgressDB.php

Go to the documentation of this file.

<?php

class ilStudyProgrammeUserProgressDB
{
    public function __construct(
        ilStudyProgrammeProgressRepository $progress_repository,
        ilStudyProgrammeAssignmentRepository $assignment_repository,
        ilLanguage $lng,
        ilStudyProgrammeEvents $events
    ) {
        $this->progress_repository = $progress_repository;
        $this->assignment_repository = $assignment_repository;
        $this->lng = $lng;
        $this->events = $events;
    }

    public function getInstance($a_assignment_id, $a_program_id, $a_user_id)
    {
        $prgrs = $this->progress_repository->readByIds($a_program_id, $a_assignment_id, $a_user_id);
        return new ilStudyProgrammeUserProgress(
            $prgrs,
            $this->progress_repository,
            $this->assignment_repository,
            $this->events
        );
    }

    public function getInstanceById($a_prgrs_id)
    {
        $prgrs = $this->progress_repository->read($a_prgrs_id);
        if ($prgrs === null) {
            throw new ilException("Unknown progress id $a_prgrs_id.");
        }
        return new ilStudyProgrammeUserProgress(
            $prgrs,
            $this->progress_repository,
            $this->assignment_repository,
            $this->events
        );
    }

    public function getInstancesForUser($a_program_id, $a_user_id)
    {
        return array_values(
            $this->getObjectsByModels(
                $this->progress_repository->readByPrgIdAndUserId($a_program_id, $a_user_id)
            )
        );
    }

    public function getInstanceForAssignment($a_program_id, $a_assignment_id)
    {
        $progress = $this->progress_repository->readByPrgIdAndAssignmentId($a_program_id, $a_assignment_id);
        if (!$progress) {
            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(
            $progress,
            $this->progress_repository,
            $this->assignment_repository,
            $this->events
        );
    }

    public function getInstancesForAssignment($a_assignment_id)
    {
        $progresses = $this->progress_repository->readByAssignmentId($a_assignment_id);
        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 $this->getObjectsByModels($progresses);
    }

    public function getInstancesForProgram($a_program_id)
    {
        return array_values($this->getObjectsByModels($this->progress_repository->readByPrgId($a_program_id)));
    }

    public function getExpiredSuccessfulInstances() : array
    {
        return $this->getObjectsByModels($this->progress_repository->readExpiredSuccessfull());
    }

    public function getPassedDeadline() : array
    {
        return $this->getObjectsByModels($this->progress_repository->readPassedDeadline());
    }

    public function getRiskyToFailInstances() : array
    {
        return $this->getObjectsByModels($this->progress_repository->readRiskyToFailInstances());
    }

    protected function getObjectsByModels(array $models) : array
    {
        return array_map(function ($dat) {
            return new ilStudyProgrammeUserProgress(
                $dat,
                $this->progress_repository,
                $this->assignment_repository,
                $this->events
            );
        }, $models);
    }

    public function statusToRepr($a_status)
    {
        $lng = $this->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'");
    }

    public function reminderSendFor(int $assignment_id) : void
    {
        $this->progress_repository->reminderSendFor($assignment_id);
    }
}