Inheritance diagram for ilStudyProgrammeAssignmentDBRepository:

Collaboration diagram for ilStudyProgrammeAssignmentDBRepository:

Public Member Functions
	__construct (ilDBInterface $db)

	createFor (int $root_prg_id, int $usr_id, int $assigning_usr_id)
	Create a record corresponding to a SP-Object and return represending settings.Will throw if a record allready exists. More...

	read (int $id)
	Load settings belonging to a SP-Object.Will throw if the record does not exist yet. Returns ilStudyProgrammeAssignment \| null More...

	readByUsrId (int $usr_id)
	Get all assignments of a user. More...

	readByPrgId (int $prg_id)
	Get all assignments to a prg. More...

	readByUsrIdAndPrgId (int $usr_id, int $prg_id)

	readDueToRestart ()
	Get all assignments due to restart and not restrted yet. More...

	readDueToRestartAndMail ()

	readDueToManuelRestart (int $days_before_end)
	Get all assignments due to restart and not restrted yet. More...

	update (ilStudyProgrammeAssignment $assignment)
	Update settings belonging to a SP-Object.Will throw if the record does not exist yet. More...

	delete (ilStudyProgrammeAssignment $assignment)
	Delete record corresponding to settings.Will throw if the record does not exist yet. More...

	reminderSendFor (int $assignment_id)

	getDashboardInstancesforUser (int $usr_id)

	createFor (int $prg_id, int $usr_id, int $assigning_usr_id)
	Create a record corresponding to a SP-Object and return represending settings. More...

	read (int $id)
	Load settings belonging to a SP-Object. More...

	readByUsrId (int $usr_id)
	Get all assignments of a user. More...

	readByPrgId (int $prg_id)
	Get all assignments to a prg. More...

	readDueToRestart ()
	Get all assignments due to restart and not restrted yet. More...

	readDueToManuelRestart (int $days_before_end)
	Get all assignments due to restart and not restrted yet. More...

	update (ilStudyProgrammeAssignment $assignment)
	Update settings belonging to a SP-Object. More...

	delete (ilStudyProgrammeAssignment $assignment)
	Delete record corresponding to settings. More...

Data Fields
const	TABLE = 'prg_usr_assignments'

const	FIELD_ID = 'id'

const	FIELD_USR_ID = 'usr_id'

const	FIELD_ROOT_PRG_ID = 'root_prg_id'

const	FIELD_LAST_CHANGE = 'last_change'

const	FIELD_LAST_CHANGE_BY = 'last_change_by'

const	FIELD_RESTART_DATE = 'restart_date'

const	FIELD_RESTARTED_ASSIGNMENT_ID = 'restarted_assignment_id'

const	FIELD_RESTART_MAIL = 'restart_mail_send'

Protected Member Functions
	loadDueToRestart ()

	loadDueToRestartAndMail ()

	getSQLHeader ()

	getDueToRestartBaseSQL ()

	loadDueToManuelRestart (int $days_before_end)

	assignmentByRow (array $row)

	loadByFilterDB (array $filter)

	insertRowDB (array $row)

	updatedRowDB (array $values)

	deleteDB (int $id)

	nextId ()

Protected Attributes
	$db

Detailed Description

Definition at line 4 of file class.ilStudyProgrammeAssignmentDBRepository.php.

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeAssignmentDBRepository::__construct ( ilDBInterface $db )

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

    {
        $this->db = $db;
    }

References $db.

Member Function Documentation

◆ assignmentByRow()

ilStudyProgrammeAssignmentDBRepository::assignmentByRow ( array $row )

protected

Exceptions

ilException

Definition at line 307 of file class.ilStudyProgrammeAssignmentDBRepository.php.

                                                   : ilStudyProgrammeAssignment
    {
        return (new ilStudyProgrammeAssignment($row[self::FIELD_ID]))
            ->setRootId($row[self::FIELD_ROOT_PRG_ID])
            ->setUserId($row[self::FIELD_USR_ID])
            ->setLastChangeBy($row[self::FIELD_LAST_CHANGE_BY])
            ->setLastChange(DateTime::createFromFormat(
                ilStudyProgrammeAssignment::DATE_TIME_FORMAT,
                $row[self::FIELD_LAST_CHANGE]
            ))
            ->setRestartDate(
                $row[self::FIELD_RESTART_DATE] ?
                    DateTime::createFromFormat(ilStudyProgrammeAssignment::DATE_TIME_FORMAT, $row[self::FIELD_RESTART_DATE]) :
                    null
            )
            ->setRestartedAssignmentId($row[self::FIELD_RESTARTED_ASSIGNMENT_ID]);
    }

References ilStudyProgrammeAssignment\DATE_TIME_FORMAT, and ilStudyProgrammeAssignment\setRootId().

Referenced by createFor(), getDashboardInstancesforUser(), read(), readByPrgId(), readByUsrId(), readByUsrIdAndPrgId(), readDueToManuelRestart(), readDueToRestart(), and readDueToRestartAndMail().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createFor()

ilStudyProgrammeAssignmentDBRepository::createFor	(	int	$root_prg_id,
		int	$usr_id,
		int	$assigning_usr_id
	)

Create a record corresponding to a SP-Object and return represending settings.Will throw if a record allready exists.

Exceptions

ilException

Implements ilStudyProgrammeAssignmentRepository.

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

                                                                                    : ilStudyProgrammeAssignment
    {
        if (ilObject::_lookupType($usr_id) != "usr") {
            throw new ilException("ilStudyProgrammeAssignment::createFor: '$usr_id' "
                . "is no id of a user.");
        }
        if (ilObject::_lookupType($root_prg_id) != "prg") {
            throw new ilException("ilStudyProgrammeAssignment::createFor: '$root_prg_id' "
                . "is no id of a prg.");
        }
        $row = [
            self::FIELD_ID => $this->nextId(),
            self::FIELD_USR_ID => $usr_id,
            self::FIELD_ROOT_PRG_ID => $root_prg_id,
            self::FIELD_LAST_CHANGE_BY => $assigning_usr_id,
            self::FIELD_LAST_CHANGE => ilUtil::now(),
            self::FIELD_RESTART_DATE => null,
            self::FIELD_RESTARTED_ASSIGNMENT_ID => ilStudyProgrammeAssignment::NO_RESTARTED_ASSIGNMENT
        ];
        $this->insertRowDB($row);
        return $this->assignmentByRow($row)->updateLastChange();
    }

References ilObject\_lookupType(), assignmentByRow(), insertRowDB(), nextId(), ilStudyProgrammeAssignment\NO_RESTARTED_ASSIGNMENT, and ilUtil\now().

Here is the call graph for this function:

◆ delete()

ilStudyProgrammeAssignmentDBRepository::delete ( ilStudyProgrammeAssignment $assignment )

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

Implements ilStudyProgrammeAssignmentRepository.

Definition at line 241 of file class.ilStudyProgrammeAssignmentDBRepository.php.

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

References deleteDB().

Here is the call graph for this function:

◆ deleteDB()

ilStudyProgrammeAssignmentDBRepository::deleteDB ( int $id )

protected

Definition at line 375 of file class.ilStudyProgrammeAssignmentDBRepository.php.

    {
        $this->db->manipulate('DELETE FROM ' . self::TABLE . ' WHERE ' . self::FIELD_ID . ' = ' . $this->db->quote($id, 'integer'));
    }

Referenced by delete().

Here is the caller graph for this function:

◆ getDashboardInstancesforUser()

ilStudyProgrammeAssignmentDBRepository::getDashboardInstancesforUser ( int $usr_id )

Exceptions

ilException

Definition at line 268 of file class.ilStudyProgrammeAssignmentDBRepository.php.

    {
        global $DIC;
        $db = $DIC['ilDB'];
        $q = 'SELECT ' . self::FIELD_ID
            . ', ' . self::FIELD_USR_ID
            . ', ' . self::FIELD_ROOT_PRG_ID
            . ', ' . self::FIELD_LAST_CHANGE
            . ', ' . self::FIELD_LAST_CHANGE_BY
            . ', ' . self::FIELD_RESTART_DATE
            . ', ' . self::FIELD_RESTARTED_ASSIGNMENT_ID
            . ' FROM ' . self::TABLE
            . ' WHERE ' . self::FIELD_USR_ID . ' = ' . $usr_id
            . ' ORDER BY ' . self::FIELD_ROOT_PRG_ID . ', ' . self::FIELD_ID
        ;
        $ret = [];
        $assignments = [];
        $res = $db->query($q);
        $prg = 0;
        while ($row = $db->fetchAssoc($res)) {
            if ($prg == 0) {
                $prg = $row['root_prg_id'];
            }
            if ($prg != $row['root_prg_id']) {
                $ret[$prg] = $assignments;
                $prg = $row['root_prg_id'];
                $assignments = [];
            }
            $assignments[(int) $row['id']] = $this->assignmentByRow($row);
        }
        if (count($assignments) > 0) {
            $ret[$prg] = $assignments;
        }
        return $ret;
    }

References $db, $DIC, $res, $ret, assignmentByRow(), and FIELD_ID.

Here is the call graph for this function:

◆ getDueToRestartBaseSQL()

ilStudyProgrammeAssignmentDBRepository::getDueToRestartBaseSQL ( )

protected

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

                                                : string
    {
        return $this->getSQLHeader()
            . ' WHERE ' . self::FIELD_RESTARTED_ASSIGNMENT_ID
            . ' = ' . $this->db->quote(
                ilStudyProgrammeAssignment::NO_RESTARTED_ASSIGNMENT,
                'integer'
            ) . PHP_EOL
            . '    AND ' . self::FIELD_RESTART_DATE . ' IS NOT NULL' . PHP_EOL
            . '    AND DATE(' . self::FIELD_RESTART_DATE . ') <= '
            . $this->db->quote(
                (new DateTime())->format(
                    ilStudyProgrammeAssignment::DATE_FORMAT
                ),
                'text'
            );
    }

References ilStudyProgrammeAssignment\DATE_FORMAT, getSQLHeader(), and ilStudyProgrammeAssignment\NO_RESTARTED_ASSIGNMENT.

Referenced by loadDueToRestart(), and loadDueToRestartAndMail().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSQLHeader()

ilStudyProgrammeAssignmentDBRepository::getSQLHeader ( )

protected

Definition at line 151 of file class.ilStudyProgrammeAssignmentDBRepository.php.

                                      : string
    {
        return 'SELECT ' . self::FIELD_ID
            . ', ' . self::FIELD_USR_ID
            . ', ' . self::FIELD_ROOT_PRG_ID
            . ', ' . self::FIELD_LAST_CHANGE
            . ', ' . self::FIELD_LAST_CHANGE_BY
            . ', ' . self::FIELD_RESTART_DATE
            . ', ' . self::FIELD_RESTARTED_ASSIGNMENT_ID . PHP_EOL
            . ' FROM ' . self::TABLE . PHP_EOL;
    }

Referenced by getDueToRestartBaseSQL(), and loadDueToManuelRestart().

Here is the caller graph for this function:

◆ insertRowDB()

ilStudyProgrammeAssignmentDBRepository::insertRowDB ( array $row )

protected

Definition at line 345 of file class.ilStudyProgrammeAssignmentDBRepository.php.

    {
        $this->db->insert(
            self::TABLE,
            [
                self::FIELD_ID => ['interger', $row[self::FIELD_ID]]
                , self::FIELD_USR_ID => ['interger', $row[self::FIELD_USR_ID]]
                , self::FIELD_ROOT_PRG_ID => ['interger', $row[self::FIELD_ROOT_PRG_ID]]
                , self::FIELD_LAST_CHANGE => ['interger', $row[self::FIELD_LAST_CHANGE]]
                , self::FIELD_LAST_CHANGE_BY => ['interger', $row[self::FIELD_LAST_CHANGE_BY]]
                , self::FIELD_RESTART_DATE => ['timestamp', $row[self::FIELD_RESTART_DATE]]
                , self::FIELD_RESTARTED_ASSIGNMENT_ID => ['integer', $row[self::FIELD_RESTARTED_ASSIGNMENT_ID]]
            ]
        );
    }

Referenced by createFor().

Here is the caller graph for this function:

◆ loadByFilterDB()

ilStudyProgrammeAssignmentDBRepository::loadByFilterDB ( array $filter )

protected

Definition at line 325 of file class.ilStudyProgrammeAssignmentDBRepository.php.

    {
        $q = 'SELECT ' . self::FIELD_ID
            . ' ,' . self::FIELD_USR_ID
            . ' ,' . self::FIELD_ROOT_PRG_ID
            . ' ,' . self::FIELD_LAST_CHANGE
            . ' ,' . self::FIELD_LAST_CHANGE_BY
            . ' ,' . self::FIELD_RESTART_DATE
            . ' ,' . self::FIELD_RESTARTED_ASSIGNMENT_ID
            . ' FROM ' . self::TABLE
            . ' 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;
        }
    }

References $res.

Referenced by read(), readByPrgId(), readByUsrId(), and readByUsrIdAndPrgId().

Here is the caller graph for this function:

◆ loadDueToManuelRestart()

ilStudyProgrammeAssignmentDBRepository::loadDueToManuelRestart ( int $days_before_end )

protected

Exceptions

Exception

Definition at line 197 of file class.ilStudyProgrammeAssignmentDBRepository.php.

    {
        $date = new DateTime();
        $date->sub(new DateInterval('P' . $days_before_end . 'D'));
        $q = $this->getSQLHeader()
            . ' WHERE ' . self::FIELD_RESTARTED_ASSIGNMENT_ID
            . ' = ' . $this->db->quote(
                ilStudyProgrammeAssignment::NO_RESTARTED_ASSIGNMENT,
                'integer'
            ) . PHP_EOL
            . '    AND ' . self::FIELD_RESTART_DATE . ' IS NOT NULL' . PHP_EOL
            . '    AND DATE(' . self::FIELD_RESTART_DATE . ') <= '
            . $this->db->quote(
                $date->format(
                    ilStudyProgrammeAssignment::DATE_FORMAT
                ),
                'text'
            );
        $res = $this->db->query($q);
        while ($rec = $this->db->fetchAssoc($res)) {
            yield $rec;
        }
    }

References $res, ilStudyProgrammeAssignment\DATE_FORMAT, getSQLHeader(), and ilStudyProgrammeAssignment\NO_RESTARTED_ASSIGNMENT.

Referenced by readDueToManuelRestart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadDueToRestart()

ilStudyProgrammeAssignmentDBRepository::loadDueToRestart ( )

protected

Definition at line 131 of file class.ilStudyProgrammeAssignmentDBRepository.php.

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

References $res, and getDueToRestartBaseSQL().

Referenced by readDueToRestart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadDueToRestartAndMail()

ilStudyProgrammeAssignmentDBRepository::loadDueToRestartAndMail ( )

protected

Definition at line 140 of file class.ilStudyProgrammeAssignmentDBRepository.php.

    {
        $q = $this->getDueToRestartBaseSQL();
        $q .= '    AND ' . self::FIELD_RESTART_MAIL . ' IS NULL';
 
        $res = $this->db->query($q);
        while ($rec = $this->db->fetchAssoc($res)) {
            yield $rec;
        }
    }

References $res, and getDueToRestartBaseSQL().

Referenced by readDueToRestartAndMail().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nextId()

ilStudyProgrammeAssignmentDBRepository::nextId ( )

protected

Definition at line 380 of file class.ilStudyProgrammeAssignmentDBRepository.php.

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

Referenced by createFor().

Here is the caller graph for this function:

◆ read()

ilStudyProgrammeAssignmentDBRepository::read ( int $id )

Load settings belonging to a SP-Object.Will throw if the record does not exist yet.

Returns: ilStudyProgrammeAssignment | null

Exceptions

ilException

Implements ilStudyProgrammeAssignmentRepository.

Definition at line 59 of file class.ilStudyProgrammeAssignmentDBRepository.php.

    {
        foreach ($this->loadByFilterDB([self::FIELD_ID => $id]) as $row) {
            return $this->assignmentByRow($row);
        }
        return null;
    }

References assignmentByRow(), and loadByFilterDB().

Here is the call graph for this function:

◆ readByPrgId()

ilStudyProgrammeAssignmentDBRepository::readByPrgId ( int $prg_id )

Get all assignments to a prg.

Exceptions

ilException

Implements ilStudyProgrammeAssignmentRepository.

Definition at line 84 of file class.ilStudyProgrammeAssignmentDBRepository.php.

                                             : array
    {
        $return = [];
        foreach ($this->loadByFilterDB([self::FIELD_ROOT_PRG_ID => $prg_id]) as $row) {
            $return[] = $this->assignmentByRow($row);
        }
        return $return;
    }

References assignmentByRow(), and loadByFilterDB().

Here is the call graph for this function:

◆ readByUsrId()

ilStudyProgrammeAssignmentDBRepository::readByUsrId ( int $usr_id )

Get all assignments of a user.

Exceptions

ilException

Implements ilStudyProgrammeAssignmentRepository.

Definition at line 71 of file class.ilStudyProgrammeAssignmentDBRepository.php.

                                             : array
    {
        $return = [];
        foreach ($this->loadByFilterDB([self::FIELD_USR_ID => $usr_id]) as $row) {
            $return[] = $this->assignmentByRow($row);
        }
        return $return;
    }

References assignmentByRow(), and loadByFilterDB().

Here is the call graph for this function:

◆ readByUsrIdAndPrgId()

ilStudyProgrammeAssignmentDBRepository::readByUsrIdAndPrgId	(	int	$usr_id,
		int	$prg_id
	)

Exceptions

ilException

Definition at line 97 of file class.ilStudyProgrammeAssignmentDBRepository.php.

    {
        $return = [];
        foreach ($this->loadByFilterDB(
            [self::FIELD_USR_ID => $usr_id
                , self::FIELD_ROOT_PRG_ID => $prg_id]
        ) as $row) {
            $return[] = $this->assignmentByRow($row);
        }
        return $return;
    }

References assignmentByRow(), and loadByFilterDB().

Here is the call graph for this function:

◆ readDueToManuelRestart()

ilStudyProgrammeAssignmentDBRepository::readDueToManuelRestart ( int $days_before_end )

Get all assignments due to restart and not restrted yet.

Exceptions

Exception

Implements ilStudyProgrammeAssignmentRepository.

Definition at line 185 of file class.ilStudyProgrammeAssignmentDBRepository.php.

                                                                 : array
    {
        $return = [];
        foreach ($this->loadDueToManuelRestart($days_before_end) as $row) {
            $return[] = $this->assignmentByRow($row);
        }
        return $return;
    }

References assignmentByRow(), and loadDueToManuelRestart().

Here is the call graph for this function:

◆ readDueToRestart()

ilStudyProgrammeAssignmentDBRepository::readDueToRestart ( )

Get all assignments due to restart and not restrted yet.

Exceptions

ilException

Implements ilStudyProgrammeAssignmentRepository.

Definition at line 113 of file class.ilStudyProgrammeAssignmentDBRepository.php.

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

References assignmentByRow(), and loadDueToRestart().

Here is the call graph for this function:

◆ readDueToRestartAndMail()

ilStudyProgrammeAssignmentDBRepository::readDueToRestartAndMail ( )

Definition at line 122 of file class.ilStudyProgrammeAssignmentDBRepository.php.

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

References assignmentByRow(), and loadDueToRestartAndMail().

Here is the call graph for this function:

◆ reminderSendFor()

ilStudyProgrammeAssignmentDBRepository::reminderSendFor ( int $assignment_id )

Definition at line 246 of file class.ilStudyProgrammeAssignmentDBRepository.php.

                                                        : void
    {
        $where = [
            self::FIELD_ID => [
                'integer',
                $assignment_id
            ]
        ];
 
        $values = [
            self::FIELD_RESTART_MAIL => [
                'timestamp',
                date('Y-m-d H:i:s')
            ]
        ];
 
        $this->db->update(self::TABLE, $values, $where);
    }

◆ update()

ilStudyProgrammeAssignmentDBRepository::update ( ilStudyProgrammeAssignment $assignment )

Update settings belonging to a SP-Object.Will throw if the record does not exist yet.

Implements ilStudyProgrammeAssignmentRepository.

Definition at line 224 of file class.ilStudyProgrammeAssignmentDBRepository.php.

    {
        $row = [
            self::FIELD_ID => $assignment->getId(),
            self::FIELD_USR_ID => $assignment->getUserId(),
            self::FIELD_ROOT_PRG_ID => $assignment->getRootId(),
            self::FIELD_LAST_CHANGE_BY => $assignment->getLastChangeBy(),
            self::FIELD_LAST_CHANGE => $assignment->getLastChange()->format(ilStudyProgrammeAssignment::DATE_TIME_FORMAT),
            self::FIELD_RESTART_DATE => $assignment->getRestartDate() ? $assignment->getRestartDate()->format(ilStudyProgrammeAssignment::DATE_TIME_FORMAT) : null,
            self::FIELD_RESTARTED_ASSIGNMENT_ID => $assignment->getRestartedAssignmentId()
        ];
        $this->updatedRowDB($row);
    }

References ilStudyProgrammeAssignment\DATE_TIME_FORMAT, ilStudyProgrammeAssignment\getId(), ilStudyProgrammeAssignment\getLastChange(), ilStudyProgrammeAssignment\getLastChangeBy(), ilStudyProgrammeAssignment\getRestartDate(), ilStudyProgrammeAssignment\getRestartedAssignmentId(), ilStudyProgrammeAssignment\getRootId(), ilStudyProgrammeAssignment\getUserId(), and updatedRowDB().

Here is the call graph for this function:

◆ updatedRowDB()

ilStudyProgrammeAssignmentDBRepository::updatedRowDB ( array $values )

protected

Definition at line 361 of file class.ilStudyProgrammeAssignmentDBRepository.php.

    {
        $q = 'UPDATE ' . self::TABLE
            . ' SET'
            . ' ' . self::FIELD_USR_ID . ' = ' . $this->db->quote($values[self::FIELD_USR_ID], 'integer')
            . ' ,' . self::FIELD_ROOT_PRG_ID . ' = ' . $this->db->quote($values[self::FIELD_ROOT_PRG_ID], 'integer')
            . ' ,' . self::FIELD_LAST_CHANGE . ' = ' . $this->db->quote($values[self::FIELD_LAST_CHANGE], 'text')
            . ' ,' . self::FIELD_LAST_CHANGE_BY . ' = ' . $this->db->quote($values[self::FIELD_LAST_CHANGE_BY], 'integer')
            . ' ,' . self::FIELD_RESTART_DATE . ' = ' . $this->db->quote($values[self::FIELD_RESTART_DATE], 'timestamp')
            . ' ,' . self::FIELD_RESTARTED_ASSIGNMENT_ID . ' = ' . $this->db->quote($values[self::FIELD_RESTARTED_ASSIGNMENT_ID], 'integer')
            . ' WHERE ' . self::FIELD_ID . ' = ' . $this->db->quote($values[self::FIELD_ID], 'integer');
        $this->db->manipulate($q);
    }