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 setRootId(int $id) : ilStudyProgrammeAssignment
    {
        $this->root_prg_id = $id;
        return $this;
    }

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

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

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

    public function setLastChangeBy(int $assigned_by_id) : ilStudyProgrammeAssignment
    {
        $auto_assignment = [
            self::AUTO_ASSIGNED_BY_ROLE,
            self::AUTO_ASSIGNED_BY_ORGU,
            self::AUTO_ASSIGNED_BY_COURSE,
            self::AUTO_ASSIGNED_BY_GROUP
        ];
        $is_auto_assignment = in_array($assigned_by_id, $auto_assignment);
        $exists = ilObject::_exists($assigned_by_id);
        $is_usr = ilObject::_lookupType($assigned_by_id) == "usr";
        if (!$is_auto_assignment && ($exists && !$is_usr)) {
            throw new ilException("ilStudyProgrammeAssignment::setLastChangeBy: '$assigned_by_id' "
                                 . "is neither a user's id nor a valid membership source.");
        }

        $this->last_change_by = $assigned_by_id;
        return $this;
    }

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

    public function updateLastChange() : ilStudyProgrammeAssignment
    {
        $this->setLastChange(new DateTime());
        return $this;
    }

    public function setLastChange(DateTime $timestamp) : ilStudyProgrammeAssignment
    {
        $this->last_change = $timestamp->format(self::DATE_TIME_FORMAT);
        return $this;
    }

    public function setRestartDate(DateTime $date = null) : ilStudyProgrammeAssignment
    {
        $this->restart_date = $date;
        return $this;
    }

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

    public function setRestartedAssignmentId(int $id) : ilStudyProgrammeAssignment
    {
        $this->restarted_asssignment_id = $id;
        return $this;
    }

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