ilStudyProgrammeValidityOfAchievedQualificationSettings Class Reference

Collaboration diagram for ilStudyProgrammeValidityOfAchievedQualificationSettings:

Public Member Functions
	__construct (?int $qualification_period, ?DateTime $qualification_date, ?int $restart_period)
	getQualificationPeriod ()
	withQualificationPeriod (?int $qualification_period)
	getQualificationDate ()
	withQualificationDate (?DateTime $qualification_date)
	getRestartPeriod ()
	withRestartPeriod (?int $restart_period)
	toFormInput (Field\Factory $input, \ilLanguage $lng, Refinery $refinery, Factory $data_factory)

Protected Attributes
	$qualification_period
	$qualification_date
	$restart_period

Detailed Description

Definition at line 11 of file class.ilStudyProgrammeValidityOfAchievedQualificationSettings.php.

Constructor & Destructor Documentation

__construct()

ilStudyProgrammeValidityOfAchievedQualificationSettings::__construct	(	?int	$qualification_period,
		?DateTime	$qualification_date,
		?int	$restart_period
	)

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

      {
        if (!is_null($qualification_period) && 0 > $qualification_period) {
            throw new InvalidArgumentException(
                'Numbers less than 0 are not allowed for qualification_period'
            );
        }
 
        if (!is_null($restart_period) && 0 > $restart_period) {
            throw new InvalidArgumentException(
                'Numbers less than 0 are not allowed for restart_period'
            );
        }
 
        $this->qualification_period = $qualification_period;
        $this->qualification_date = $qualification_date;
        $this->restart_period = $restart_period;
    }

References $qualification_date, $qualification_period, and $restart_period.

Member Function Documentation

getQualificationDate()

ilStudyProgrammeValidityOfAchievedQualificationSettings::getQualificationDate

(

)

Definition at line 69 of file class.ilStudyProgrammeValidityOfAchievedQualificationSettings.php.

                                           : ?DateTime
    {
        return $this->qualification_date;
    }

getQualificationPeriod()

ilStudyProgrammeValidityOfAchievedQualificationSettings::getQualificationPeriod

(

)

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

                                             : ?int
    {
        return $this->qualification_period;
    }

References $qualification_period.

getRestartPeriod()

ilStudyProgrammeValidityOfAchievedQualificationSettings::getRestartPeriod

(

)

Definition at line 83 of file class.ilStudyProgrammeValidityOfAchievedQualificationSettings.php.

                                       : ?int
    {
        return $this->restart_period;
    }

toFormInput()

ilStudyProgrammeValidityOfAchievedQualificationSettings::toFormInput	(	Field\Factory	$input,
		\ilLanguage	$lng,
		Refinery	$refinery,
		Factory	$data_factory
	)

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

      : Field\Input {
        $format = $data_factory->dateFormat()->germanShort();
        $grp1 = $input->group([], $lng->txt('prg_no_validity_qualification'));
        $grp2 = $input->group(
            [
                'vq_period' => $input->numeric(
                    '',
                    $lng->txt('validity_qualification_period_desc')
                )
                ->withAdditionalTransformation($refinery->int()->isGreaterThan(0))
                ->withValue($this->getQualificationPeriod() !== null ? $this->getQualificationPeriod() : null)
            ],
            $lng->txt('validity_qualification_period')
        );
        $grp3 = $input->group(
            [
                'vq_date' => $input->dateTime(
                    '',
                    $lng->txt('validity_qualification_date_desc')
                )
                ->withFormat($format)
                ->withValue($this->getQualificationDate() !== null ? $this->getQualificationDate()->format('d.m.Y') : '')
                ->withRequired(true)
            ],
            $lng->txt('validity_qualification_date')
        );
        $grp4 = $input->group([], $lng->txt('prg_no_restart'));
        $grp5 = $input->group(
            [
                'vq_restart_period' => $input->numeric(
                    '',
                    $lng->txt('restart_period_desc')
                )
                ->withAdditionalTransformation($refinery->int()->isGreaterThan(0))
                ->withValue($this->getRestartPeriod() !== null ? $this->getRestartPeriod() : null)
            ],
            $lng->txt('restart_period')
        );
 
        $sg1 = $input->switchableGroup(
            [
                'opt_no_validity_qualification' => $grp1,
                'opt_validity_qualification_period' => $grp2,
                'opt_validity_qualification_date' => $grp3
            ],
            ''
        );
 
        $sg2 = $input->switchableGroup(
            [
                'opt_no_restart' => $grp4,
                'opt_restart_period' => $grp5,
            ],
            ''
        );
 
        $validity_qualification = "opt_no_validity_qualification";
        if (!is_null($this->getQualificationPeriod()) && $this->getQualificationPeriod() > 0) {
            $validity_qualification = 'opt_validity_qualification_period';
        }
 
        if (!is_null($this->getQualificationDate())) {
            $validity_qualification = 'opt_validity_qualification_date';
        }
 
        $restart_value = 'opt_no_restart';
        if (!is_null($this->getRestartPeriod()) && $this->getRestartPeriod() > 0) {
            $restart_value = 'opt_restart_period';
        }
 
        return $input->section(
            [
                'validity_qualification' => $sg1->withValue($validity_qualification),
                'restart' => $sg2->withValue($restart_value)
            ],
            $lng->txt('prg_validity_of_qualification')
        )
        ->withAdditionalTransformation($refinery->custom()->transformation(function (array $vals) {
            $vq_period = null;
            $vq_date = null;
            $restart = null;
 
            if (isset($vals['validity_qualification'][1]['vq_period'])) {
                $vq_period = (int) $vals['validity_qualification'][1]['vq_period'];
            }
 
            if (isset($vals['validity_qualification'][1]['vq_date'])) {
                $vq_date = new DateTime($vals['validity_qualification'][1]['vq_date']);
            }
 
            if (
                count($vals['restart'][1]) > 0 &&
                !is_null($vals['restart'][1]['vq_restart_period'])
            ) {
                $restart = (int) $vals['restart'][1]['vq_restart_period'];
            }
 
            return new ilStudyProgrammeValidityOfAchievedQualificationSettings(
                $vq_period,
                $vq_date,
                $restart
            );
        }));
    }

withQualificationDate()

ilStudyProgrammeValidityOfAchievedQualificationSettings::withQualificationDate

(

?DateTime

$qualification_date

)

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

      : ilStudyProgrammeValidityOfAchievedQualificationSettings {
        $clone = clone $this;
        $clone->qualification_date = $qualification_date;
 
        return $clone;
    }

withQualificationPeriod()

ilStudyProgrammeValidityOfAchievedQualificationSettings::withQualificationPeriod

(

?int

$qualification_period

)

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

      : ilStudyProgrammeValidityOfAchievedQualificationSettings {
        if (!is_null($qualification_period) && 0 > $qualification_period) {
            throw new InvalidArgumentException(
                'Numbers less than 0 are not allowed'
            );
        }
        $clone = clone $this;
        $clone->qualification_period = $qualification_period;
 
        return $clone;
    }

withRestartPeriod()

ilStudyProgrammeValidityOfAchievedQualificationSettings::withRestartPeriod

(

?int

$restart_period

)

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

      : ilStudyProgrammeValidityOfAchievedQualificationSettings {
        if (!is_null($restart_period) && 0 > $restart_period) {
            throw new InvalidArgumentException(
                'Numbers less than 0 are not allowed'
            );
        }
        $clone = clone $this;
        $clone->restart_period = $restart_period;
 
        return $clone;
    }

Field Documentation

$qualification_date

ilStudyProgrammeValidityOfAchievedQualificationSettings::$qualification_date

protected

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

Referenced by __construct().

$qualification_period

ilStudyProgrammeValidityOfAchievedQualificationSettings::$qualification_period

protected

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

Referenced by __construct(), and getQualificationPeriod().

$restart_period

ilStudyProgrammeValidityOfAchievedQualificationSettings::$restart_period

protected

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

Referenced by __construct().

---

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

• Modules/StudyProgramme/classes/class.ilStudyProgrammeValidityOfAchievedQualificationSettings.php