Collaboration diagram for ilStudyProgrammeSettings:

Public Member Functions
	__construct (int $a_id, ilStudyProgrammeTypeSettings $type_settings, ilStudyProgrammeAssessmentSettings $assessment_settings, ilStudyProgrammeDeadlineSettings $deadline_settings, ilStudyProgrammeValidityOfAchievedQualificationSettings $validity_of_qualification_settings, ilStudyProgrammeAutoMailSettings $automail_settings)

	getObjId ()
	Get the id of the study program. More...

	withObjId (int $obj_id)

	getLastChange ()
	Get the timestamp of the last change on this program or a sub program. More...

	updateLastChange ()
	Update the last change timestamp to the current time. More...

	setLastChange (DateTime $a_timestamp)
	Set the last change timestamp to the given time. More...

	setLPMode (int $a_mode)
	Set the lp mode. More...

	getLPMode ()
	Get the lp mode. More...

	getTypeSettings ()

	withTypeSettings (ilStudyProgrammeTypeSettings $type_settings)

	getAssessmentSettings ()

	withAssessmentSettings (ilStudyProgrammeAssessmentSettings $assessment_settings)

	getDeadlineSettings ()

	withDeadlineSettings (ilStudyProgrammeDeadlineSettings $deadline_settings)

	getValidityOfQualificationSettings ()

	withValidityOfQualificationSettings (ilStudyProgrammeValidityOfAchievedQualificationSettings $validity_of_qualification_settings)

	validationExpires ()

	getAutoMailSettings ()

	withAutoMailSettings (ilStudyProgrammeAutoMailSettings $automail_settings)

Data Fields
const	MODE_UNDEFINED = 0

const	MODE_POINTS = 1

const	MODE_LP_COMPLETED = 2

const	STATUS_DRAFT = 10

const	STATUS_ACTIVE = 20

const	STATUS_OUTDATED = 30

const	NO_RESTART = -1

const	NO_VALIDITY_OF_QUALIFICATION_PERIOD = -1

const	NO_DEADLINE = -1

const	DEFAULT_POINTS = 100

const	DEFAULT_SUBTYPE = 0

const	DATE_TIME_FORMAT = 'Y-m-d H:i:s'

const	DATE_FORMAT = 'Y-m-d'

Static Public Attributes
static array	$MODES

Protected Attributes
int	$obj_id
	Id of this study program and the corresponding ILIAS-object as well. More...

string	$last_change
	Timestamp of the moment the last change was made on this object or any object in the subtree of the program. More...

int	$lp_mode
	Mode the calculation of the learning progress on this node is run in. More...

bool	$access_ctrl_positions
	Is the access control governed by positions? More...

ilStudyProgrammeTypeSettings	$type_settings

ilStudyProgrammeAssessmentSettings	$assessment_settings

ilStudyProgrammeDeadlineSettings	$deadline_settings

ilStudyProgrammeValidityOfAchievedQualificationSettings	$validity_of_qualification_settings

ilStudyProgrammeAutoMailSettings	$automail_settings

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeSettings::__construct	(	int	$a_id,
		ilStudyProgrammeTypeSettings	$type_settings,
		ilStudyProgrammeAssessmentSettings	$assessment_settings,
		ilStudyProgrammeDeadlineSettings	$deadline_settings,
		ilStudyProgrammeValidityOfAchievedQualificationSettings	$validity_of_qualification_settings,
		ilStudyProgrammeAutoMailSettings	$automail_settings
	)

Definition at line 94 of file class.ilStudyProgrammeSettings.php.

References $assessment_settings, $automail_settings, $deadline_settings, $type_settings, and $validity_of_qualification_settings.

       {
         $this->obj_id = $a_id;
         $this->type_settings = $type_settings;
         $this->assessment_settings = $assessment_settings;
         $this->deadline_settings = $deadline_settings;
         $this->validity_of_qualification_settings = $validity_of_qualification_settings;
         $this->automail_settings = $automail_settings;
     }

Member Function Documentation

◆ getAssessmentSettings()

ilStudyProgrammeSettings::getAssessmentSettings ( )

Definition at line 194 of file class.ilStudyProgrammeSettings.php.

References $assessment_settings.

Referenced by ilObjStudyProgrammeSettingsGUI\buildFormElements(), and ilStudyProgrammeSettingsDBRepository\update().

                                            : ilStudyProgrammeAssessmentSettings
     {
         return $this->assessment_settings;
     }

Here is the caller graph for this function:

◆ getAutoMailSettings()

ilStudyProgrammeSettings::getAutoMailSettings ( )

Definition at line 240 of file class.ilStudyProgrammeSettings.php.

References $automail_settings.

Referenced by ilObjStudyProgrammeSettingsGUI\buildFormElements(), and ilStudyProgrammeSettingsDBRepository\update().

                                          : ilStudyProgrammeAutoMailSettings
     {
         return $this->automail_settings;
     }

Here is the caller graph for this function:

◆ getDeadlineSettings()

ilStudyProgrammeSettings::getDeadlineSettings ( )

Definition at line 208 of file class.ilStudyProgrammeSettings.php.

References $deadline_settings.

Referenced by ilObjStudyProgrammeSettingsGUI\buildFormElements(), and ilStudyProgrammeSettingsDBRepository\update().

                                          : ilStudyProgrammeDeadlineSettings
     {
         return $this->deadline_settings;
     }

Here is the caller graph for this function:

◆ getLastChange()

ilStudyProgrammeSettings::getLastChange ( )

Get the timestamp of the last change on this program or a sub program.

Definition at line 128 of file class.ilStudyProgrammeSettings.php.

Referenced by ilStudyProgrammeSettingsDBRepository\update().

                                    : DateTime
     {
         return DateTime::createFromFormat(self::DATE_TIME_FORMAT, $this->last_change);
     }

Here is the caller graph for this function:

◆ getLPMode()

ilStudyProgrammeSettings::getLPMode ( )

Get the lp mode.

Returns: int one of self::$MODES

Definition at line 177 of file class.ilStudyProgrammeSettings.php.

References $lp_mode.

Referenced by ilStudyProgrammeSettingsDBRepository\update().

                                : int
     {
         return $this->lp_mode;
     }

Here is the caller graph for this function:

◆ getObjId()

ilStudyProgrammeSettings::getObjId ( )

Get the id of the study program.

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

References $obj_id.

Referenced by ilStudyProgrammeTypeDBRepository\getStudyProgrammeIdsByTypeId(), ilStudyProgrammeSettingsDBRepository\update(), and ilObjStudyProgramme\updateSettings().

                               : int
     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getTypeSettings()

ilStudyProgrammeSettings::getTypeSettings ( )

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

References $type_settings.

Referenced by ilObjStudyProgrammeSettingsGUI\buildFormElements(), and ilStudyProgrammeSettingsDBRepository\update().

                                      : ilStudyProgrammeTypeSettings
     {
         return $this->type_settings;
     }

Here is the caller graph for this function:

◆ getValidityOfQualificationSettings()

ilStudyProgrammeSettings::getValidityOfQualificationSettings ( )

Definition at line 221 of file class.ilStudyProgrammeSettings.php.

References $validity_of_qualification_settings.

Referenced by ilObjStudyProgrammeSettingsGUI\buildFormElements(), ilStudyProgrammeSettingsDBRepository\update(), and validationExpires().

                                                         : ilStudyProgrammeValidityOfAchievedQualificationSettings
     {
         return $this->validity_of_qualification_settings;
     }

Here is the caller graph for this function:

◆ setLastChange()

ilStudyProgrammeSettings::setLastChange ( DateTime $a_timestamp )

Set the last change timestamp to the given time.

Throws when given time is smaller than current timestamp since that is logically impossible.

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

Referenced by updateLastChange().

                                                         : ilStudyProgrammeSettings
     {
         $this->last_change = $a_timestamp->format(self::DATE_TIME_FORMAT);
         return $this;
     }

Here is the caller graph for this function:

◆ setLPMode()

ilStudyProgrammeSettings::setLPMode ( int $a_mode )

Set the lp mode.

Throws when program is not in draft status.

Parameters

integer $a_mode - one of self::$MODES

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

References updateLastChange().

                                           : ilStudyProgrammeSettings
     {
         if (!in_array($a_mode, self::$MODES)) {
             throw new ilException("ilStudyProgramme::setLPMode: No lp mode: "
                                  . "'$a_mode'");
         }
         $this->lp_mode = $a_mode;
         $this->updateLastChange();
         return $this;
     }

Here is the call graph for this function:

◆ updateLastChange()

ilStudyProgrammeSettings::updateLastChange ( )

Update the last change timestamp to the current time.

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

References setLastChange().

Referenced by setLPMode().

                                       : ilStudyProgrammeSettings
     {
         $this->setLastChange(new DateTime());
         return $this;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validationExpires()

ilStudyProgrammeSettings::validationExpires ( )

Definition at line 234 of file class.ilStudyProgrammeSettings.php.

References getValidityOfQualificationSettings().

                                        : bool
     {
         return !is_null($this->getValidityOfQualificationSettings()->getQualificationDate()) ||
                 $this->getValidityOfQualificationSettings()->getQualificationPeriod() !== self::NO_VALIDITY_OF_QUALIFICATION_PERIOD;
     }

Here is the call graph for this function:

◆ withAssessmentSettings()

ilStudyProgrammeSettings::withAssessmentSettings ( ilStudyProgrammeAssessmentSettings $assessment_settings )

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

References $assessment_settings.

      : ilStudyProgrammeSettings {
         $clone = clone $this;
         $clone->assessment_settings = $assessment_settings;
         $clone->updateLastChange();
         return $clone;
     }

◆ withAutoMailSettings()

ilStudyProgrammeSettings::withAutoMailSettings ( ilStudyProgrammeAutoMailSettings $automail_settings )

Definition at line 245 of file class.ilStudyProgrammeSettings.php.

References $automail_settings.

      : ilStudyProgrammeSettings {
         $clone = clone $this;
         $clone->automail_settings = $automail_settings;
         return $clone;
     }

◆ withDeadlineSettings()

ilStudyProgrammeSettings::withDeadlineSettings ( ilStudyProgrammeDeadlineSettings $deadline_settings )

Definition at line 213 of file class.ilStudyProgrammeSettings.php.

References $deadline_settings.

      : ilStudyProgrammeSettings {
         $clone = clone $this;
         $clone->deadline_settings = $deadline_settings;
         return $clone;
     }

◆ withObjId()

ilStudyProgrammeSettings::withObjId ( int $obj_id )

Definition at line 118 of file class.ilStudyProgrammeSettings.php.

References $obj_id.

                                           : self
     {
         $clone = clone $this;
         $clone->obj_id = $obj_id;
         return $clone;
     }

◆ withTypeSettings()

ilStudyProgrammeSettings::withTypeSettings ( ilStudyProgrammeTypeSettings $type_settings )

Definition at line 187 of file class.ilStudyProgrammeSettings.php.

References $type_settings.

                                                                                  : ilStudyProgrammeSettings
     {
         $clone = clone $this;
         $clone->type_settings = $type_settings;
         return $clone;
     }

◆ withValidityOfQualificationSettings()

ilStudyProgrammeSettings::withValidityOfQualificationSettings ( ilStudyProgrammeValidityOfAchievedQualificationSettings $validity_of_qualification_settings )

Definition at line 226 of file class.ilStudyProgrammeSettings.php.

References $validity_of_qualification_settings.

      : ilStudyProgrammeSettings {
         $clone = clone $this;
         $clone->validity_of_qualification_settings = $validity_of_qualification_settings;
         return $clone;
     }

Field Documentation

◆ $access_ctrl_positions

bool ilStudyProgrammeSettings::$access_ctrl_positions

protected

Is the access control governed by positions?

Definition at line 86 of file class.ilStudyProgrammeSettings.php.

◆ $assessment_settings

ilStudyProgrammeAssessmentSettings ilStudyProgrammeSettings::$assessment_settings

protected

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

Referenced by __construct(), getAssessmentSettings(), and withAssessmentSettings().

◆ $automail_settings

ilStudyProgrammeAutoMailSettings ilStudyProgrammeSettings::$automail_settings

protected

Definition at line 92 of file class.ilStudyProgrammeSettings.php.

Referenced by __construct(), getAutoMailSettings(), and withAutoMailSettings().

◆ $deadline_settings

ilStudyProgrammeDeadlineSettings ilStudyProgrammeSettings::$deadline_settings

protected

Definition at line 90 of file class.ilStudyProgrammeSettings.php.

Referenced by __construct(), getDeadlineSettings(), and withDeadlineSettings().

◆ $last_change

string ilStudyProgrammeSettings::$last_change

protected

Timestamp of the moment the last change was made on this object or any object in the subtree of the program.

Definition at line 76 of file class.ilStudyProgrammeSettings.php.

◆ $lp_mode

int ilStudyProgrammeSettings::$lp_mode

protected

Mode the calculation of the learning progress on this node is run in.

Definition at line 81 of file class.ilStudyProgrammeSettings.php.

Referenced by getLPMode().

◆ $MODES

array ilStudyProgrammeSettings::$MODES

static

Initial value:

= [
        self::MODE_UNDEFINED,
        self::MODE_POINTS,
        self::MODE_LP_COMPLETED
    ]

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

◆ $obj_id

int ilStudyProgrammeSettings::$obj_id

protected

Id of this study program and the corresponding ILIAS-object as well.

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

Referenced by getObjId(), and withObjId().

◆ $type_settings

ilStudyProgrammeTypeSettings ilStudyProgrammeSettings::$type_settings

protected

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

Referenced by __construct(), getTypeSettings(), and withTypeSettings().

◆ $validity_of_qualification_settings

ilStudyProgrammeValidityOfAchievedQualificationSettings ilStudyProgrammeSettings::$validity_of_qualification_settings

protected

Definition at line 91 of file class.ilStudyProgrammeSettings.php.

Referenced by __construct(), getValidityOfQualificationSettings(), and withValidityOfQualificationSettings().

◆ DATE_FORMAT

const ilStudyProgrammeSettings::DATE_FORMAT = 'Y-m-d'

Definition at line 65 of file class.ilStudyProgrammeSettings.php.

◆ DATE_TIME_FORMAT

const ilStudyProgrammeSettings::DATE_TIME_FORMAT = 'Y-m-d H:i:s'

Definition at line 64 of file class.ilStudyProgrammeSettings.php.

Referenced by ilStudyProgrammeSettingsDBRepository\createByRow(), ilStudyProgrammeSettingsDBRepository\createFor(), and ilStudyProgrammeSettingsDBRepository\update().

◆ DEFAULT_POINTS

const ilStudyProgrammeSettings::DEFAULT_POINTS = 100

Definition at line 61 of file class.ilStudyProgrammeSettings.php.

Referenced by ilStudyProgrammeSettingsDBRepository\createByRow(), ilStudyProgrammeSettingsDBRepository\createFor(), ilStudyProgrammeSettingsRepositoryTest\testPRGRepoCreate(), and ilStudyProgrammeSettingsRepositoryTest\testPRGRepoEditAndUpdate().

◆ DEFAULT_SUBTYPE

const ilStudyProgrammeSettings::DEFAULT_SUBTYPE = 0

Definition at line 62 of file class.ilStudyProgrammeSettings.php.

Referenced by ilStudyProgrammeSettingsDBRepository\createByRow(), ilStudyProgrammeSettingsDBRepository\createFor(), ilStudyProgrammeSettingsRepositoryTest\testPRGRepoCreate(), and ilStudyProgrammeSettingsRepositoryTest\testPRGRepoEditAndUpdate().

◆ MODE_LP_COMPLETED

const ilStudyProgrammeSettings::MODE_LP_COMPLETED = 2

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

Referenced by ilObjStudyProgramme\addNode(), ilObjStudyProgramme\adjustLPMode(), applyProgressDeadline(), ilObjStudyProgramme\canBeCompleted(), ilObjStudyProgramme\getCreatableSubObjects(), ilObjStudyProgramme\nodeInserted(), recalculateProgressStatus(), ilObjStudyProgramme\setProgressesCompletedIfParentIsProgrammeInLPCompletedMode(), ilStudyProgrammeSettingsTest\test_lp_mode(), and ilStudyProgrammeUserTable\toRow().

◆ MODE_POINTS

const ilStudyProgrammeSettings::MODE_POINTS = 1

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

Referenced by ilObjStudyProgramme\adjustLPMode(), ilObjStudyProgramme\getCreatableSubObjects(), ilObjStudyProgramme\nodeInserted(), recalculateProgressStatus(), ilStudyProgrammeAssignmentActionsTest\setUp(), ilStudyProgrammeSettingsTest\test_lp_mode(), ilStudyProgrammeSettingsRepositoryTest\testPRGRepoDelete(), and ilStudyProgrammeSettingsRepositoryTest\testPRGRepoEditAndUpdate().

◆ MODE_UNDEFINED

const ilStudyProgrammeSettings::MODE_UNDEFINED = 0

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

Referenced by ilObjStudyProgramme\adjustLPMode(), ilStudyProgrammeSettingsDBRepository\createFor(), ilObjStudyProgramme\getCreatableSubObjects(), recalculateProgressStatus(), ilStudyProgrammeSettingsTest\test_lp_mode(), ilStudyProgrammeSettingsRepositoryTest\testPRGRepoCreate(), and ilStudyProgrammeSettingsRepositoryTest\testPRGRepoEditAndUpdate().

◆ NO_DEADLINE

const ilStudyProgrammeSettings::NO_DEADLINE = -1

Definition at line 58 of file class.ilStudyProgrammeSettings.php.

Referenced by ilStudyProgrammeSettingsDBRepository\createByRow().

◆ NO_RESTART

const ilStudyProgrammeSettings::NO_RESTART = -1

Definition at line 56 of file class.ilStudyProgrammeSettings.php.

Referenced by ilStudyProgrammeSettingsDBRepository\createByRow(), ilStudyProgrammeSettingsDBRepository\createFor(), ilStudyProgrammeSettingsRepositoryTest\testPRGRepoCreate(), and ilStudyProgrammeSettingsRepositoryTest\testPRGRepoEditAndUpdate().

◆ NO_VALIDITY_OF_QUALIFICATION_PERIOD

const ilStudyProgrammeSettings::NO_VALIDITY_OF_QUALIFICATION_PERIOD = -1

Definition at line 57 of file class.ilStudyProgrammeSettings.php.

Referenced by ilStudyProgrammeSettingsDBRepository\createByRow(), ilStudyProgrammeSettingsDBRepository\createFor(), ilStudyProgrammeSettingsTest\test_validity_qualification_period(), ilStudyProgrammeSettingsRepositoryTest\testPRGRepoCreate(), and ilStudyProgrammeSettingsRepositoryTest\testPRGRepoEditAndUpdate().

◆ STATUS_ACTIVE

const ilStudyProgrammeSettings::STATUS_ACTIVE = 20

Definition at line 50 of file class.ilStudyProgrammeSettings.php.

Referenced by ilObjStudyProgramme\assignUser(), ilStudyProgrammeSettingsDBRepository\getProgrammeIdsWithMailsForExpiringValidity(), ilStudyProgrammeSettingsDBRepository\getProgrammeIdsWithReassignmentForExpiringValidity(), ilStudyProgrammeSettingsDBRepository\getProgrammeIdsWithRiskyToFailSettings(), ilStudyProgrammeAssessmentSettings\getStatusOptions(), ilObjStudyProgramme\isActive(), ilObjStudyProgramme\isAutoContentApplicable(), ilStudyProgrammeSettingsTest\test_status(), ilStudyProgrammeSettingsRepositoryTest\testPRGRepoDelete(), ilStudyProgrammeSettingsRepositoryTest\testPRGRepoEditAndUpdate(), and updateProgressRelevanceFromSettings().

◆ STATUS_DRAFT

const ilStudyProgrammeSettings::STATUS_DRAFT = 10

Definition at line 47 of file class.ilStudyProgrammeSettings.php.

Referenced by ilObjStudyProgramme\cloneObject(), ilStudyProgrammeSettingsDBRepository\createByRow(), ilStudyProgrammeSettingsDBRepository\createFor(), ilStudyProgrammeIndividualPlanTableGUI\fillRow(), ilStudyProgrammeAssessmentSettings\getStatusOptions(), ilObjStudyProgramme\isAutoContentApplicable(), ilStudyProgrammeSettingsTest\test_status(), ilStudyProgrammeSettingsRepositoryTest\testPRGRepoCreate(), and ilStudyProgrammeSettingsRepositoryTest\testPRGRepoEditAndUpdate().

◆ STATUS_OUTDATED

const ilStudyProgrammeSettings::STATUS_OUTDATED = 30

Definition at line 54 of file class.ilStudyProgrammeSettings.php.

Referenced by ilStudyProgrammeIndividualPlanTableGUI\fillRow(), ilStudyProgrammeAssessmentSettings\getStatusOptions(), ilStudyProgrammeIndividualPlanProgressListGUI\getTitleForItem(), and ilStudyProgrammeSettingsTest\test_status().

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

Modules/StudyProgramme/classes/model/Settings/class.ilStudyProgrammeSettings.php

Public Member Functions

Data Fields

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAssessmentSettings()

◆ getAutoMailSettings()

◆ getDeadlineSettings()

◆ getLastChange()

◆ getLPMode()

◆ getObjId()

◆ getTypeSettings()

◆ getValidityOfQualificationSettings()

◆ setLastChange()

◆ setLPMode()

◆ updateLastChange()

◆ validationExpires()

◆ withAssessmentSettings()

◆ withAutoMailSettings()

◆ withDeadlineSettings()

◆ withObjId()

◆ withTypeSettings()

◆ withValidityOfQualificationSettings()

Field Documentation

◆ $access_ctrl_positions

◆ $assessment_settings

◆ $automail_settings

◆ $deadline_settings

◆ $last_change

◆ $lp_mode

◆ $MODES

◆ $obj_id

◆ $type_settings

◆ $validity_of_qualification_settings

◆ DATE_FORMAT

◆ DATE_TIME_FORMAT

◆ DEFAULT_POINTS

◆ DEFAULT_SUBTYPE

◆ MODE_LP_COMPLETED

◆ MODE_POINTS

◆ MODE_UNDEFINED

◆ NO_DEADLINE

◆ NO_RESTART

◆ NO_VALIDITY_OF_QUALIFICATION_PERIOD

◆ STATUS_ACTIVE

◆ STATUS_DRAFT

◆ STATUS_OUTDATED