class.ilStudyProgrammeAssignment.php

Go to the documentation of this file.

<?php declare(strict_types = 1);

/* Copyright (c) 2015 Richard Klees <richard.klees@concepts-and-training.de> Extended GPL, see docs/LICENSE */

class ilStudyProgrammeAssignment
{
    const NO_RESTARTED_ASSIGNMENT = -1;

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

    const AUTO_ASSIGNED_BY_ROLE = -1;
    const AUTO_ASSIGNED_BY_ORGU = -2;
    const AUTO_ASSIGNED_BY_COURSE = -3;
    const AUTO_ASSIGNED_BY_GROUP = -4;

    protected $id;

    protected $usr_id;

    protected $root_prg_id;

    protected $last_change;

    protected $last_change_by;

    protected $restart_date;

    protected $restarted_asssignment_id = self::NO_RESTARTED_ASSIGNMENT;


    public function __construct(int $id)
    {
        $this->id = $id;
    }

    public function getId() : int
    {
        return $this->id;
    }

    public function getRootId() : int
    {
        return $this->root_prg_id;
    }

    public function withRootId(int $root_prg_id) : ilStudyProgrammeAssignment
    {
        $clone = clone $this;
        $clone->root_prg_id = $root_prg_id;
        return $clone;
    }

    public function getUserId() : int
    {
        return $this->usr_id;
    }

    public function withUserId(int $usr_id) : ilStudyProgrammeAssignment
    {
        $clone = clone $this;
        $clone->usr_id = $usr_id;
        return $clone;
    }

    public function getLastChangeBy() : int
    {
        return $this->last_change_by;
    }

    public function getLastChange() : ?DateTimeImmutable
    {
        if ($this->last_change) {
            return DateTimeImmutable::createFromFormat(self::DATE_TIME_FORMAT, $this->last_change);
        }
        return $this->last_change;
    }

    public function withLastChange(
        int $last_change_by,
        DateTimeImmutable $timestamp
    ) : ilStudyProgrammeAssignment {
        $new_date = $timestamp->format(self::DATE_TIME_FORMAT);
        if ($this->getLastChange() && $this->getLastChange()->format(self::DATE_TIME_FORMAT) > $new_date) {
            throw new ilException(
                "Cannot set last change to an earlier date:"
                . "\ncurrent: " . $this->getLastChange()->format(self::DATE_TIME_FORMAT)
                . "\nnew: " . $new_date,
                1
            );
        }
        $clone = clone $this;
        $clone->last_change = $new_date;
        $clone->last_change_by = $last_change_by;
        return $clone;
    }

    public function getRestartDate() : ?DateTimeImmutable
    {
        return $this->restart_date;
    }

    public function getRestartedAssignmentId() : int
    {
        return $this->restarted_asssignment_id;
    }

    public function withRestarted(
        int $restarted_asssignment_id,
        DateTimeImmutable $restart_date = null
    ) : ilStudyProgrammeAssignment {
        $clone = clone $this;
        $clone->restarted_asssignment_id = $restarted_asssignment_id;
        $clone->restart_date = $restart_date;
        return $clone;
    }
}