ilStudyProgrammeAssessmentSettings Class Reference

Collaboration diagram for ilStudyProgrammeAssessmentSettings:

Public Member Functions
	__construct (int $points, int $status)
	getPoints ()
	withPoints (int $points)
	getStatus ()
	withStatus (int $status)
	toFormInput (Field\Factory $input, ilLanguage $lng, Refinery $refinery)

Data Fields
const	STATUS_DRAFT = 10
const	STATUS_ACTIVE = 20
const	STATUS_OUTDATED = 30

Static Public Attributes
static array	$STATUS

Protected Member Functions
	getStatusOptions (ilLanguage $lng)

Protected Attributes
int	$points
int	$status

Detailed Description

Definition at line 24 of file class.ilStudyProgrammeAssessmentSettings.php.

Constructor & Destructor Documentation

__construct()

ilStudyProgrammeAssessmentSettings::__construct	(	int	$points,
		int	$status
	)

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

    {
        if (0 > $points) {
            throw new InvalidArgumentException('Numbers less than 0 are not allowed');
        }
 
        if (!in_array($status, self::$STATUS)) {
            throw new InvalidArgumentException("No valid status: '$status'");
        }
 
        $this->points = $points;
        $this->status = $status;
    }

References $points, and $status.

Member Function Documentation

getPoints()

ilStudyProgrammeAssessmentSettings::getPoints

(

)

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

                               : int
    {
        return $this->points;
    }

References $points.

getStatus()

ilStudyProgrammeAssessmentSettings::getStatus

(

)

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

                               : int
    {
        return $this->status;
    }

References $status.

getStatusOptions()

ilStudyProgrammeAssessmentSettings::getStatusOptions ( ilLanguage  $lng )

protected

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

                                                        : array
    {
        return [
            ilStudyProgrammeSettings::STATUS_DRAFT => $lng->txt("prg_status_draft"),
            ilStudyProgrammeSettings::STATUS_ACTIVE => $lng->txt("prg_status_active"),
            ilStudyProgrammeSettings::STATUS_OUTDATED => $lng->txt("prg_status_outdated")
        ];
    }

References $lng, ilStudyProgrammeSettings\STATUS_ACTIVE, ilStudyProgrammeSettings\STATUS_DRAFT, and ilStudyProgrammeSettings\STATUS_OUTDATED.

toFormInput()

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

Definition at line 85 of file class.ilStudyProgrammeAssessmentSettings.php.

     : \ILIAS\UI\Component\Input\Container\Form\FormInput {
        $num = $input
            ->numeric($lng->txt('prg_points'), $lng->txt('prg_points_byline'))
            ->withValue($this->getPoints())
            ->withAdditionalTransformation($refinery->int()->isGreaterThanOrEqual(0))
        ;
        $select = $input
            ->select(
                $lng->txt('prg_status'),
                $this->getStatusOptions($lng),
                $lng->txt('prg_status_byline')
            )
            ->withValue($this->getStatus())
            ->withRequired(true)
        ;
 
        return $input->section(
            [
                'points' => $num,
                'status' => $select
            ],
            $lng->txt('prg_assessment')
        )
        ->withAdditionalTransformation($refinery->custom()->transformation(function ($vals) {
            return new ilStudyProgrammeAssessmentSettings(
                (int) $vals['points'],
                (int) $vals['status']
            );
        }));
    }

withPoints()

ilStudyProgrammeAssessmentSettings::withPoints

(

int

$points

)

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

                                           : ilStudyProgrammeAssessmentSettings
    {
        if (0 > $points) {
            throw new InvalidArgumentException('Numbers less than 0 are not allowed');
        }
 
        $clone = clone $this;
        $clone->points = $points;
        return $clone;
    }

References $points.

withStatus()

ilStudyProgrammeAssessmentSettings::withStatus

(

int

$status

)

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

                                           : ilStudyProgrammeAssessmentSettings
    {
        if (!in_array($status, self::$STATUS)) {
            throw new InvalidArgumentException("No valid status: '$status'");
        }
 
        $clone = clone $this;
        $clone->status = $status;
        return $clone;
    }

References $status.

Field Documentation

$points

int ilStudyProgrammeAssessmentSettings::$points

protected

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

Referenced by __construct(), getPoints(), and withPoints().

$STATUS

array ilStudyProgrammeAssessmentSettings::$STATUS

static

Initial value:

= [
        self::STATUS_DRAFT,
        self::STATUS_ACTIVE,
        self::STATUS_OUTDATED
    ]

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

$status

int ilStudyProgrammeAssessmentSettings::$status

protected

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

Referenced by __construct(), getStatus(), and withStatus().

STATUS_ACTIVE

const ilStudyProgrammeAssessmentSettings::STATUS_ACTIVE = 20

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

STATUS_DRAFT

const ilStudyProgrammeAssessmentSettings::STATUS_DRAFT = 10

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

STATUS_OUTDATED

const ilStudyProgrammeAssessmentSettings::STATUS_OUTDATED = 30

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

---

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

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