ilStudyProgrammeProgressDBRepository Class Reference

Inheritance diagram for ilStudyProgrammeProgressDBRepository:

Collaboration diagram for ilStudyProgrammeProgressDBRepository:

Public Member Functions
	__construct (ilDBInterface $db)
	createFor (ilStudyProgrammeSettings $prg, ilStudyProgrammeAssignment $ass, int $acting_user=null)
	get (int $id)
	Load progress belonging to a id.Will throw if the record does not exist yet. More...
	getByIds (int $prg_id, int $assignment_id)
	Load progress belonging to a prg id and assignment.Will throw if the record does not exist yet. More...
	getByPrgIdAndAssignmentId (int $prg_id, int $assignment_id)
	Load progress belonging to a prg id and assignment.Will throw if the record does not exist yet. More...
	getRootProgressOf (ilStudyProgrammeAssignment $assignment)
	getByPrgIdAndUserId (int $prg_id, int $usr_id)
	Load progress objects belonging to a prg id and a user id. More...
	getByPrgId (int $prg_id)
	Load progress objects belonging to a prg id. More...
	getFirstByPrgId (int $prg_id)
	getByAssignmentId (int $assignment_id)
	Load progress objects belonging to an assignment id.Will throw if the record does not exist yet. More...
	getExpiredSuccessfull ()
	Load all progress objects which are successfull and whose validity is expired. More...
	getPassedDeadline ()
	getRiskyToFailInstances ()
	update (ilStudyProgrammeProgress $progress)
	Update record corresponding to progress.Will throw if the record does not exist yet. More...
	delete (ilStudyProgrammeProgress $progress)
	Delete record corresponding to progress.Will throw if the record does not exist yet. More...
	deleteForAssignmentId (int $assignment_id)
	sentRiskyToFailFor (int $progress_id)
	sentExpiryInfoFor (int $progress_id)
	getRiskyToFail (array $programmes_and_due)
	getAboutToExpire (array $programmes_and_due, bool $discard_formerly_notified=true)
	deleteAllOrphanedProgresses (string $assignment_table, string $assignment_id_field)
	deleteProgressesFor (int $prg_obj_id)
Public Member Functions inherited from ilStudyProgrammeProgressRepository
	createFor (ilStudyProgrammeSettings $prg, ilStudyProgrammeAssignment $ass)
	Create a record corresponding to a progress and return corresponding object. More...

Data Fields
const	TABLE = 'prg_usr_progress'
const	FIELD_ID = 'id'
const	FIELD_ASSIGNMENT_ID = 'assignment_id'
const	FIELD_PRG_ID = 'prg_id'
const	FIELD_USR_ID = 'usr_id'
const	FIELD_POINTS = 'points'
const	FIELD_POINTS_CUR = 'points_cur'
const	FIELD_STATUS = 'status'
const	FIELD_COMPLETION_BY = 'completion_by'
const	FIELD_ASSIGNMENT_DATE = 'assignment_date'
const	FIELD_LAST_CHANGE = 'last_change'
const	FIELD_LAST_CHANGE_BY = 'last_change_by'
const	FIELD_COMPLETION_DATE = 'completion_date'
const	FIELD_DEADLINE = 'deadline'
const	FIELD_VQ_DATE = 'vq_date'
const	FIELD_INVALIDATED = 'invalidated'
const	FIELD_MAIL_SENT_RISKYTOFAIL = 'sent_mail_risky_to_fail'
const	FIELD_MAIL_SENT_WILLEXPIRE = 'sent_mail_expires'
const	FIELD_IS_INDIVIDUAL = 'individual'

Protected Member Functions
	insertRowDB (array $row)
	updateRowDB (array $data)
	buildByRow (array $row)
	loadByFilter (array $filter)
	loadExpiredSuccessful ()
	loadPassedDeadline ()
	loadRiskyToFailInstance ()
	getSQLHeader ()
	nextId ()

Protected Attributes
	$db

Static Protected Attributes
static	$cache = []

Detailed Description

Definition at line 5 of file class.ilStudyProgrammeProgressDBRepository.php.

Constructor & Destructor Documentation

__construct()

ilStudyProgrammeProgressDBRepository::__construct

(

ilDBInterface

$db

)

Definition at line 31 of file class.ilStudyProgrammeProgressDBRepository.php.

References $db.

    {
        $this->db = $db;
    }

Member Function Documentation

buildByRow()

ilStudyProgrammeProgressDBRepository::buildByRow ( array  $row )

protected

Exceptions

ilException

Definition at line 427 of file class.ilStudyProgrammeProgressDBRepository.php.

References ilStudyProgrammeProgress\DATE_FORMAT, ilStudyProgrammeProgress\DATE_TIME_FORMAT, and ilStudyProgrammeProgress\invalidate().

Referenced by createFor(), get(), getAboutToExpire(), getByAssignmentId(), getByPrgId(), getByPrgIdAndAssignmentId(), getByPrgIdAndUserId(), getExpiredSuccessfull(), getFirstByPrgId(), getPassedDeadline(), getRiskyToFail(), getRiskyToFailInstances(), and getRootProgressOf().

                                              : ilStudyProgrammeProgress
    {
        $prgrs = (new ilStudyProgrammeProgress((int) $row[self::FIELD_ID]))
            ->withAssignmentId((int) $row[self::FIELD_ASSIGNMENT_ID])
            ->withNodeId((int) $row[self::FIELD_PRG_ID])
            ->withUserId((int) $row[self::FIELD_USR_ID])
            ->withStatus((int) $row[self::FIELD_STATUS])
            ->withAmountOfPoints((int) $row[self::FIELD_POINTS])
            ->withCurrentAmountOfPoints((int) $row[self::FIELD_POINTS_CUR])
            ->withDeadline(
                $row[self::FIELD_DEADLINE] ?
                    DateTimeImmutable::createFromFormat(ilStudyProgrammeProgress::DATE_FORMAT, $row[self::FIELD_DEADLINE]) :
                    null
            )
            ->withAssignmentDate(
                DateTimeImmutable::createFromFormat(ilStudyProgrammeProgress::DATE_TIME_FORMAT, $row[self::FIELD_ASSIGNMENT_DATE])
            )
            ->withCompletion(
                (int) $row[self::FIELD_COMPLETION_BY],
                $row[self::FIELD_COMPLETION_DATE] ?
                    DateTimeImmutable::createFromFormat(ilStudyProgrammeProgress::DATE_TIME_FORMAT, $row[self::FIELD_COMPLETION_DATE]) :
                    null
            )
            ->withLastChange(
                (int) $row[self::FIELD_LAST_CHANGE_BY],
                $row[self::FIELD_LAST_CHANGE] ?
                    DateTimeImmutable::createFromFormat(ilStudyProgrammeProgress::DATE_TIME_FORMAT, $row[self::FIELD_LAST_CHANGE]) :
                    null
            )
            ->withValidityOfQualification(
                $row[self::FIELD_VQ_DATE] ?
                    DateTimeImmutable::createFromFormat(ilStudyProgrammeProgress::DATE_TIME_FORMAT, $row[self::FIELD_VQ_DATE]) :
                    null
            )
            ->withIndividualModifications((bool) $row[self::FIELD_IS_INDIVIDUAL]);



        if ((int) $row[self::FIELD_INVALIDATED] === 1) {
            $prgrs = $prgrs->invalidate();
        }

        return $prgrs;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createFor()

ilStudyProgrammeProgressDBRepository::createFor	(	ilStudyProgrammeSettings	$prg,
		ilStudyProgrammeAssignment	$ass,
		int	$acting_user = null
	)

Exceptions

ilException

Definition at line 41 of file class.ilStudyProgrammeProgressDBRepository.php.

References buildByRow(), ilStudyProgrammeSettings\getAssessmentSettings(), ilStudyProgrammeAssignment\getId(), ilStudyProgrammeSettings\getObjId(), ilStudyProgrammeAssignment\getUserId(), insertRowDB(), nextId(), ilUtil\now(), and ilStudyProgrammeProgress\STATUS_IN_PROGRESS.

      : ilStudyProgrammeProgress {
        $id = $this->nextId();
        $row = [
            self::FIELD_ID => $id,
            self::FIELD_ASSIGNMENT_ID => $ass->getId(),
            self::FIELD_PRG_ID => $prg->getObjId(),
            self::FIELD_USR_ID => $ass->getUserId(),
            self::FIELD_POINTS => $prg->getAssessmentSettings()->getPoints(),
            self::FIELD_POINTS_CUR => 0,
            self::FIELD_STATUS => ilStudyProgrammeProgress::STATUS_IN_PROGRESS,
            self::FIELD_COMPLETION_BY => null,
            self::FIELD_LAST_CHANGE => ilUtil::now(),
            self::FIELD_ASSIGNMENT_DATE => ilUtil::now(),
            self::FIELD_LAST_CHANGE_BY => $acting_user,
            self::FIELD_COMPLETION_DATE => null,
            self::FIELD_DEADLINE => null,
            self::FIELD_VQ_DATE => null,
            self::FIELD_INVALIDATED => 0,
            self::FIELD_IS_INDIVIDUAL => 0
        ];
        $this->insertRowDB($row);
        return $this->buildByRow($row);
    }

Here is the call graph for this function:

delete()

ilStudyProgrammeProgressDBRepository::delete

(

ilStudyProgrammeProgress

$progress

)

Delete record corresponding to progress.Will throw if the record does not exist yet.

Implements ilStudyProgrammeProgressRepository.

Definition at line 258 of file class.ilStudyProgrammeProgressDBRepository.php.

    {
        $this->deleteDB($progress->getId());
    }

deleteAllOrphanedProgresses()

ilStudyProgrammeProgressDBRepository::deleteAllOrphanedProgresses	(	string	$assignment_table,
		string	$assignment_id_field
	)

Definition at line 653 of file class.ilStudyProgrammeProgressDBRepository.php.

References $query.

      : void {
        $query = 'DELETE FROM ' . self::TABLE . PHP_EOL
            . 'WHERE ' . self::FIELD_ASSIGNMENT_ID . PHP_EOL
            . 'NOT IN (' . PHP_EOL
            . 'SELECT ' . $this->db->quoteIdentifier($assignment_id_field)
            . ' FROM ' . $this->db->quoteIdentifier($assignment_table) . PHP_EOL
            . ');' . PHP_EOL;
        $this->db->manipulate($query);
    }

deleteForAssignmentId()

ilStudyProgrammeProgressDBRepository::deleteForAssignmentId

(

int

$assignment_id

)

Returns

int[] node_ids the user had progresses on

Definition at line 291 of file class.ilStudyProgrammeProgressDBRepository.php.

References $query, and getByAssignmentId().

                                                              : array
    {
        $progresses = $this->getByAssignmentId($assignment_id);

        $query = 'DELETE FROM ' . self::TABLE . PHP_EOL
            . ' WHERE ' . self::FIELD_ASSIGNMENT_ID . ' = '
            . $this->db->quote($assignment_id, 'integer');

        $this->db->manipulate($query);

        return array_map(
            function ($progress) {
                return $progress->getNodeId();
            },
            $progresses
        );
    }

Here is the call graph for this function:

deleteProgressesFor()

ilStudyProgrammeProgressDBRepository::deleteProgressesFor

(

int

$prg_obj_id

)

Definition at line 666 of file class.ilStudyProgrammeProgressDBRepository.php.

References $query.

                                                         : void
    {
        $query = 'DELETE FROM ' . self::TABLE . PHP_EOL
            . ' WHERE ' . self::FIELD_PRG_ID . ' = '
            . $this->db->quote($prg_obj_id, 'integer');

        $this->db->manipulate($query);
    }

get()

ilStudyProgrammeProgressDBRepository::get

(

int

$id

)

Load progress belonging to a id.Will throw if the record does not exist yet.

Exceptions

ilException

Implements ilStudyProgrammeProgressRepository.

Definition at line 74 of file class.ilStudyProgrammeProgressDBRepository.php.

References buildByRow(), and loadByFilter().

                                 : ilStudyProgrammeProgress
    {
        foreach ($this->loadByFilter([self::FIELD_ID => $id]) as $row) {
            return $this->buildByRow($row);
        }
        throw new ilException('invalid id ' . $id);
    }

Here is the call graph for this function:

getAboutToExpire()

ilStudyProgrammeProgressDBRepository::getAboutToExpire	(	array	$programmes_and_due,
		bool	$discard_formerly_notified = true
	)

Parameters

array

<int, DateTimeImmutable> $programmes_and_due

Returns

ilStudyProgrammeProgress[]

Definition at line 616 of file class.ilStudyProgrammeProgressDBRepository.php.

References $query, $res, $ret, buildByRow(), ilStudyProgrammeProgress\DATE_FORMAT_ENDOFDAY, and getSQLHeader().

      : array {
        $ret = [];
        if (count($programmes_and_due) == 0) {
            return $ret;
        }

        $where = [];
        foreach ($programmes_and_due as $programme_obj_id => $due) {
            $due = $due->format(ilStudyProgrammeProgress::DATE_FORMAT_ENDOFDAY);
            $where_clause = '('
                . self::FIELD_PRG_ID . '=' . $programme_obj_id
                . ' AND ' . self::FIELD_VQ_DATE . '<=' . $this->db->quote($due, 'text');

            if ($discard_formerly_notified) {
                $where_clause .= ' AND ' . self::FIELD_MAIL_SENT_WILLEXPIRE . ' IS NULL';
            }
            
            $where_clause .= ')';
            $where[] = $where_clause;
        }

        $query = $this->getSQLHeader() . ' WHERE ' . implode(' OR ', $where);
        $res = $this->db->query($query);
        while ($rec = $this->db->fetchAssoc($res)) {
            $ret[] = $this->buildByRow($rec);
        }
        return $ret;
    }

Here is the call graph for this function:

getByAssignmentId()

ilStudyProgrammeProgressDBRepository::getByAssignmentId

(

int

$assignment_id

)

Load progress objects belonging to an assignment id.Will throw if the record does not exist yet.

Exceptions

ilException

Implements ilStudyProgrammeProgressRepository.

Definition at line 175 of file class.ilStudyProgrammeProgressDBRepository.php.

References buildByRow(), and loadByFilter().

Referenced by deleteForAssignmentId().

                                                          : array
    {
        $return = [];
        foreach ($this->loadByFilter([self::FIELD_ASSIGNMENT_ID => $assignment_id]) as $row) {
            $return[] = $this->buildByRow($row);
        }
        return $return;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getByIds()

ilStudyProgrammeProgressDBRepository::getByIds	(	int	$prg_id,
		int	$assignment_id
	)

Load progress belonging to a prg id and assignment.Will throw if the record does not exist yet.

Exceptions

ilException

Implements ilStudyProgrammeProgressRepository.

Definition at line 88 of file class.ilStudyProgrammeProgressDBRepository.php.

References getByPrgIdAndAssignmentId().

      : ilStudyProgrammeProgress {
        return $this->getByPrgIdAndAssignmentId($prg_id, $assignment_id);
    }

Here is the call graph for this function:

getByPrgId()

ilStudyProgrammeProgressDBRepository::getByPrgId

(

int

$prg_id

)

Load progress objects belonging to a prg id.

Exceptions

ilException

Implements ilStudyProgrammeProgressRepository.

Definition at line 150 of file class.ilStudyProgrammeProgressDBRepository.php.

References buildByRow(), and loadByFilter().

                                            : array
    {
        $return = [];
        foreach ($this->loadByFilter([self::FIELD_PRG_ID => $prg_id]) as $row) {
            $return[] = $this->buildByRow($row);
        }
        return $return;
    }

Here is the call graph for this function:

getByPrgIdAndAssignmentId()

ilStudyProgrammeProgressDBRepository::getByPrgIdAndAssignmentId	(	int	$prg_id,
		int	$assignment_id
	)

Load progress belonging to a prg id and assignment.Will throw if the record does not exist yet.

Exceptions

ilException

Returns

ilStudyProgrammeProgress | void

Implements ilStudyProgrammeProgressRepository.

Definition at line 102 of file class.ilStudyProgrammeProgressDBRepository.php.

References $rows, buildByRow(), and loadByFilter().

Referenced by getByIds().

    {
        $rows = $this->loadByFilter(
            [
                self::FIELD_PRG_ID => $prg_id,
                self::FIELD_ASSIGNMENT_ID => $assignment_id
            ]
        );

        foreach ($rows as $row) {
            return $this->buildByRow($row);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getByPrgIdAndUserId()

ilStudyProgrammeProgressDBRepository::getByPrgIdAndUserId	(	int	$prg_id,
		int	$usr_id
	)

Load progress objects belonging to a prg id and a user id.

Exceptions

ilException

Implements ilStudyProgrammeProgressRepository.

Definition at line 136 of file class.ilStudyProgrammeProgressDBRepository.php.

References buildByRow(), and loadByFilter().

                                                                  : array
    {
        $return = [];
        foreach ($this->loadByFilter([self::FIELD_PRG_ID => $prg_id, self::FIELD_USR_ID => $usr_id]) as $row) {
            $return[] = $this->buildByRow($row);
        }
        return $return;
    }

Here is the call graph for this function:

getExpiredSuccessfull()

ilStudyProgrammeProgressDBRepository::getExpiredSuccessfull

(

)

Load all progress objects which are successfull and whose validity is expired.

Exceptions

ilException

Implements ilStudyProgrammeProgressRepository.

Definition at line 189 of file class.ilStudyProgrammeProgressDBRepository.php.

References buildByRow(), and loadExpiredSuccessful().

                                            : array
    {
        $return = [];
        foreach ($this->loadExpiredSuccessful() as $row) {
            $return[] = $this->buildByRow($row);
        }
        return $return;
    }

Here is the call graph for this function:

getFirstByPrgId()

ilStudyProgrammeProgressDBRepository::getFirstByPrgId

(

int

$prg_id

)

Returns

ilStudyProgrammeProgress | void

Exceptions

ilException

Implements ilStudyProgrammeProgressRepository.

Definition at line 163 of file class.ilStudyProgrammeProgressDBRepository.php.

References buildByRow(), and loadByFilter().

    {
        foreach ($this->loadByFilter([self::FIELD_PRG_ID => $prg_id]) as $row) {
            return $this->buildByRow($row);
        }
    }

Here is the call graph for this function:

getPassedDeadline()

ilStudyProgrammeProgressDBRepository::getPassedDeadline

(

)

Exceptions

ilException

Implements ilStudyProgrammeProgressRepository.

Definition at line 203 of file class.ilStudyProgrammeProgressDBRepository.php.

References buildByRow(), and loadPassedDeadline().

                                        : array
    {
        $return = [];
        foreach ($this->loadPassedDeadline() as $row) {
            $return[] = $this->buildByRow($row);
        }
        return $return;
    }

Here is the call graph for this function:

getRiskyToFail()

ilStudyProgrammeProgressDBRepository::getRiskyToFail

(

array

$programmes_and_due

)

Parameters

array

<int, DateTimeImmutable> $programmes_and_due

Returns

ilStudyProgrammeProgress[]

Definition at line 587 of file class.ilStudyProgrammeProgressDBRepository.php.

References $query, $res, $ret, buildByRow(), ilStudyProgrammeProgress\DATE_FORMAT, and getSQLHeader().

                                                              : array
    {
        $ret = [];
        if (count($programmes_and_due) == 0) {
            return $ret;
        }

        $where = [];
        foreach ($programmes_and_due as $programme_obj_id => $due) {
            $due = $due->format(ilStudyProgrammeProgress::DATE_FORMAT);
            $where[] = '('
                . self::FIELD_PRG_ID . '=' . $programme_obj_id
                . ' AND ' . self::FIELD_DEADLINE . '<=' . $this->db->quote($due, 'text')
                . ' AND ' . self::FIELD_MAIL_SENT_RISKYTOFAIL . ' IS NULL'
                . ')';
        }
        $query = $this->getSQLHeader() . ' WHERE ' . implode(' OR ', $where);
        
        $res = $this->db->query($query);
        while ($rec = $this->db->fetchAssoc($res)) {
            $ret[] = $this->buildByRow($rec);
        }
        return $ret;
    }

Here is the call graph for this function:

getRiskyToFailInstances()

ilStudyProgrammeProgressDBRepository::getRiskyToFailInstances

(

)

Exceptions

ilException

Implements ilStudyProgrammeProgressRepository.

Definition at line 217 of file class.ilStudyProgrammeProgressDBRepository.php.

References buildByRow(), and loadRiskyToFailInstance().

                                              : array
    {
        $return = [];
        foreach ($this->loadRiskyToFailInstance() as $row) {
            $return[] = $this->buildByRow($row);
        }
        return $return;
    }

Here is the call graph for this function:

getRootProgressOf()

ilStudyProgrammeProgressDBRepository::getRootProgressOf

(

ilStudyProgrammeAssignment

$assignment

)

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

References $rows, buildByRow(), ilStudyProgrammeAssignment\getId(), ilStudyProgrammeAssignment\getRootId(), ilStudyProgrammeAssignment\getUserId(), and loadByFilter().

                                                                              : ilStudyProgrammeProgress
    {
        $rows = $this->loadByFilter(
            [
                self::FIELD_PRG_ID => $assignment->getRootId(),
                self::FIELD_ASSIGNMENT_ID => $assignment->getId(),
                self::FIELD_USR_ID => $assignment->getUserId()
            ]
        );

        foreach ($rows as $row) {
            return $this->buildByRow($row);
        }
    }

Here is the call graph for this function:

getSQLHeader()

ilStudyProgrammeProgressDBRepository::getSQLHeader ( )

protected

Definition at line 562 of file class.ilStudyProgrammeProgressDBRepository.php.

Referenced by getAboutToExpire(), getRiskyToFail(), loadByFilter(), loadExpiredSuccessful(), loadPassedDeadline(), and loadRiskyToFailInstance().

                                      : string
    {
        return 'SELECT ' . self::FIELD_ID
            . ', ' . self::FIELD_ASSIGNMENT_ID
            . ', ' . self::FIELD_PRG_ID
            . ', ' . self::FIELD_USR_ID
            . ', ' . self::FIELD_STATUS
            . ', ' . self::FIELD_POINTS
            . ', ' . self::FIELD_POINTS_CUR
            . ', ' . self::FIELD_COMPLETION_BY
            . ', ' . self::FIELD_LAST_CHANGE
            . ', ' . self::FIELD_LAST_CHANGE_BY
            . ', ' . self::FIELD_ASSIGNMENT_DATE
            . ', ' . self::FIELD_COMPLETION_DATE
            . ', ' . self::FIELD_DEADLINE
            . ', ' . self::FIELD_VQ_DATE
            . ', ' . self::FIELD_INVALIDATED
            . ', ' . self::FIELD_IS_INDIVIDUAL
            . ' FROM ' . self::TABLE;
    }

Here is the caller graph for this function:

insertRowDB()

ilStudyProgrammeProgressDBRepository::insertRowDB ( array  $row )

protected

Definition at line 263 of file class.ilStudyProgrammeProgressDBRepository.php.

Referenced by createFor().

    {
        $this->db->insert(
            self::TABLE,
            [
                self::FIELD_ID => ['integer', $row[self::FIELD_ID]]
                , self::FIELD_ASSIGNMENT_ID => ['integer', $row[self::FIELD_ASSIGNMENT_ID]]
                , self::FIELD_PRG_ID => ['integer', $row[self::FIELD_PRG_ID]]
                , self::FIELD_USR_ID => ['integer', $row[self::FIELD_USR_ID]]
                , self::FIELD_STATUS => ['integer', $row[self::FIELD_STATUS]]
                , self::FIELD_POINTS => ['integer', $row[self::FIELD_POINTS]]
                , self::FIELD_POINTS_CUR => ['integer', $row[self::FIELD_POINTS_CUR]]
                , self::FIELD_COMPLETION_BY => ['integer', $row[self::FIELD_COMPLETION_BY]]
                , self::FIELD_LAST_CHANGE_BY => ['integer', $row[self::FIELD_LAST_CHANGE_BY]]
                , self::FIELD_LAST_CHANGE => ['text', $row[self::FIELD_LAST_CHANGE]]
                , self::FIELD_ASSIGNMENT_DATE => ['timestamp', $row[self::FIELD_ASSIGNMENT_DATE]]
                , self::FIELD_COMPLETION_DATE => ['timestamp', $row[self::FIELD_COMPLETION_DATE]]
                , self::FIELD_DEADLINE => ['text', $row[self::FIELD_DEADLINE]]
                , self::FIELD_VQ_DATE => ['timestamp', $row[self::FIELD_VQ_DATE]]
                , self::FIELD_INVALIDATED => ['timestamp', $row[self::FIELD_INVALIDATED]]
                , self::FIELD_IS_INDIVIDUAL => ['integer', $row[self::FIELD_IS_INDIVIDUAL]]
            ]
        );
    }

Here is the caller graph for this function:

loadByFilter()

ilStudyProgrammeProgressDBRepository::loadByFilter ( array  $filter )

protected

Definition at line 472 of file class.ilStudyProgrammeProgressDBRepository.php.

References $res, and getSQLHeader().

Referenced by get(), getByAssignmentId(), getByPrgId(), getByPrgIdAndAssignmentId(), getByPrgIdAndUserId(), getFirstByPrgId(), and getRootProgressOf().

    {
        $q = $this->getSQLHeader()
            . ' WHERE TRUE';
        foreach ($filter as $field => $value) {
            $q .= '     AND ' . $field . ' = ' . $this->db->quote($value, 'text');
        }
        $res = $this->db->query($q);
        while ($rec = $this->db->fetchAssoc($res)) {
            yield $rec;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

loadExpiredSuccessful()

ilStudyProgrammeProgressDBRepository::loadExpiredSuccessful ( )

protected

Definition at line 485 of file class.ilStudyProgrammeProgressDBRepository.php.

References $res, ilStudyProgrammeProgress\DATE_FORMAT, getSQLHeader(), ilStudyProgrammeProgress\STATUS_ACCREDITED, and ilStudyProgrammeProgress\STATUS_COMPLETED.

Referenced by getExpiredSuccessfull().

    {
        $q = $this->getSQLHeader()
            . ' WHERE ' . $this->db->in(
                self::FIELD_STATUS,
                [
                    ilStudyProgrammeProgress::STATUS_ACCREDITED,
                    ilStudyProgrammeProgress::STATUS_COMPLETED
                ],
                false,
                'integer'
            )
            . '     AND ' . self::FIELD_VQ_DATE . ' IS NOT NULL'
            . '     AND DATE(' . self::FIELD_VQ_DATE . ') < '
            . $this->db->quote(
                (new DateTimeImmutable())->format(ilStudyProgrammeProgress::DATE_FORMAT),
                'text'
            )
            . '    AND ' . self::FIELD_INVALIDATED . ' != 1 OR ' . self::FIELD_INVALIDATED . ' IS NULL';

        $res = $this->db->query($q);
        while ($rec = $this->db->fetchAssoc($res)) {
            yield $rec;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

loadPassedDeadline()

ilStudyProgrammeProgressDBRepository::loadPassedDeadline ( )

protected

Definition at line 511 of file class.ilStudyProgrammeProgressDBRepository.php.

References $res, ilStudyProgrammeProgress\DATE_FORMAT, getSQLHeader(), ilStudyProgrammeProgress\STATUS_ACCREDITED, and ilStudyProgrammeProgress\STATUS_IN_PROGRESS.

Referenced by getPassedDeadline().

    {
        $q =
             $this->getSQLHeader() . PHP_EOL
            . 'WHERE ' . $this->db->in(
                self::FIELD_STATUS,
                [
                    ilStudyProgrammeProgress::STATUS_IN_PROGRESS,
                    ilStudyProgrammeProgress::STATUS_ACCREDITED
                ],
                false,
                'integer'
            ) . PHP_EOL
            . 'AND ' . self::FIELD_DEADLINE . ' IS NOT NULL' . PHP_EOL
            . 'AND DATE(' . self::FIELD_DEADLINE . ') < ' . $this->db->quote(
                (new DateTimeImmutable())->format(ilStudyProgrammeProgress::DATE_FORMAT),
                'text'
            ) . PHP_EOL
        ;
        $res = $this->db->query($q);
        while ($rec = $this->db->fetchAssoc($res)) {
            yield $rec;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

loadRiskyToFailInstance()

ilStudyProgrammeProgressDBRepository::loadRiskyToFailInstance ( )

protected

Definition at line 536 of file class.ilStudyProgrammeProgressDBRepository.php.

References $res, ilStudyProgrammeProgress\DATE_FORMAT, getSQLHeader(), ilStudyProgrammeProgress\STATUS_ACCREDITED, and ilStudyProgrammeProgress\STATUS_COMPLETED.

Referenced by getRiskyToFailInstances().

    {
        $q = $this->getSQLHeader()
            . ' WHERE ' . $this->db->in(
                self::FIELD_STATUS,
                [
                    ilStudyProgrammeProgress::STATUS_ACCREDITED,
                    ilStudyProgrammeProgress::STATUS_COMPLETED
                ],
                true,
                'integer'
            )
            . '     AND ' . self::FIELD_DEADLINE . ' IS NOT NULL'
            . '     AND DATE(' . self::FIELD_DEADLINE . ') < '
            . $this->db->quote(
                (new DateTimeImmutable())->format(ilStudyProgrammeProgress::DATE_FORMAT),
                'text'
            )
            . '    AND ' . self::FIELD_MAIL_SENT_RISKYTOFAIL . ' IS NULL'
        ;
        $res = $this->db->query($q);
        while ($rec = $this->db->fetchAssoc($res)) {
            yield $rec;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

nextId()

ilStudyProgrammeProgressDBRepository::nextId ( )

protected

Definition at line 648 of file class.ilStudyProgrammeProgressDBRepository.php.

Referenced by createFor().

                                : int
    {
        return (int) $this->db->nextId(self::TABLE);
    }

Here is the caller graph for this function:

sentExpiryInfoFor()

ilStudyProgrammeProgressDBRepository::sentExpiryInfoFor

(

int

$progress_id

)

Definition at line 328 of file class.ilStudyProgrammeProgressDBRepository.php.

                                                        : void
    {
        $where = [
            self::FIELD_ID => [
                'integer',
                $progress_id
            ]
        ];

        $values = [
            self::FIELD_MAIL_SENT_WILLEXPIRE => [
                'timestamp',
                date('Y-m-d H:i:s')
            ]
        ];

        $this->db->update(self::TABLE, $values, $where);
    }

sentRiskyToFailFor()

ilStudyProgrammeProgressDBRepository::sentRiskyToFailFor

(

int

$progress_id

)

Definition at line 309 of file class.ilStudyProgrammeProgressDBRepository.php.

                                                         : void
    {
        $where = [
            self::FIELD_ID => [
                'integer',
                $progress_id
            ]
        ];

        $values = [
            self::FIELD_MAIL_SENT_RISKYTOFAIL => [
                'timestamp',
                date('Y-m-d H:i:s')
            ]
        ];

        $this->db->update(self::TABLE, $values, $where);
    }

update()

ilStudyProgrammeProgressDBRepository::update

(

ilStudyProgrammeProgress

$progress

)

Update record corresponding to progress.Will throw if the record does not exist yet.

Implements ilStudyProgrammeProgressRepository.

Definition at line 229 of file class.ilStudyProgrammeProgressDBRepository.php.

References ilStudyProgrammeProgress\DATE_FORMAT, ilStudyProgrammeProgress\DATE_TIME_FORMAT, ilStudyProgrammeProgress\getAmountOfPoints(), ilStudyProgrammeProgress\getAssignmentDate(), ilStudyProgrammeProgress\getAssignmentId(), ilStudyProgrammeProgress\getCompletionBy(), ilStudyProgrammeProgress\getCompletionDate(), ilStudyProgrammeProgress\getCurrentAmountOfPoints(), ilStudyProgrammeProgress\getDeadline(), ilStudyProgrammeProgress\getId(), ilStudyProgrammeProgress\getLastChange(), ilStudyProgrammeProgress\getLastChangeBy(), ilStudyProgrammeProgress\getNodeId(), ilStudyProgrammeProgress\getStatus(), ilStudyProgrammeProgress\getUserId(), ilStudyProgrammeProgress\getValidityOfQualification(), ilStudyProgrammeProgress\hasIndividualModifications(), ilStudyProgrammeProgress\isInvalidated(), and updateRowDB().

    {
        $this->updateRowDB(
            [
                self::FIELD_ID => $progress->getId(),
                self::FIELD_ASSIGNMENT_ID => $progress->getAssignmentId(),
                self::FIELD_PRG_ID => $progress->getNodeId(),
                self::FIELD_USR_ID => $progress->getUserId(),
                self::FIELD_STATUS => $progress->getStatus(),
                self::FIELD_POINTS => $progress->getAmountOfPoints(),
                self::FIELD_POINTS_CUR => $progress->getCurrentAmountOfPoints(),
                self::FIELD_COMPLETION_BY => $progress->getCompletionBy(),
                self::FIELD_LAST_CHANGE_BY => $progress->getLastChangeBy(),
                self::FIELD_LAST_CHANGE => $progress->getLastChange()->format(ilStudyProgrammeProgress::DATE_TIME_FORMAT),
                self::FIELD_ASSIGNMENT_DATE => $progress->getAssignmentDate()->format(ilStudyProgrammeProgress::DATE_TIME_FORMAT),
                self::FIELD_COMPLETION_DATE =>
                    $progress->getCompletionDate() ?
                        $progress->getCompletionDate()->format(ilStudyProgrammeProgress::DATE_TIME_FORMAT) : null,
                self::FIELD_DEADLINE => $progress->getDeadline() ? $progress->getDeadline()->format(ilStudyProgrammeProgress::DATE_FORMAT) : null,
                self::FIELD_VQ_DATE => $progress->getValidityOfQualification() ? $progress->getValidityOfQualification()->format(ilStudyProgrammeProgress::DATE_TIME_FORMAT) : null,
                self::FIELD_INVALIDATED => $progress->isInvalidated() ? 1 : 0,
                self::FIELD_IS_INDIVIDUAL => $progress->hasIndividualModifications() ? 1 : 0
            ]
        );
    }

Here is the call graph for this function:

updateRowDB()

ilStudyProgrammeProgressDBRepository::updateRowDB ( array  $data )

protected

Definition at line 349 of file class.ilStudyProgrammeProgressDBRepository.php.

Referenced by update().

    {
        $where = [
            self::FIELD_ID => [
                'integer',
                $data[self::FIELD_ID]
            ]
        ];

        $values = [
            self::FIELD_ASSIGNMENT_ID => [
                'integer',
                $data[self::FIELD_ASSIGNMENT_ID]
            ],
            self::FIELD_PRG_ID => [
                'integer',
                $data[self::FIELD_PRG_ID]
            ],
            self::FIELD_USR_ID => [
                'integer',
                $data[self::FIELD_USR_ID]
            ],
            self::FIELD_STATUS => [
                'integer',
                $data[self::FIELD_STATUS]
            ],
            self::FIELD_POINTS => [
                'integer',
                $data[self::FIELD_POINTS]
            ],
            self::FIELD_POINTS_CUR => [
                'integer',
                $data[self::FIELD_POINTS_CUR]
            ],
            self::FIELD_COMPLETION_BY => [
                'integer',
                $data[self::FIELD_COMPLETION_BY]
            ],
            self::FIELD_LAST_CHANGE_BY => [
                'integer',
                $data[self::FIELD_LAST_CHANGE_BY]
            ],
            self::FIELD_LAST_CHANGE => [
                'text',
                $data[self::FIELD_LAST_CHANGE]
            ],
            self::FIELD_ASSIGNMENT_DATE => [
                'timestamp',
                $data[self::FIELD_ASSIGNMENT_DATE]
            ],
            self::FIELD_COMPLETION_DATE => [
                'timestamp',
                $data[self::FIELD_COMPLETION_DATE]
            ],
            self::FIELD_DEADLINE => [
                'text',
                $data[self::FIELD_DEADLINE]
            ],
            self::FIELD_VQ_DATE => [
                'timestamp',
                $data[self::FIELD_VQ_DATE]
            ],
            self::FIELD_INVALIDATED => [
                'integer',
                $data[self::FIELD_INVALIDATED]
            ],
            self::FIELD_IS_INDIVIDUAL => [
                'integer',
                $data[self::FIELD_IS_INDIVIDUAL]
            ]
        ];

        $this->db->update(self::TABLE, $values, $where);
    }

Here is the caller graph for this function:

Field Documentation

$cache

ilStudyProgrammeProgressDBRepository::$cache = []

staticprotected

Definition at line 7 of file class.ilStudyProgrammeProgressDBRepository.php.

$db

ilStudyProgrammeProgressDBRepository::$db

protected

Definition at line 8 of file class.ilStudyProgrammeProgressDBRepository.php.

Referenced by __construct().

FIELD_ASSIGNMENT_DATE

const ilStudyProgrammeProgressDBRepository::FIELD_ASSIGNMENT_DATE = 'assignment_date'

Definition at line 20 of file class.ilStudyProgrammeProgressDBRepository.php.

FIELD_ASSIGNMENT_ID

const ilStudyProgrammeProgressDBRepository::FIELD_ASSIGNMENT_ID = 'assignment_id'

Definition at line 13 of file class.ilStudyProgrammeProgressDBRepository.php.

FIELD_COMPLETION_BY

const ilStudyProgrammeProgressDBRepository::FIELD_COMPLETION_BY = 'completion_by'

Definition at line 19 of file class.ilStudyProgrammeProgressDBRepository.php.

FIELD_COMPLETION_DATE

const ilStudyProgrammeProgressDBRepository::FIELD_COMPLETION_DATE = 'completion_date'

Definition at line 23 of file class.ilStudyProgrammeProgressDBRepository.php.

FIELD_DEADLINE

const ilStudyProgrammeProgressDBRepository::FIELD_DEADLINE = 'deadline'

Definition at line 24 of file class.ilStudyProgrammeProgressDBRepository.php.

FIELD_ID

const ilStudyProgrammeProgressDBRepository::FIELD_ID = 'id'

Definition at line 12 of file class.ilStudyProgrammeProgressDBRepository.php.

Referenced by ilStudyProgrammeProgressRepositoryTest\tearDownAfterClass().

FIELD_INVALIDATED

const ilStudyProgrammeProgressDBRepository::FIELD_INVALIDATED = 'invalidated'

Definition at line 26 of file class.ilStudyProgrammeProgressDBRepository.php.

FIELD_IS_INDIVIDUAL

const ilStudyProgrammeProgressDBRepository::FIELD_IS_INDIVIDUAL = 'individual'

Definition at line 29 of file class.ilStudyProgrammeProgressDBRepository.php.

FIELD_LAST_CHANGE

const ilStudyProgrammeProgressDBRepository::FIELD_LAST_CHANGE = 'last_change'

Definition at line 21 of file class.ilStudyProgrammeProgressDBRepository.php.

FIELD_LAST_CHANGE_BY

const ilStudyProgrammeProgressDBRepository::FIELD_LAST_CHANGE_BY = 'last_change_by'

Definition at line 22 of file class.ilStudyProgrammeProgressDBRepository.php.

FIELD_MAIL_SENT_RISKYTOFAIL

const ilStudyProgrammeProgressDBRepository::FIELD_MAIL_SENT_RISKYTOFAIL = 'sent_mail_risky_to_fail'

Definition at line 27 of file class.ilStudyProgrammeProgressDBRepository.php.

FIELD_MAIL_SENT_WILLEXPIRE

const ilStudyProgrammeProgressDBRepository::FIELD_MAIL_SENT_WILLEXPIRE = 'sent_mail_expires'

Definition at line 28 of file class.ilStudyProgrammeProgressDBRepository.php.

FIELD_POINTS

const ilStudyProgrammeProgressDBRepository::FIELD_POINTS = 'points'

Definition at line 16 of file class.ilStudyProgrammeProgressDBRepository.php.

FIELD_POINTS_CUR

const ilStudyProgrammeProgressDBRepository::FIELD_POINTS_CUR = 'points_cur'

Definition at line 17 of file class.ilStudyProgrammeProgressDBRepository.php.

FIELD_PRG_ID

const ilStudyProgrammeProgressDBRepository::FIELD_PRG_ID = 'prg_id'

Definition at line 14 of file class.ilStudyProgrammeProgressDBRepository.php.

FIELD_STATUS

const ilStudyProgrammeProgressDBRepository::FIELD_STATUS = 'status'

Definition at line 18 of file class.ilStudyProgrammeProgressDBRepository.php.

FIELD_USR_ID

const ilStudyProgrammeProgressDBRepository::FIELD_USR_ID = 'usr_id'

Definition at line 15 of file class.ilStudyProgrammeProgressDBRepository.php.

FIELD_VQ_DATE

const ilStudyProgrammeProgressDBRepository::FIELD_VQ_DATE = 'vq_date'

Definition at line 25 of file class.ilStudyProgrammeProgressDBRepository.php.

TABLE

const ilStudyProgrammeProgressDBRepository::TABLE = 'prg_usr_progress'

Definition at line 10 of file class.ilStudyProgrammeProgressDBRepository.php.

Referenced by ilStudyProgrammeMembersTableGUI\getFrom(), and ilStudyProgrammeProgressRepositoryTest\tearDownAfterClass().

---

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

• Modules/StudyProgramme/classes/model/Progress/class.ilStudyProgrammeProgressDBRepository.php