ilStudyProgrammeUserProgressDB Class Reference

Storage implementation for ilStudyProgrammeUserProgress. More...

Collaboration diagram for ilStudyProgrammeUserProgressDB:

Public Member Functions
	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...
	statusToRepr ($a_status)
	Get a user readable representation of a status. More...

Static Public Member Functions
static	getInstanceForAssignment ($a_program_id, $a_assignment_id)
	Get the instance for the assignment on the program. More...
static	getInstancesForAssignment ($a_assignment_id)
	Get the instance for an assignment. More...
static	getInstancesForProgram ($a_program_id)
	Get the instances for a program node. More...

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 11 of file class.ilStudyProgrammeUserProgressDB.php.

Member Function Documentation

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 23 of file class.ilStudyProgrammeUserProgressDB.php.

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

getInstanceById()

ilStudyProgrammeUserProgressDB::getInstanceById

(

$a_prgrs_id

)

Get an instance by progress id.

Parameters

int

$a_prgrs_id

Returns

ilStudyProgrammeUserProgress

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

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

getInstanceForAssignment()

static ilStudyProgrammeUserProgressDB::getInstanceForAssignment (   $a_program_id,   $a_assignment_id  )

static

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 70 of file class.ilStudyProgrammeUserProgressDB.php.

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

References ActiveRecord\where().

Here is the call graph for this function:

getInstancesForAssignment()

static ilStudyProgrammeUserProgressDB::getInstancesForAssignment (   $a_assignment_id )

static

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 94 of file class.ilStudyProgrammeUserProgressDB.php.

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

References ActiveRecord\where().

Here is the call graph for this function:

getInstancesForProgram()

static ilStudyProgrammeUserProgressDB::getInstancesForProgram (   $a_program_id )

static

Get the instances for a program node.

Parameters

int

$a_program_id

Returns

ilStudyProgrammeUserProgress[]

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

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

References ActiveRecord\where().

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 50 of file class.ilStudyProgrammeUserProgressDB.php.

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

References ActiveRecord\where().

Here is the call graph for this function:

statusToRepr()

ilStudyProgrammeUserProgressDB::statusToRepr

(

$a_status

)

Get a user readable representation of a status.

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

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

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

---

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

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