ilStudyProgrammeSettingsDBRepository Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilStudyProgrammeSettingsDBRepository:

Collaboration diagram for ilStudyProgrammeSettingsDBRepository:

Public Member Functions
	__construct (ilDBInterface $db)
	createFor (int $obj_id)
	Create a record corresponding to a SP-Object and return representing settings.Will throw if a record allready exists. More...
	get (int $obj_id)
	Load settings belonging to a SP-Object.Will throw if the record does not exist yet. More...
	update (ilStudyProgrammeSettings $settings)
	Update settings belonging to a SP-Object.Will throw if the record does not exist yet. More...
	delete (ilStudyProgrammeSettings $settings)
	Delete record corresponding to settings.Will throw if the record does not exist yet. More...
	loadByType (int $type_id)
	Load SP settings by assigned type. Returns ilStudyProgrammeSettings[] More...
	loadIdsByType (int $type_id)
	Load SP setting-ids by assigned type. More...
	getProgrammeIdsWithRiskyToFailSettings ()
	Programme must be active and have a setting to send mails if the user is at risk to fail completing the progress due to a deadline. More...
	getProgrammeIdsWithMailsForExpiringValidity ()
	Programme must be active and have a setting to send mails for qualifications about to expire. More...
	getProgrammeIdsWithReassignmentForExpiringValidity ()
	Programme must be active and have a setting to reassign users when validity expires. More...
	createFor (int $obj_id)
	Create a record corresponding to a SP-Object and return representing settings. More...
	get (int $obj_id)
	Load settings belonging to a SP-Object. More...
	update (ilStudyProgrammeSettings $settings)
	Update settings belonging to a SP-Object. More...
	delete (ilStudyProgrammeSettings $settings)
	Delete record corresponding to settings. More...
	loadByType (int $type_id)
	Load SP settings by assigned type. More...
	loadIdsByType (int $type_id)
	Load SP setting-ids by assigned type. More...

Static Public Member Functions
static	clearCache ()

Protected Member Functions
	insertDB (int $obj_id, int $subtype_id, int $status, int $lp_mode, int $points, string $last_change, int $deadline_period, int $vq_period, int $vq_restart_period, string $deadline_date=null, string $vq_date=null, int $rm_nr_by_usr_days=null, int $proc_end_no_success=null, bool $send_re_assigned_mail=false, bool $send_info_to_re_assign_mail=false, bool $send_risky_to_fail_mail=false, bool $vq_restart_recheck=false)
	loadDB (int $obj_id)
	createByRow (array $row)
	deleteDB (int $obj_id)
	updateDB (int $obj_id, int $subtype_id, int $status, int $lp_mode, int $points, string $last_change, int $deadline_period, int $vq_period, int $vq_restart_period, string $deadline_date=null, string $vq_date=null, int $rm_nr_by_usr_days=null, int $proc_end_no_success=null, bool $send_re_assigned_mail=false, bool $send_info_to_re_assign_mail=false, bool $send_risky_to_fail_mail=false, bool $vq_restart_recheck=false)
	@pthrows LogicException More...
	checkExists (int $obj_id)

Protected Attributes
ilDBInterface	$db

Static Protected Attributes
static array	$cache = []

Private Attributes
const	TABLE = 'prg_settings'
const	FIELD_OBJ_ID = 'obj_id'
const	FIELD_SUBTYPE_ID = 'subtype_id'
const	FIELD_STATUS = 'status'
const	FIELD_LP_MODE = 'lp_mode'
const	FIELD_POINTS = 'points'
const	FIELD_LAST_CHANGED = 'last_change'
const	FIELD_DEADLINE_PERIOD = 'deadline_period'
const	FIELD_DEADLINE_DATE = 'deadline_date'
const	FIELD_VALIDITY_QUALIFICATION_DATE = 'vq_date'
const	FIELD_VALIDITY_QUALIFICATION_PERIOD = 'vq_period'
const	FIELD_VQ_RESTART_PERIOD = 'vq_restart_period'
const	FIELD_VQ_RESTART_RECHECK = 'vq_restart_recheck'
const	FIELD_RM_NOT_RESTARTED_BY_USER_DAY = 'rm_nr_by_usr_days'
const	FIELD_PROC_ENDS_NOT_SUCCESSFUL = 'proc_end_no_success'
const	FIELD_SEND_RE_ASSIGNED_MAIL = "send_re_assigned_mail"
const	FIELD_SEND_INFO_TO_RE_ASSIGN_MAIL = "send_info_to_re_assign_mail"
const	FIELD_SEND_RISKY_TO_FAIL_MAIL = "send_risky_to_fail_mail"

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

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

Constructor & Destructor Documentation

__construct()

ilStudyProgrammeSettingsDBRepository::__construct

(

ilDBInterface

$db

)

Definition at line 46 of file class.ilStudyProgrammeSettingsDBRepository.php.

    {
        $this->db = $db;
    }

References $db.

Member Function Documentation

checkExists()

ilStudyProgrammeSettingsDBRepository::checkExists ( int  $obj_id )

protected

Definition at line 518 of file class.ilStudyProgrammeSettingsDBRepository.php.

                                               : bool
    {
        $rec = $this->db->fetchAssoc(
            $this->db->query(
                'SELECT ' . self::FIELD_OBJ_ID
                . '     FROM ' . self::TABLE
                . '     WHERE ' . self::FIELD_OBJ_ID . ' = ' . $this->db->quote($obj_id, 'integer')
            )
        );
        if ($rec) {
            return true;
        }
        return false;
    }

Referenced by deleteDB(), and updateDB().

Here is the caller graph for this function:

clearCache()

static ilStudyProgrammeSettingsDBRepository::clearCache ( )

static

Definition at line 533 of file class.ilStudyProgrammeSettingsDBRepository.php.

                                       : void
    {
        self::$cache = [];
    }

Referenced by ilStudyProgrammeSettingsRepositoryTest\testPRGRepoEditAndUpdate().

Here is the caller graph for this function:

createByRow()

ilStudyProgrammeSettingsDBRepository::createByRow ( array  $row )

protected

Exceptions

ilException

Definition at line 298 of file class.ilStudyProgrammeSettingsDBRepository.php.

                                              : ilStudyProgrammeSettings
    {
        $type_settings = new ilStudyProgrammeTypeSettings(
            ilStudyProgrammeSettings::DEFAULT_SUBTYPE
        );
        $assessment_settings = new ilStudyProgrammeAssessmentSettings(
            ilStudyProgrammeSettings::DEFAULT_POINTS,
            ilStudyProgrammeSettings::STATUS_DRAFT
        );
        $deadline_settings = new ilStudyProgrammeDeadlineSettings(null, null);
        $validity_of_achieved_qualification_settings =
            new \ilStudyProgrammeValidityOfAchievedQualificationSettings(
                null,
                null,
                null,
                (bool) $row[self::FIELD_VQ_RESTART_RECHECK]
            );
        $automail = new \ilStudyProgrammeAutoMailSettings(false, null, null);
 
        $prg = new ilStudyProgrammeSettings(
            (int) $row[self::FIELD_OBJ_ID],
            $type_settings,
            $assessment_settings,
            $deadline_settings,
            $validity_of_achieved_qualification_settings,
            $automail
        );
 
        $return = $prg
            ->setLPMode((int) $row[self::FIELD_LP_MODE])
            ->setLastChange(DateTime::createFromFormat(
                ilStudyProgrammeSettings::DATE_TIME_FORMAT,
                $row[self::FIELD_LAST_CHANGED]
            ))
        ;
 
        $type = $return->getTypeSettings();
        $type = $type->withTypeId((int) $row['subtype_id']);
        $return = $return->withTypeSettings($type);
 
        $points = $return->getAssessmentSettings();
        $points = $points->withPoints((int) $row['points'])->withStatus((int) $row['status']);
        $return = $return->withAssessmentSettings($points);
 
        $deadline = $return->getDeadlineSettings();
        if ($row[self::FIELD_DEADLINE_DATE] !== null) {
            $deadline = $deadline->withDeadlineDate(DateTimeImmutable::createFromFormat(
                ilStudyProgrammeSettings::DATE_TIME_FORMAT,
                $row[self::FIELD_DEADLINE_DATE]
            ))
            ;
        } else {
            $deadline_period = (int) $row[self::FIELD_DEADLINE_PERIOD];
            if ($deadline_period === ilStudyProgrammeSettings::NO_DEADLINE) {
                $deadline_period = null;
            }
            $deadline = $deadline->withDeadlinePeriod($deadline_period);
        }
        $return = $return->withDeadlineSettings($deadline);
 
        $vqs = $return->getValidityOfQualificationSettings();
        if ($row[self::FIELD_VALIDITY_QUALIFICATION_DATE] !== null) {
            $vqs = $vqs->withQualificationDate(
                DateTimeImmutable::createFromFormat(
                    ilStudyProgrammeSettings::DATE_TIME_FORMAT,
                    $row[self::FIELD_VALIDITY_QUALIFICATION_DATE]
                )
            );
        } else {
            $qualification_period = (int) $row[self::FIELD_VALIDITY_QUALIFICATION_PERIOD];
            if ($qualification_period === ilStudyProgrammeSettings::NO_VALIDITY_OF_QUALIFICATION_PERIOD) {
                $qualification_period = null;
            }
            $vqs = $vqs->withQualificationPeriod($qualification_period);
        }
        $restart_period = (int) $row[self::FIELD_VQ_RESTART_PERIOD];
        if ($restart_period === ilStudyProgrammeSettings::NO_RESTART) {
            $restart_period = null;
        }
 
        $vqs = $vqs
            ->withRestartPeriod($restart_period)
            ->withRestartRecheck((bool) $row[self::FIELD_VQ_RESTART_RECHECK]);
 
        $return = $return->withValidityOfQualificationSettings($vqs);
 
        $rm_nr_by_usr_days = $row[self::FIELD_RM_NOT_RESTARTED_BY_USER_DAY];
        if (!is_null($rm_nr_by_usr_days)) {
            $rm_nr_by_usr_days = (int) $rm_nr_by_usr_days;
        }
        $proc_end_no_success = $row[self::FIELD_PROC_ENDS_NOT_SUCCESSFUL];
        if (!is_null($proc_end_no_success)) {
            $proc_end_no_success = (int) $proc_end_no_success;
        }
 
        return $return->withAutoMailSettings(
            new ilStudyProgrammeAutoMailSettings(
                (bool) $row[self::FIELD_SEND_RE_ASSIGNED_MAIL],
                $rm_nr_by_usr_days,
                $proc_end_no_success
            )
        );
    }

References $type, ilStudyProgrammeSettings\DATE_TIME_FORMAT, ilStudyProgrammeSettings\DEFAULT_POINTS, ilStudyProgrammeSettings\DEFAULT_SUBTYPE, FIELD_PROC_ENDS_NOT_SUCCESSFUL, FIELD_RM_NOT_RESTARTED_BY_USER_DAY, FIELD_SEND_RE_ASSIGNED_MAIL, FIELD_VQ_RESTART_RECHECK, ILIAS\Repository\int(), ilStudyProgrammeSettings\NO_DEADLINE, ilStudyProgrammeSettings\NO_RESTART, ilStudyProgrammeSettings\NO_VALIDITY_OF_QUALIFICATION_PERIOD, and ilStudyProgrammeSettings\STATUS_DRAFT.

Referenced by loadByType(), and loadDB().

Here is the call graph for this function:

Here is the caller graph for this function:

createFor()

ilStudyProgrammeSettingsDBRepository::createFor

(

int

$obj_id

)

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

Exceptions

ilException

Implements ilStudyProgrammeSettingsRepository.

Definition at line 55 of file class.ilStudyProgrammeSettingsDBRepository.php.

                                          : ilStudyProgrammeSettings
    {
        $type_settings = new ilStudyProgrammeTypeSettings(
            ilStudyProgrammeSettings::DEFAULT_SUBTYPE
        );
        $assessment_settings = new ilStudyProgrammeAssessmentSettings(
            ilStudyProgrammeSettings::DEFAULT_POINTS,
            ilStudyProgrammeSettings::STATUS_DRAFT
        );
        $deadline_settings = new ilStudyProgrammeDeadlineSettings(null, null);
        $validity_of_achieved_qualification_settings =
            new \ilStudyProgrammeValidityOfAchievedQualificationSettings(null, null, null, false)
        ;
        $automail = new ilStudyProgrammeAutoMailSettings(false, null, null);
 
        $prg = new ilStudyProgrammeSettings(
            $obj_id,
            $type_settings,
            $assessment_settings,
            $deadline_settings,
            $validity_of_achieved_qualification_settings,
            $automail
        );
 
        $this->insertDB(
            $obj_id,
            ilStudyProgrammeSettings::DEFAULT_SUBTYPE,
            ilStudyProgrammeSettings::STATUS_DRAFT,
            ilStudyProgrammeSettings::MODE_UNDEFINED,
            ilStudyProgrammeSettings::DEFAULT_POINTS,
            (new DateTime())->format(ilStudyProgrammeSettings::DATE_TIME_FORMAT),
            0,
            ilStudyProgrammeSettings::NO_VALIDITY_OF_QUALIFICATION_PERIOD,
            ilStudyProgrammeSettings::NO_RESTART,
            null,
            null,
            null,
            null
        );
 
        $prg = $prg->setLPMode(ilStudyProgrammeSettings::MODE_UNDEFINED);
        self::$cache[$obj_id] = $prg;
        return $prg;
    }

References ilStudyProgrammeSettings\DATE_TIME_FORMAT, ilStudyProgrammeSettings\DEFAULT_POINTS, ilStudyProgrammeSettings\DEFAULT_SUBTYPE, insertDB(), ilStudyProgrammeSettings\MODE_UNDEFINED, ilStudyProgrammeSettings\NO_RESTART, ilStudyProgrammeSettings\NO_VALIDITY_OF_QUALIFICATION_PERIOD, and ilStudyProgrammeSettings\STATUS_DRAFT.

Here is the call graph for this function:

delete()

ilStudyProgrammeSettingsDBRepository::delete

(

ilStudyProgrammeSettings

$settings

)

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

Implements ilStudyProgrammeSettingsRepository.

Definition at line 172 of file class.ilStudyProgrammeSettingsDBRepository.php.

                                                              : void
    {
        unset(self::$cache[$settings->getObjId()]);
        $this->deleteDB($settings->getObjId());
    }

References ILIAS\LTI\ToolProvider\$settings, and deleteDB().

Here is the call graph for this function:

deleteDB()

ilStudyProgrammeSettingsDBRepository::deleteDB ( int  $obj_id )

protected

Exceptions

LogicException

Definition at line 405 of file class.ilStudyProgrammeSettingsDBRepository.php.

                                            : void
    {
        if (!$this->checkExists($obj_id)) {
            throw new LogicException('invaid obj_id to delete: ' . $obj_id);
        }
        $this->db->manipulate(
            'DELETE FROM ' . self::TABLE
            . ' WHERE ' . self::FIELD_OBJ_ID . ' = ' . $this->db->quote($obj_id, 'integer')
        );
    }

References checkExists().

Referenced by delete().

Here is the call graph for this function:

Here is the caller graph for this function:

get()

ilStudyProgrammeSettingsDBRepository::get

(

int

$obj_id

)

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

Exceptions

ilException

Implements ilStudyProgrammeSettingsRepository.

Definition at line 104 of file class.ilStudyProgrammeSettingsDBRepository.php.

                                    : ilStudyProgrammeSettings
    {
        if (!array_key_exists($obj_id, self::$cache)) {
            $type = ilObject::_lookupType($obj_id);
            if ($type === 'prgr') {
                $prg_reference = new ilObjStudyProgrammeReference($obj_id, false);
                $obj_id = $prg_reference->getReferencedObject()->getId();
            }
            self::$cache[$obj_id] = $this->loadDB($obj_id);
        }
        return self::$cache[$obj_id];
    }

References $type, ilObject\_lookupType(), and loadDB().

Here is the call graph for this function:

getProgrammeIdsWithMailsForExpiringValidity()

ilStudyProgrammeSettingsDBRepository::getProgrammeIdsWithMailsForExpiringValidity

(

)

Programme must be active and have a setting to send mails for qualifications about to expire.

Returns

array <int id, int days_offset>

Definition at line 566 of file class.ilStudyProgrammeSettingsDBRepository.php.

                                                                 : array
    {
        $query = 'SELECT '
            . self::FIELD_OBJ_ID . ', '
            . self::FIELD_RM_NOT_RESTARTED_BY_USER_DAY
            . ' FROM ' . self::TABLE . PHP_EOL
            . ' WHERE ' . self::FIELD_STATUS . ' = ' . ilStudyProgrammeSettings::STATUS_ACTIVE
            . ' AND ' . self::FIELD_RM_NOT_RESTARTED_BY_USER_DAY . ' IS NOT NULL';
 
        $return = [];
        $res = $this->db->query($query);
        while ($rec = $this->db->fetchAssoc($res)) {
            $return[$rec[self::FIELD_OBJ_ID]] = $rec[self::FIELD_RM_NOT_RESTARTED_BY_USER_DAY];
        }
        return $return;
    }

References $query, $res, FIELD_OBJ_ID, FIELD_RM_NOT_RESTARTED_BY_USER_DAY, and ilStudyProgrammeSettings\STATUS_ACTIVE.

getProgrammeIdsWithReassignmentForExpiringValidity()

ilStudyProgrammeSettingsDBRepository::getProgrammeIdsWithReassignmentForExpiringValidity

(

)

Programme must be active and have a setting to reassign users when validity expires.

Returns

array <int id, int days_offset>

Definition at line 588 of file class.ilStudyProgrammeSettingsDBRepository.php.

                                                                        : array
    {
        $query = 'SELECT '
            . self::FIELD_OBJ_ID . ', '
            . self::FIELD_VQ_RESTART_PERIOD
            . ' FROM ' . self::TABLE . PHP_EOL
            . ' WHERE ' . self::FIELD_STATUS . ' = ' . ilStudyProgrammeSettings::STATUS_ACTIVE
            . ' AND ' . self::FIELD_VQ_RESTART_PERIOD . ' >= 0';
 
        $return = [];
        $res = $this->db->query($query);
        while ($rec = $this->db->fetchAssoc($res)) {
            $return[$rec[self::FIELD_OBJ_ID]] = $rec[self::FIELD_VQ_RESTART_PERIOD];
        }
        return $return;
    }

References $query, $res, FIELD_OBJ_ID, FIELD_VQ_RESTART_PERIOD, and ilStudyProgrammeSettings\STATUS_ACTIVE.

getProgrammeIdsWithRiskyToFailSettings()

ilStudyProgrammeSettingsDBRepository::getProgrammeIdsWithRiskyToFailSettings

(

)

Programme must be active and have a setting to send mails if the user is at risk to fail completing the progress due to a deadline.

Returns

array <int id, int days_offset>

Definition at line 544 of file class.ilStudyProgrammeSettingsDBRepository.php.

                                                            : array
    {
        $query = 'SELECT '
            . self::FIELD_OBJ_ID . ', '
            . self::FIELD_PROC_ENDS_NOT_SUCCESSFUL
            . ' FROM ' . self::TABLE . PHP_EOL
            . ' WHERE ' . self::FIELD_STATUS . ' = ' . ilStudyProgrammeSettings::STATUS_ACTIVE
            . ' AND ' . self::FIELD_PROC_ENDS_NOT_SUCCESSFUL . ' IS NOT NULL';
 
        $return = [];
        $res = $this->db->query($query);
        while ($rec = $this->db->fetchAssoc($res)) {
            $return[$rec[self::FIELD_OBJ_ID]] = $rec[self::FIELD_PROC_ENDS_NOT_SUCCESSFUL];
        }
        return $return;
    }

References $query, $res, FIELD_OBJ_ID, FIELD_PROC_ENDS_NOT_SUCCESSFUL, and ilStudyProgrammeSettings\STATUS_ACTIVE.

insertDB()

ilStudyProgrammeSettingsDBRepository::insertDB ( int  $obj_id, int  $subtype_id, int  $status, int  $lp_mode, int  $points, string  $last_change, int  $deadline_period, int  $vq_period, int  $vq_restart_period, string  $deadline_date = null, string  $vq_date = null, int  $rm_nr_by_usr_days = null, int  $proc_end_no_success = null, bool  $send_re_assigned_mail = false, bool  $send_info_to_re_assign_mail = false, bool  $send_risky_to_fail_mail = false, bool  $vq_restart_recheck = false  )

protected

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

      {
        $this->db->insert(
            self::TABLE,
            [
                self::FIELD_OBJ_ID => ['integer', $obj_id],
                self::FIELD_SUBTYPE_ID => ['integer', $subtype_id],
                self::FIELD_STATUS => ['integer', $status],
                self::FIELD_POINTS => ['integer', $points],
                self::FIELD_LP_MODE => ['integer', $lp_mode],
                self::FIELD_LAST_CHANGED => ['timestamp', $last_change],
                self::FIELD_DEADLINE_PERIOD => ['integer', $deadline_period],
                self::FIELD_DEADLINE_DATE => ['timestamp', $deadline_date],
                self::FIELD_VALIDITY_QUALIFICATION_DATE => ['timestamp', $vq_date],
                self::FIELD_VALIDITY_QUALIFICATION_PERIOD => ['integer', $vq_period],
                self::FIELD_VQ_RESTART_PERIOD => ['integer', $vq_restart_period],
                self::FIELD_RM_NOT_RESTARTED_BY_USER_DAY => ['integer', $rm_nr_by_usr_days],
                self::FIELD_PROC_ENDS_NOT_SUCCESSFUL => ['integer', $proc_end_no_success],
                self::FIELD_SEND_RE_ASSIGNED_MAIL => ['integer', $send_re_assigned_mail],
                self::FIELD_SEND_INFO_TO_RE_ASSIGN_MAIL => ['integer', $send_info_to_re_assign_mail],
                self::FIELD_SEND_RISKY_TO_FAIL_MAIL => ['integer', $send_risky_to_fail_mail],
                self::FIELD_VQ_RESTART_RECHECK => ['integer', $vq_restart_recheck]
            ]
        );
    }

Referenced by createFor().

Here is the caller graph for this function:

loadByType()

ilStudyProgrammeSettingsDBRepository::loadByType

(

int

$type_id

)

Load SP settings by assigned type.

Returns

ilStudyProgrammeSettings[]

Exceptions

ilException

Implements ilStudyProgrammeSettingsRepository.

Definition at line 182 of file class.ilStudyProgrammeSettingsDBRepository.php.

                                            : array
    {
        $q = 'SELECT ' . self::FIELD_SUBTYPE_ID
            . ' ,' . self::FIELD_STATUS
            . ' ,' . self::FIELD_POINTS
            . ' ,' . self::FIELD_LP_MODE
            . ' ,' . self::FIELD_LAST_CHANGED
            . ' ,' . self::FIELD_OBJ_ID
            . ' ,' . self::FIELD_DEADLINE_PERIOD
            . ' ,' . self::FIELD_DEADLINE_DATE
            . ' ,' . self::FIELD_VALIDITY_QUALIFICATION_PERIOD
            . ' ,' . self::FIELD_VALIDITY_QUALIFICATION_DATE
            . ' ,' . self::FIELD_VQ_RESTART_PERIOD
            . ', ' . self::FIELD_RM_NOT_RESTARTED_BY_USER_DAY
            . ', ' . self::FIELD_PROC_ENDS_NOT_SUCCESSFUL
            . ', ' . self::FIELD_SEND_RE_ASSIGNED_MAIL
            . ', ' . self::FIELD_SEND_INFO_TO_RE_ASSIGN_MAIL
            . ', ' . self::FIELD_SEND_RISKY_TO_FAIL_MAIL
            . ', ' . self::FIELD_VQ_RESTART_RECHECK
            . ' FROM ' . self::TABLE
            . ' WHERE ' . self::FIELD_SUBTYPE_ID . ' = ' . $this->db->quote($type_id, 'integer');
        $res = $this->db->query($q);
        $return = [];
        while ($rec = $this->db->fetchAssoc($res)) {
            $return[] = $this->createByRow($rec);
        }
        return $return;
    }

References $res, and createByRow().

Here is the call graph for this function:

loadDB()

ilStudyProgrammeSettingsDBRepository::loadDB ( int  $obj_id )

protected

Exceptions

ilException

@thorws LogicException

Definition at line 264 of file class.ilStudyProgrammeSettingsDBRepository.php.

                                          : ilStudyProgrammeSettings
    {
        $rec = $this->db->fetchAssoc(
            $this->db->query(
                'SELECT ' . self::FIELD_SUBTYPE_ID
                . ', ' . self::FIELD_STATUS
                . ', ' . self::FIELD_POINTS
                . ', ' . self::FIELD_LP_MODE
                . ', ' . self::FIELD_LAST_CHANGED
                . ', ' . self::FIELD_OBJ_ID
                . ', ' . self::FIELD_DEADLINE_PERIOD
                . ', ' . self::FIELD_DEADLINE_DATE
                . ', ' . self::FIELD_VALIDITY_QUALIFICATION_PERIOD
                . ', ' . self::FIELD_VALIDITY_QUALIFICATION_DATE
                . ', ' . self::FIELD_VQ_RESTART_PERIOD
                . ', ' . self::FIELD_RM_NOT_RESTARTED_BY_USER_DAY
                . ', ' . self::FIELD_PROC_ENDS_NOT_SUCCESSFUL
                . ', ' . self::FIELD_SEND_RE_ASSIGNED_MAIL
                . ', ' . self::FIELD_SEND_INFO_TO_RE_ASSIGN_MAIL
                . ', ' . self::FIELD_SEND_RISKY_TO_FAIL_MAIL
                . ', ' . self::FIELD_VQ_RESTART_RECHECK
                . '     FROM ' . self::TABLE
                . '     WHERE ' . self::FIELD_OBJ_ID . ' = ' . $this->db->quote($obj_id, 'integer')
            )
        );
        if (!$rec) {
            throw new LogicException('invalid obj_id to load: ' . $obj_id);
        }
        return $this->createByRow($rec);
    }

References createByRow().

Referenced by get().

Here is the call graph for this function:

Here is the caller graph for this function:

loadIdsByType()

ilStudyProgrammeSettingsDBRepository::loadIdsByType

(

int

$type_id

)

Load SP setting-ids by assigned type.

Implements ilStudyProgrammeSettingsRepository.

Definition at line 212 of file class.ilStudyProgrammeSettingsDBRepository.php.

                                               : array
    {
        return [];
    }

update()

ilStudyProgrammeSettingsDBRepository::update

(

ilStudyProgrammeSettings

$settings

)

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

Implements ilStudyProgrammeSettingsRepository.

Definition at line 120 of file class.ilStudyProgrammeSettingsDBRepository.php.

                                                              : void
    {
        $deadline_period = $settings->getDeadlineSettings()->getDeadlinePeriod();
        if (is_null($deadline_period)) {
            $deadline_period = 0;
        }
 
        $deadline_date = $settings->getDeadlineSettings()->getDeadlineDate();
        if (!is_null($deadline_date)) {
            $deadline_date = $deadline_date->format(ilStudyProgrammeSettings::DATE_TIME_FORMAT);
        }
 
        $vq_date = $settings->getValidityOfQualificationSettings()->getQualificationDate();
        if (!is_null($vq_date)) {
            $vq_date = $vq_date->format(ilStudyProgrammeSettings::DATE_TIME_FORMAT);
        }
 
        $qp = $settings->getValidityOfQualificationSettings()->getQualificationPeriod();
        if (is_null($qp)) {
            $qp = 0;
        }
 
        $rp = $settings->getValidityOfQualificationSettings()->getRestartPeriod();
        if (is_null($rp)) {
            $rp = 0;
        }
 
        $this->updateDB(
            $settings->getObjId(),
            $settings->getTypeSettings()->getTypeId(),
            $settings->getAssessmentSettings()->getStatus(),
            $settings->getLPMode(),
            $settings->getAssessmentSettings()->getPoints(),
            $settings->getLastChange()->format(ilStudyProgrammeSettings::DATE_TIME_FORMAT),
            $deadline_period,
            $qp,
            $rp,
            $deadline_date,
            $vq_date,
            $settings->getAutoMailSettings()->getReminderNotRestartedByUserDays(),
            $settings->getAutoMailSettings()->getProcessingEndsNotSuccessfulDays(),
            $settings->getAutoMailSettings()->getSendReAssignedMail(),
            false,
            false,
            $settings->getValidityOfQualificationSettings()->getRestartRecheck()
        );
        self::$cache[$settings->getObjId()] = $settings;
    }

References ILIAS\LTI\ToolProvider\$settings, ilStudyProgrammeSettings\DATE_TIME_FORMAT, ilStudyProgrammeSettings\getObjId(), and updateDB().

Here is the call graph for this function:

updateDB()

ilStudyProgrammeSettingsDBRepository::updateDB ( int  $obj_id, int  $subtype_id, int  $status, int  $lp_mode, int  $points, string  $last_change, int  $deadline_period, int  $vq_period, int  $vq_restart_period, string  $deadline_date = null, string  $vq_date = null, int  $rm_nr_by_usr_days = null, int  $proc_end_no_success = null, bool  $send_re_assigned_mail = false, bool  $send_info_to_re_assign_mail = false, bool  $send_risky_to_fail_mail = false, bool  $vq_restart_recheck = false  )

protected

@pthrows LogicException

Definition at line 419 of file class.ilStudyProgrammeSettingsDBRepository.php.

      {
        if (!$this->checkExists($obj_id)) {
            throw new LogicException('invalid obj_id to update: ' . $obj_id);
        }
        $where = [
            self::FIELD_OBJ_ID => [
                'integer',
                $obj_id
            ]
        ];
 
        $values = [
            self::FIELD_SUBTYPE_ID => [
                'integer',
                $subtype_id
            ],
            self::FIELD_STATUS => [
                'integer',
                $status
            ],
            self::FIELD_LP_MODE => [
                'integer',
                $lp_mode
            ],
            self::FIELD_POINTS => [
                'integer',
                $points
            ],
            self::FIELD_LAST_CHANGED => [
                'timestamp',
                $last_change
            ],
            self::FIELD_DEADLINE_PERIOD => [
                'integer',
                $deadline_period
            ],
            self::FIELD_DEADLINE_DATE => [
                'timestamp',
                $deadline_date
            ],
            self::FIELD_VALIDITY_QUALIFICATION_PERIOD => [
                'integer',
                $vq_period
            ],
            self::FIELD_VALIDITY_QUALIFICATION_DATE => [
                'timestamp',
                $vq_date
            ],
            self::FIELD_VQ_RESTART_PERIOD => [
                'integer',
                $vq_restart_period
            ],
            self::FIELD_RM_NOT_RESTARTED_BY_USER_DAY => [
                'integer',
                $rm_nr_by_usr_days
            ],
            self::FIELD_PROC_ENDS_NOT_SUCCESSFUL => [
                'integer',
                $proc_end_no_success
            ],
            self::FIELD_SEND_RE_ASSIGNED_MAIL => [
                'integer',
                $send_re_assigned_mail
            ],
            self::FIELD_SEND_INFO_TO_RE_ASSIGN_MAIL => [
                'integer',
                $send_info_to_re_assign_mail
            ],
            self::FIELD_SEND_RISKY_TO_FAIL_MAIL => [
                'integer',
                $send_risky_to_fail_mail
            ],
            self::FIELD_VQ_RESTART_RECHECK => [
                'integer',
                $vq_restart_recheck
            ]
        ];
 
        $this->db->update(self::TABLE, $values, $where);
    }

References checkExists().

Referenced by update().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$cache

array ilStudyProgrammeSettingsDBRepository::$cache = []

staticprotected

Definition at line 43 of file class.ilStudyProgrammeSettingsDBRepository.php.

$db

ilDBInterface ilStudyProgrammeSettingsDBRepository::$db

protected

Definition at line 44 of file class.ilStudyProgrammeSettingsDBRepository.php.

Referenced by __construct().

FIELD_DEADLINE_DATE

const ilStudyProgrammeSettingsDBRepository::FIELD_DEADLINE_DATE = 'deadline_date'

private

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

FIELD_DEADLINE_PERIOD

const ilStudyProgrammeSettingsDBRepository::FIELD_DEADLINE_PERIOD = 'deadline_period'

private

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

FIELD_LAST_CHANGED

const ilStudyProgrammeSettingsDBRepository::FIELD_LAST_CHANGED = 'last_change'

private

Definition at line 30 of file class.ilStudyProgrammeSettingsDBRepository.php.

FIELD_LP_MODE

const ilStudyProgrammeSettingsDBRepository::FIELD_LP_MODE = 'lp_mode'

private

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

FIELD_OBJ_ID

const ilStudyProgrammeSettingsDBRepository::FIELD_OBJ_ID = 'obj_id'

private

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

Referenced by getProgrammeIdsWithMailsForExpiringValidity(), getProgrammeIdsWithReassignmentForExpiringValidity(), and getProgrammeIdsWithRiskyToFailSettings().

FIELD_POINTS

const ilStudyProgrammeSettingsDBRepository::FIELD_POINTS = 'points'

private

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

FIELD_PROC_ENDS_NOT_SUCCESSFUL

const ilStudyProgrammeSettingsDBRepository::FIELD_PROC_ENDS_NOT_SUCCESSFUL = 'proc_end_no_success'

private

Definition at line 38 of file class.ilStudyProgrammeSettingsDBRepository.php.

Referenced by createByRow(), and getProgrammeIdsWithRiskyToFailSettings().

FIELD_RM_NOT_RESTARTED_BY_USER_DAY

const ilStudyProgrammeSettingsDBRepository::FIELD_RM_NOT_RESTARTED_BY_USER_DAY = 'rm_nr_by_usr_days'

private

Definition at line 37 of file class.ilStudyProgrammeSettingsDBRepository.php.

Referenced by createByRow(), and getProgrammeIdsWithMailsForExpiringValidity().

FIELD_SEND_INFO_TO_RE_ASSIGN_MAIL

const ilStudyProgrammeSettingsDBRepository::FIELD_SEND_INFO_TO_RE_ASSIGN_MAIL = "send_info_to_re_assign_mail"

private

Definition at line 40 of file class.ilStudyProgrammeSettingsDBRepository.php.

FIELD_SEND_RE_ASSIGNED_MAIL

const ilStudyProgrammeSettingsDBRepository::FIELD_SEND_RE_ASSIGNED_MAIL = "send_re_assigned_mail"

private

Definition at line 39 of file class.ilStudyProgrammeSettingsDBRepository.php.

Referenced by createByRow().

FIELD_SEND_RISKY_TO_FAIL_MAIL

const ilStudyProgrammeSettingsDBRepository::FIELD_SEND_RISKY_TO_FAIL_MAIL = "send_risky_to_fail_mail"

private

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

FIELD_STATUS

const ilStudyProgrammeSettingsDBRepository::FIELD_STATUS = 'status'

private

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

FIELD_SUBTYPE_ID

const ilStudyProgrammeSettingsDBRepository::FIELD_SUBTYPE_ID = 'subtype_id'

private

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

FIELD_VALIDITY_QUALIFICATION_DATE

const ilStudyProgrammeSettingsDBRepository::FIELD_VALIDITY_QUALIFICATION_DATE = 'vq_date'

private

Definition at line 33 of file class.ilStudyProgrammeSettingsDBRepository.php.

FIELD_VALIDITY_QUALIFICATION_PERIOD

const ilStudyProgrammeSettingsDBRepository::FIELD_VALIDITY_QUALIFICATION_PERIOD = 'vq_period'

private

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

FIELD_VQ_RESTART_PERIOD

const ilStudyProgrammeSettingsDBRepository::FIELD_VQ_RESTART_PERIOD = 'vq_restart_period'

private

Definition at line 35 of file class.ilStudyProgrammeSettingsDBRepository.php.

Referenced by getProgrammeIdsWithReassignmentForExpiringValidity().

FIELD_VQ_RESTART_RECHECK

const ilStudyProgrammeSettingsDBRepository::FIELD_VQ_RESTART_RECHECK = 'vq_restart_recheck'

private

Definition at line 36 of file class.ilStudyProgrammeSettingsDBRepository.php.

Referenced by createByRow().

TABLE

const ilStudyProgrammeSettingsDBRepository::TABLE = 'prg_settings'

private

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

---

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

• Modules/StudyProgramme/classes/model/Settings/class.ilStudyProgrammeSettingsDBRepository.php