ilStudyProgrammeUserProgressDB Class Reference

Storage implementation for ilStudyProgrammeUserProgress. More...

Collaboration diagram for ilStudyProgrammeUserProgressDB:

Public Member Functions
	__construct (ilStudyProgrammeProgressRepository $progress_repository, ilStudyProgrammeAssignmentRepository $assignment_repository, ilLanguage $lng, ilStudyProgrammeEvents $events)
	getInstance ($a_assignment_id, $a_program_id, $a_user_id)
	Get an instance. More...
	getInstanceById ($a_prgrs_id)
	Get an instance by progress id. More...
	getInstancesForUser ($a_program_id, $a_user_id)
	Get the instances that user has on program. More...
	getInstanceForAssignment ($a_program_id, $a_assignment_id)
	Get the instance for the assignment on the program. More...
	getInstancesForAssignment ($a_assignment_id)
	Get the instance for an assignment. More...
	getInstancesForProgram ($a_program_id)
	Get the instances for a program node. More...
	getExpiredSuccessfulInstances ()
	Get all expired and successful progresses. More...
	getPassedDeadline ()
	getRiskyToFailInstances ()
	statusToRepr ($a_status)
	Get a user readable representation of a status. More...
	reminderSendFor (int $assignment_id)

Protected Member Functions
	getObjectsByModels (array $models)

Detailed Description

Storage implementation for ilStudyProgrammeUserProgress.

Author

: Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

: Nils Haagen <Nils Haage.nosp@m.n@co.nosp@m.ncept.nosp@m.s-an.nosp@m.d-tra.nosp@m.inin.nosp@m.g.de>

Definition at line 9 of file class.ilStudyProgrammeUserProgressDB.php.

Constructor & Destructor Documentation

__construct()

ilStudyProgrammeUserProgressDB::__construct	(	ilStudyProgrammeProgressRepository	$progress_repository,
		ilStudyProgrammeAssignmentRepository	$assignment_repository,
		ilLanguage	$lng,
		ilStudyProgrammeEvents	$events
	)

Definition at line 11 of file class.ilStudyProgrammeUserProgressDB.php.

References $lng.

      {
        $this->progress_repository = $progress_repository;
        $this->assignment_repository = $assignment_repository;
        $this->lng = $lng;
        $this->events = $events;
    }

Member Function Documentation

getExpiredSuccessfulInstances()

ilStudyProgrammeUserProgressDB::getExpiredSuccessfulInstances

(

)

Get all expired and successful progresses.

Returns

ilStudyProgrammeUserProgress[]

Definition at line 143 of file class.ilStudyProgrammeUserProgressDB.php.

References getObjectsByModels().

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

Here is the call graph for this function:

getInstance()

ilStudyProgrammeUserProgressDB::getInstance	(		$a_assignment_id,
			$a_program_id,
			$a_user_id
	)

Get an instance.

Just wraps constructor.

Exceptions

ilException

Parameters

int	$a_assignment_id
int	$a_program_id
int	$a_user_id

Returns

ilStudyProgrammeUserProgress

Definition at line 32 of file class.ilStudyProgrammeUserProgressDB.php.

    {
        $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
        );
    }

getInstanceById()

ilStudyProgrammeUserProgressDB::getInstanceById

(

$a_prgrs_id

)

Get an instance by progress id.

Parameters

int

$a_prgrs_id

Returns

ilStudyProgrammeUserProgress

Definition at line 49 of file class.ilStudyProgrammeUserProgressDB.php.

    {
        $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
        );
    }

getInstanceForAssignment()

ilStudyProgrammeUserProgressDB::getInstanceForAssignment	(		$a_program_id,
			$a_assignment_id
	)

Get the instance for the assignment on the program.

Throws when the node does not belong to the assignment.

Exceptions

ilException

Parameters

int	$a_program_id
int	$a_user_id

Returns

ilStudyProgrammeUserProgress

Definition at line 89 of file class.ilStudyProgrammeUserProgressDB.php.

    {
        $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
        );
    }

getInstancesForAssignment()

ilStudyProgrammeUserProgressDB::getInstancesForAssignment

(

$a_assignment_id

)

Get the instance for an assignment.

Throws when the node does not belong to the assignment.

Exceptions

ilException

Parameters

int	$a_program_id
int	$a_user_id

Returns

ilStudyProgrammeUserProgress

Definition at line 116 of file class.ilStudyProgrammeUserProgressDB.php.

References getObjectsByModels().

    {
        $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);
    }

Here is the call graph for this function:

getInstancesForProgram()

ilStudyProgrammeUserProgressDB::getInstancesForProgram

(

$a_program_id

)

Get the instances for a program node.

Parameters

int

$a_program_id

Returns

ilStudyProgrammeUserProgress[]

Definition at line 133 of file class.ilStudyProgrammeUserProgressDB.php.

References getObjectsByModels().

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

Here is the call graph for this function:

getInstancesForUser()

ilStudyProgrammeUserProgressDB::getInstancesForUser	(		$a_program_id,
			$a_user_id
	)

Get the instances that user has on program.

Parameters

int	$a_program_id
int	$a_user_id

Returns

ilStudyProgrammeUserProgress[]

Definition at line 70 of file class.ilStudyProgrammeUserProgressDB.php.

References getObjectsByModels().

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

Here is the call graph for this function:

getObjectsByModels()

ilStudyProgrammeUserProgressDB::getObjectsByModels ( array  $models )

protected

Definition at line 161 of file class.ilStudyProgrammeUserProgressDB.php.

Referenced by getExpiredSuccessfulInstances(), getInstancesForAssignment(), getInstancesForProgram(), getInstancesForUser(), getPassedDeadline(), and getRiskyToFailInstances().

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

Here is the caller graph for this function:

getPassedDeadline()

ilStudyProgrammeUserProgressDB::getPassedDeadline

(

)

Definition at line 148 of file class.ilStudyProgrammeUserProgressDB.php.

References getObjectsByModels().

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

Here is the call graph for this function:

getRiskyToFailInstances()

ilStudyProgrammeUserProgressDB::getRiskyToFailInstances

(

)

Returns

ilStudyProgrammeUserProgress[]

Definition at line 156 of file class.ilStudyProgrammeUserProgressDB.php.

References getObjectsByModels().

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

Here is the call graph for this function:

reminderSendFor()

ilStudyProgrammeUserProgressDB::reminderSendFor

(

int

$assignment_id

)

Definition at line 199 of file class.ilStudyProgrammeUserProgressDB.php.

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

statusToRepr()

ilStudyProgrammeUserProgressDB::statusToRepr

(

$a_status

)

Get a user readable representation of a status.

Definition at line 176 of file class.ilStudyProgrammeUserProgressDB.php.

References $lng, ilStudyProgrammeProgress\STATUS_ACCREDITED, ilStudyProgrammeProgress\STATUS_COMPLETED, ilStudyProgrammeProgress\STATUS_FAILED, ilStudyProgrammeProgress\STATUS_IN_PROGRESS, and ilStudyProgrammeProgress\STATUS_NOT_RELEVANT.

    {
        $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'");
    }

---

The documentation for this class was generated from the following file:

• Modules/StudyProgramme/classes/class.ilStudyProgrammeUserProgressDB.php