ilStudyProgrammeSettings Class Reference

Class ilStudyProgramme. More...

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...
	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	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	$MODES

Protected Attributes
	$obj_id
	$last_change
	$lp_mode
	$type_settings
	$assessment_settings
	$deadline_settings
	$validity_of_qualification_settings
	$access_ctrl_positions
	$automail_settings

Detailed Description

Class ilStudyProgramme.

Author

: Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

: Denis Klöpfer richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

Version

: 0.1.0

Definition at line 16 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 116 of file class.ilStudyProgrammeSettings.php.

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

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

Member Function Documentation

getAssessmentSettings()

ilStudyProgrammeSettings::getAssessmentSettings

(

)

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

                                            : \ilStudyProgrammeAssessmentSettings
    {
        return $this->assessment_settings;
    }

Referenced by ilStudyProgrammeSettingsDBRepository\update().

Here is the caller graph for this function:

getAutoMailSettings()

ilStudyProgrammeSettings::getAutoMailSettings

(

)

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

                                          : \ilStudyProgrammeAutoMailSettings
    {
        return $this->automail_settings;
    }

Referenced by ilStudyProgrammeSettingsDBRepository\update().

Here is the caller graph for this function:

getDeadlineSettings()

ilStudyProgrammeSettings::getDeadlineSettings

(

)

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

                                          : \ilStudyProgrammeDeadlineSettings
    {
        return $this->deadline_settings;
    }

Referenced by ilStudyProgrammeSettingsDBRepository\update().

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.

Returns

DateTime

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

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

Referenced by ilStudyProgrammeSettingsDBRepository\update().

Here is the caller graph for this function:

getLPMode()

ilStudyProgrammeSettings::getLPMode

(

)

Get the lp mode.

Returns

integer - one of self::$MODES

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

                                : int
    {
        return (int) $this->lp_mode;
    }

References $lp_mode.

Referenced by ilStudyProgrammeSettingsDBRepository\update().

Here is the caller graph for this function:

getObjId()

ilStudyProgrammeSettings::getObjId

(

)

Get the id of the study program.

Returns

integer

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

                               : int
    {
        return (int) $this->obj_id;
    }

References $obj_id.

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

Here is the caller graph for this function:

getTypeSettings()

ilStudyProgrammeSettings::getTypeSettings

(

)

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

                                      : \ilStudyProgrammeTypeSettings
    {
        return $this->type_settings;
    }

References $type_settings.

Referenced by ilStudyProgrammeSettingsDBRepository\update().

Here is the caller graph for this function:

getValidityOfQualificationSettings()

ilStudyProgrammeSettings::getValidityOfQualificationSettings

(

)

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

                                                         : \ilStudyProgrammeValidityOfAchievedQualificationSettings
    {
        return $this->validity_of_qualification_settings;
    }

Referenced by ilStudyProgrammeSettingsDBRepository\update().

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 then current timestamp since that is logically impossible.

Returns

$this

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

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

Referenced by updateLastChange().

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

Returns

$this

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

                                           : ilStudyProgrammeSettings
    {
        $a_mode = (int) $a_mode;
        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;
    }

References updateLastChange().

Here is the call graph for this function:

updateLastChange()

ilStudyProgrammeSettings::updateLastChange

(

)

Update the last change timestamp to the current time.

Returns

$this

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

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

References setLastChange().

Referenced by setLPMode().

Here is the call graph for this function:

Here is the caller graph for this function:

validationExpires()

ilStudyProgrammeSettings::validationExpires

(

)

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

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

withAssessmentSettings()

ilStudyProgrammeSettings::withAssessmentSettings

(

\ilStudyProgrammeAssessmentSettings

$assessment_settings

)

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

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

withAutoMailSettings()

ilStudyProgrammeSettings::withAutoMailSettings

(

\ilStudyProgrammeAutoMailSettings

$automail_settings

)

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

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

withDeadlineSettings()

ilStudyProgrammeSettings::withDeadlineSettings

(

\ilStudyProgrammeDeadlineSettings

$deadline_settings

)

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

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

withTypeSettings()

ilStudyProgrammeSettings::withTypeSettings

(

\ilStudyProgrammeTypeSettings

$type_settings

)

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

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

withValidityOfQualificationSettings()

ilStudyProgrammeSettings::withValidityOfQualificationSettings

(

\ilStudyProgrammeValidityOfAchievedQualificationSettings

$validity_of_qualification_settings

)

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

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

Field Documentation

$access_ctrl_positions

ilStudyProgrammeSettings::$access_ctrl_positions

protected

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

$assessment_settings

ilStudyProgrammeSettings::$assessment_settings

protected

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

Referenced by __construct().

$automail_settings

ilStudyProgrammeSettings::$automail_settings

protected

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

Referenced by __construct().

$deadline_settings

ilStudyProgrammeSettings::$deadline_settings

protected

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

Referenced by __construct().

$last_change

ilStudyProgrammeSettings::$last_change

protected

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

$lp_mode

ilStudyProgrammeSettings::$lp_mode

protected

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

Referenced by getLPMode().

$MODES

ilStudyProgrammeSettings::$MODES

static

Initial value:

= array(
        self::MODE_UNDEFINED,
        self::MODE_POINTS,
        self::MODE_LP_COMPLETED
    )

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

$obj_id

ilStudyProgrammeSettings::$obj_id

protected

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

Referenced by getObjId().

$type_settings

ilStudyProgrammeSettings::$type_settings

protected

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

Referenced by __construct(), and getTypeSettings().

$validity_of_qualification_settings

ilStudyProgrammeSettings::$validity_of_qualification_settings

protected

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

Referenced by __construct().

DATE_FORMAT

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

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

DATE_TIME_FORMAT

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

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

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

DEFAULT_POINTS

const ilStudyProgrammeSettings::DEFAULT_POINTS = 100

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

Referenced by ilStudyProgrammeSettingsDBRepository\createByRow(), ilStudyProgrammeSettingsDBRepository\createFor(), ilStudyProgrammeSettingsRepositoryTest\test_create(), ilStudyProgrammeSettingsRepositoryTest\test_edit_and_update(), ilObjStudyProgrammeTest\testApplyToSubTreeNodes(), ilStudyProgrammeUserProgressTest\testCanBeCompleted2(), ilStudyProgrammeUserProgressTest\testCanBeCompleted3(), ilStudyProgrammeUserProgressTest\testCompletionOnDeeplyNestedProgresses(), ilStudyProgrammeUserProgressTest\testExplicitPointUpdate1(), ilStudyProgrammeUserProgressTest\testExplicitPointUpdate2(), ilStudyProgrammeUserProgressTest\testIndividualRequiredPoints(), ilStudyProgrammeUserProgressTest\testMarkAccredited(), ilStudyProgrammeUserProgressTest\testMaximimPossibleAmountOfPoints1(), ilStudyProgrammeUserProgressTest\testMaximimPossibleAmountOfPoints2(), ilStudyProgrammeUserProgressTest\testNoImplicitPointUpdate(), and ilStudyProgrammeUserProgressTest\testNoUpdateOnModifiedNodes().

DEFAULT_SUBTYPE

const ilStudyProgrammeSettings::DEFAULT_SUBTYPE = 0

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

Referenced by ilStudyProgrammeSettingsDBRepository\createByRow(), ilStudyProgrammeSettingsDBRepository\createFor(), ilStudyProgrammeSettingsRepositoryTest\test_create(), and ilStudyProgrammeSettingsRepositoryTest\test_edit_and_update().

MODE_LP_COMPLETED

const ilStudyProgrammeSettings::MODE_LP_COMPLETED = 2

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

Referenced by ilObjStudyProgramme\addLeaf(), ilObjStudyProgramme\addNode(), ilObjStudyProgramme\adjustLPMode(), ilObjStudyProgramme\canBeCompleted(), ilObjStudyProgramme\getCreatableSubObjects(), ilObjStudyProgramme\nodeInserted(), ilObjStudyProgramme\recalculateProgressStatus(), ilStudyProgrammeSettingsTest\test_lp_mode(), ilObjStudyProgrammeTest\testAddLeaf(), ilStudyProgrammeProgressCalculationsTest\testMarkAccreditedOnLPNode(), and ilStudyProgrammeProgressCalculationsTest\testSuccessionCompletingParents().

MODE_POINTS

const ilStudyProgrammeSettings::MODE_POINTS = 1

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

Referenced by ilObjStudyProgramme\adjustLPMode(), ilStudyProgrammeProgressCalculationsTest\buildProgramme(), ilObjStudyProgramme\getCreatableSubObjects(), ilObjStudyProgramme\nodeInserted(), ilObjStudyProgramme\recalculateProgressStatus(), ilStudyProgrammeSettingsRepositoryTest\test_delete(), ilStudyProgrammeSettingsRepositoryTest\test_edit_and_update(), ilStudyProgrammeSettingsTest\test_lp_mode(), and ilObjStudyProgrammeTest\testAddNode().

MODE_UNDEFINED

const ilStudyProgrammeSettings::MODE_UNDEFINED = 0

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

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

NO_RESTART

const ilStudyProgrammeSettings::NO_RESTART = -1

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

Referenced by ilStudyProgrammeSettingsDBRepository\createFor(), ilStudyProgrammeSettingsRepositoryTest\test_create(), and ilStudyProgrammeSettingsRepositoryTest\test_edit_and_update().

NO_VALIDITY_OF_QUALIFICATION_PERIOD

const ilStudyProgrammeSettings::NO_VALIDITY_OF_QUALIFICATION_PERIOD = -1

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

Referenced by ilStudyProgrammeSettingsDBRepository\createFor(), ilStudyProgrammeSettingsRepositoryTest\test_create(), ilStudyProgrammeSettingsRepositoryTest\test_edit_and_update(), and ilStudyProgrammeSettingsTest\test_validity_qualification_period().

STATUS_ACTIVE

const ilStudyProgrammeSettings::STATUS_ACTIVE = 20

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

Referenced by ilObjStudyProgramme\assignUser(), ilStudyProgrammeSettingsDBRepository\getProgrammeIdsWithMailsForExpiringValidity(), ilStudyProgrammeSettingsDBRepository\getProgrammeIdsWithReassignmentForExpiringValidity(), ilStudyProgrammeSettingsDBRepository\getProgrammeIdsWithRiskyToFailSettings(), ilStudyProgrammeAssessmentSettings\getStatusOptions(), ilObjStudyProgramme\isActive(), ilObjStudyProgramme\isAutoContentApplicable(), ilStudyProgrammeLPTest\setAllNodesActive(), ilStudyProgrammeUserProgressTest\setAllNodesActive(), ilStudyProgrammeEventsTest\setUp(), ilStudyProgrammeProgressCalculationTest\setUp(), ilStudyProgrammeProgressCalculationTest\setUpNodes(), ilStudyProgrammeSettingsRepositoryTest\test_delete(), ilStudyProgrammeSettingsRepositoryTest\test_edit_and_update(), ilStudyProgrammeUserProgressTest\test_limited_validity_accredited(), ilStudyProgrammeUserProgressTest\test_limited_validity_date(), ilStudyProgrammeUserProgressTest\test_limited_validity_period(), ilPrgInvalidateExpiredProgressesCronJobTest\test_run(), ilPrgRestartAssignmentsCronJobTest\test_run(), ilStudyProgrammeUserProgressTest\test_set_failed_limited_validity_future(), ilStudyProgrammeUserProgressTest\test_set_failed_limited_validity_past(), ilStudyProgrammeUserProgressTest\test_set_failed_no_limited_validity(), ilStudyProgrammeSettingsTest\test_status(), ilStudyProgrammeUserProgressTest\testCanBeCompleted3(), ilObjStudyProgrammeTest\testCanRemoveNodeWithNotRelevantProgress(), ilObjStudyProgrammeTest\testCantRemoveNodeWithRelevantProgress(), ilStudyProgrammeUserProgressTest\testCompletionOnDeeplyNestedProgresses(), ilStudyProgrammeUserAssignmentTest\testDeassignRemovesEntriesInPrgUsrAssignment(), ilStudyProgrammeUserAssignmentTest\testDeleteOfProgrammeRemovesEntriesInPrgUsrAssignment(), ilStudyProgrammeUserAssignmentTest\testGetAmountOfAssignments(), ilStudyProgrammeUserAssignmentTest\testGetAssignments(), ilStudyProgrammeUserAssignmentTest\testGetAssignmentsOf(), ilStudyProgrammeUserAssignmentTest\testHasAssignmentOf(), ilStudyProgrammeLPTest\testInitialLPDraft(), ilStudyProgrammeUserProgressTest\testInitialProgressDraft(), ilStudyProgrammeLPTest\testInitialProgressOutdated(), ilStudyProgrammeUserProgressTest\testInitialProgressOutdated(), ilStudyProgrammeUserAssignmentTest\testNoRestartDate(), ilStudyProgrammeUserAssignmentTest\testRemoveAssignment1(), ilStudyProgrammeUserAssignmentTest\testRemoveAssignment2(), ilStudyProgrammeUserAssignmentTest\testRemoveOnRootNodeOnly1(), ilStudyProgrammeUserAssignmentTest\testRemoveOnRootNodeOnly2(), ilStudyProgrammeUserAssignmentTest\testRestartDate(), ilStudyProgrammeUserAssignmentTest\testRstartAssignment(), ilObjStudyProgrammeTest\testSettings(), and ilStudyProgrammeUserAssignmentTest\testUserId().

STATUS_DRAFT

const ilStudyProgrammeSettings::STATUS_DRAFT = 10

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

Referenced by ilStudyProgrammeSettingsDBRepository\createByRow(), ilStudyProgrammeSettingsDBRepository\createFor(), ilStudyProgrammeIndividualPlanTableGUI\fillRow(), ilStudyProgrammeAssessmentSettings\getStatusOptions(), ilObjStudyProgramme\isAutoContentApplicable(), ilStudyProgrammeSettingsRepositoryTest\test_create(), ilStudyProgrammeSettingsRepositoryTest\test_edit_and_update(), ilStudyProgrammeSettingsTest\test_status(), ilObjStudyProgrammeTest\testDefaults(), ilStudyProgrammeLPTest\testInitialLPDraft(), ilStudyProgrammeUserProgressTest\testInitialProgressDraft(), and ilStudyProgrammeUserAssignmentTest\testNoAssignmentWhenDraft().

STATUS_OUTDATED

const ilStudyProgrammeSettings::STATUS_OUTDATED = 30

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

Referenced by ilStudyProgrammeIndividualPlanTableGUI\fillRow(), ilStudyProgrammeAssessmentSettings\getStatusOptions(), ilStudyProgrammeIndividualPlanProgressListGUI\getTitleForItem(), ilStudyProgrammeSettingsTest\test_status(), ilObjStudyProgrammeTest\testCanRemoveNodeWithNotRelevantProgress(), ilStudyProgrammeLPTest\testInitialProgressOutdated(), ilStudyProgrammeUserProgressTest\testInitialProgressOutdated(), ilStudyProgrammeUserAssignmentTest\testNoAssignmentWhenOutdated(), and ilStudyProgrammeUserProgressTest\testOutdatedNodesCantBeSetToRelevant().

---

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

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