Class ilObjStudyProgramme. More...

Inheritance diagram for ilObjStudyProgramme:

Collaboration diagram for ilObjStudyProgramme:

Public Member Functions

__construct ($a_id=0, $a_call_by_reference=true)

ATTENTION: After using the constructor the object won't be in the cache. More...

getStudyProgrammeUserProgressDB ()

Get a (cached) instance of ilStudyProgrammeUserProgressDB. More...

read ()

Detailed Description

Class ilObjStudyProgramme.

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

Definition at line 18 of file class.ilObjStudyProgramme.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjStudyProgramme::__construct	(	$a_id = `0`,
		$a_call_by_reference = `true`
	)

ATTENTION: After using the constructor the object won't be in the cache.

This could lead to unexpected behaviour when using the tree navigation.

Parameters

int	$a_id
bool	$a_call_by_reference

Reimplemented from ilContainer.

Definition at line 47 of file class.ilObjStudyProgramme.php.

    {
        $this->type = "prg";
        $this->settings = null;
        parent::__construct($a_id, $a_call_by_reference);
 
        $this->clearParentCache();
        $this->clearChildrenCache();
        $this->clearLPChildrenCache();
 
        global $DIC;
        $tree = $DIC['tree'];
        $ilUser = $DIC['ilUser'];
        $this->webdir = $DIC->filesystem()->web();
        $this->tree = $tree;
        $this->ilUser = $ilUser;
 
        $this->object_factory = ilObjectFactoryWrapper::singleton();
        self::initStudyProgrammeCache();
    }

References $DIC, $ilUser, $tree, clearChildrenCache(), clearLPChildrenCache(), clearParentCache(), initStudyProgrammeCache(), settings(), and ilObjectFactoryWrapper\singleton().

Here is the call graph for this function:

Member Function Documentation

◆ _getStudyProgrammeUserProgressDB()

static ilObjStudyProgramme::_getStudyProgrammeUserProgressDB ( )

static

Get an instance of ilStudyProgrammeUserProgressDB.

Returns: ilStudyProgrammeUserProgressDB

Definition at line 93 of file class.ilObjStudyProgramme.php.

    {
        require_once("./Modules/StudyProgramme/classes/class.ilStudyProgrammeUserProgressDB.php");
        static $sp_user_progress_db = null;
        if ($sp_user_progress_db === null) {
            $sp_user_progress_db = new ilStudyProgrammeUserProgressDB();
        }
        return $sp_user_progress_db;
    }

References $sp_user_progress_db.

Referenced by ilObjStudyProgrammeAccess\checkCondition(), ilObjStudyProgrammeGUI\executeCommand(), ilStudyProgrammeUserAssignment\getInstance(), ilStudyProgrammeUserAssignment\getInstancesForProgram(), and ilStudyProgrammeUserAssignment\getInstancesOfUser().

Here is the caller graph for this function:

◆ addLeaf()

ilObjStudyProgramme::addLeaf ( $a_leaf )

Insert a leaf in this object.

Throws when object already contain ilObjStudyProgrammes as children. Throws when this object is not in tree.

Exceptions

ilStudyProgrammeTreeException

Returns: $this

Definition at line 840 of file class.ilObjStudyProgramme.php.

    {
        $this->throwIfNotInTree();
 
        if ($this->hasChildren()) {
            throw new ilStudyProgrammeTreeException("Program already contains other programm nodes.");
        }
 
        if ($a_leaf->getRefId() === null) {
            $a_leaf->createReference();
        }
        $a_leaf->putInTree($this->getRefId());
        $this->clearLPChildrenCache();
 
        $this->settings->setLPMode(ilStudyProgramme::MODE_LP_COMPLETED);
        $this->update();
 
        return $this;
    }

References clearLPChildrenCache(), ilObject\getRefId(), hasChildren(), ilStudyProgramme\MODE_LP_COMPLETED, settings(), throwIfNotInTree(), and update().

Here is the call graph for this function:

◆ addMissingProgresses()

ilObjStudyProgramme::addMissingProgresses ( )

Add missing progress records for all assignments of this programm.

Use this after the structure of the programme was modified.

Returns: null

Definition at line 1128 of file class.ilObjStudyProgramme.php.

    {
        foreach ($this->getAssignments() as $ass) {
            $ass->addMissingProgresses();
        }
    }

References getAssignments().

Referenced by nodeInserted().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addNode()

ilObjStudyProgramme::addNode ( ilObjStudyProgramme $a_prg )

Inserts another ilObjStudyProgramme in this object.

Throws when object already contains non ilObjStudyProgrammes as children. Throws when $a_prg already is in the tree. Throws when this object is not in tree.

Exceptions

ilStudyProgrammeTreeException

Returns: $this

Definition at line 729 of file class.ilObjStudyProgramme.php.

    {
        $this->throwIfNotInTree();
 
        if ($this->getLPMode() == ilStudyProgramme::MODE_LP_COMPLETED) {
            throw new ilStudyProgrammeTreeException("Program already contains leafs.");
        }
 
        if ($this->tree->isInTree($a_prg->getRefId())) {
            throw new ilStudyProgrammeTreeException("Other program already is in tree.");
        }
 
        if ($a_prg->getRefId() === null) {
            $a_prg->createReference();
        }
        $a_prg->putInTree($this->getRefId());
        return $this;
    }

References ilObject\createReference(), getLPMode(), ilObject\getRefId(), ilStudyProgramme\MODE_LP_COMPLETED, putInTree(), and throwIfNotInTree().

Here is the call graph for this function:

◆ adjustLPMode()

ilObjStudyProgramme::adjustLPMode ( )

Adjust the lp mode to match current state of tree:

If there are any non programme children, the mode is MODE_LP_COMPLETED, otherwise its MODE_POINTS.

Exceptions

ilException when programme is not in draft mode.

Definition at line 338 of file class.ilObjStudyProgramme.php.

    {
        if ($this->getAmountOfLPChildren() > 0) {
            $this->settings->setLPMode(ilStudyProgramme::MODE_LP_COMPLETED)
                           ->update();
        } else {
            if ($this->getAmountOfChildren() > 0) {
                $this->settings->setLPMode(ilStudyProgramme::MODE_POINTS)
                               ->update();
            } else {
                $this->settings->setLPMode(ilStudyProgramme::MODE_UNDEFINED)
                               ->update();
            }
        }
    }

References getAmountOfChildren(), getAmountOfLPChildren(), ilStudyProgramme\MODE_LP_COMPLETED, ilStudyProgramme\MODE_POINTS, ilStudyProgramme\MODE_UNDEFINED, and settings().

Here is the call graph for this function:

◆ applyToSubTreeNodes()

ilObjStudyProgramme::applyToSubTreeNodes ( Closure $fun )

Apply the given Closure to every node in the subtree starting at this object.

When the closure returns false, the underlying nodes won't be visited.

Throws when this object is not in tree.

Parameters

Closure $fun - An anonymus function taking an ilObjStudyProgramme as parameter.

Definition at line 674 of file class.ilObjStudyProgramme.php.

    {
        $this->throwIfNotInTree();
 
        if ($fun($this) !== false) {
            foreach ($this->getChildren() as $child) {
                $child->applyToSubTreeNodes($fun);
            }
        }
    }

References getChildren(), and throwIfNotInTree().

Referenced by assignUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ assignUser()

ilObjStudyProgramme::assignUser	(	$a_usr_id,
		$a_assigning_usr_id = `null`
	)

Assign a user to this node at the study program.

Throws when node is in DRAFT or OUTDATED status. Throws when there are no settings for the program.

TODO: Should it be allowed to assign inactive users?

Exceptions

ilException

Parameters

int	$a_usr_id
int \| null	$a_assigning_usr_id	- defaults to global ilUser

Returns: ilStudyProgrammeUserAssignment

Definition at line 938 of file class.ilObjStudyProgramme.php.

    {
        require_once("./Modules/StudyProgramme/classes/class.ilStudyProgrammeUserAssignment.php");
        require_once("./Modules/StudyProgramme/classes/model/class.ilStudyProgrammeAssignment.php");
        require_once("./Modules/StudyProgramme/classes/model/class.ilStudyProgrammeProgress.php");
        require_once("./Modules/StudyProgramme/classes/class.ilStudyProgrammeEvents.php");
 
        if ($this->settings === null) {
            throw new ilException("ilObjStudyProgramme::assignUser: Program was not properly created.'");
        }
 
        if ($this->getStatus() != ilStudyProgramme::STATUS_ACTIVE) {
            throw new ilException("ilObjStudyProgramme::assignUser: Can't assign user to program '"
                                 . $this->getId() . "', since it's not in active status.");
        }
 
        if ($a_assigning_usr_id === null) {
            $a_assigning_usr_id = $this->ilUser->getId();
        }
 
        $ass_mod = ilStudyProgrammeAssignment::createFor($this->settings, $a_usr_id, $a_assigning_usr_id);
        $ass = new ilStudyProgrammeUserAssignment($ass_mod, $this->getStudyProgrammeUserProgressDB());
 
        $this->applyToSubTreeNodes(function (ilObjStudyProgramme $node) use ($ass_mod, $a_assigning_usr_id) {
            $progress = $node->createProgressForAssignment($ass_mod);
            if ($node->getStatus() != ilStudyProgramme::STATUS_ACTIVE) {
                $progress->setStatus(ilStudyProgrammeProgress::STATUS_NOT_RELEVANT)
                         ->update();
            }
        });
 
        ilStudyProgrammeEvents::userAssigned($ass);
 
        return $ass;
    }

References applyToSubTreeNodes(), ilStudyProgrammeAssignment\createFor(), createProgressForAssignment(), ilObject\getId(), getStatus(), getStudyProgrammeUserProgressDB(), settings(), ilStudyProgramme\STATUS_ACTIVE, and ilStudyProgrammeEvents\userAssigned().

Here is the call graph for this function:

◆ canBeRemoved()

ilObjStudyProgramme::canBeRemoved ( )

Check weather a node can be removed.

This is allowed when all progresses on the node are marked as not relevant programmatically.

Returns: bool

Definition at line 818 of file class.ilObjStudyProgramme.php.

    {
        foreach ($this->getProgresses() as $progress) {
            if ($progress->getStatus() != ilStudyProgrammeProgress::STATUS_NOT_RELEVANT) {
                return false;
            }
            if ($progress->getLastChangeBy() !== null) {
                return false;
            }
        }
        return true;
    }

References getProgresses(), and ilStudyProgrammeProgress\STATUS_NOT_RELEVANT.

Referenced by removeNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearChildrenCache()

ilObjStudyProgramme::clearChildrenCache ( )

protected

Clear the cached children.

Definition at line 116 of file class.ilObjStudyProgramme.php.

    {
        $this->children = null;
    }

Referenced by __construct(), moveTo(), nodeInserted(), and removeNode().

Here is the caller graph for this function:

◆ clearLPChildrenCache()

ilObjStudyProgramme::clearLPChildrenCache ( )

protected

Clear the cached lp children.

Definition at line 124 of file class.ilObjStudyProgramme.php.

    {
        $this->lp_children = null;
    }

Referenced by __construct(), addLeaf(), moveTo(), and removeLeaf().

Here is the caller graph for this function:

◆ clearParentCache()

ilObjStudyProgramme::clearParentCache ( )

protected

Clear the cached parent to query it again at the tree.

Definition at line 107 of file class.ilObjStudyProgramme.php.

    {
        // This is not initialized, but we need null if there is no parent.
        $this->parent = false;
    }

Referenced by __construct(), moveTo(), and removeNode().

Here is the caller graph for this function:

◆ create()

ilObjStudyProgramme::create ( )

Create.

Reimplemented from ilContainer.

Definition at line 236 of file class.ilObjStudyProgramme.php.

    {
        $id = parent::create();
        $this->createSettings();
 
        return $id;
    }

References ilObject\$id, and createSettings().

Here is the call graph for this function:

◆ createInstance()

static ilObjStudyProgramme::createInstance ( )

static

Create an instance of ilObjStudyProgramme, put in cache.

Definition at line 148 of file class.ilObjStudyProgramme.php.

    {
        $obj = new ilObjStudyProgramme();
        $obj->create();
        $obj->createReference();
        self::$study_programme_cache->addInstance($obj);
        return $obj;
    }

Referenced by ilObjStudyProgrammeTest\createSmallTree(), ilObjStudyProgrammeTest\setUp(), ilStudyProgrammeEventsTest\setUp(), ilStudyProgrammeLPTest\setUp(), ilStudyProgrammeProgressCalculationTest\setUp(), ilStudyProgrammeUserAssignmentTest\setUp(), ilStudyProgrammeUserProgressTest\setUp(), ilStudyProgrammeProgressCalculationTest\setUpNodes(), ilStudyProgrammeUserProgressTest\testCanBeCompleted3(), ilStudyProgrammeUserProgressTest\testCompletionOnDeeplyNestedProgresses(), ilStudyProgrammeLPTest\testNewNodesAreNotRelevant(), ilStudyProgrammeUserProgressTest\testNewNodesAreNotRelevant(), and ilObjStudyProgrammeTest\testTreeGetParents().

Here is the caller graph for this function:

◆ createProgressForAssignment()

ilObjStudyProgramme::createProgressForAssignment ( ilStudyProgrammeAssignment $ass )

Create a progress on this programme for the given assignment.

Parameters

ilStudyProgrammeAssignment

Returns: ilStudyProgrammeProgress

Definition at line 1091 of file class.ilObjStudyProgramme.php.

    {
        return ilStudyProgrammeProgress::createFor($this->settings, $ass);
    }

References ilStudyProgrammeProgress\createFor(), and settings().

Referenced by assignUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createSettings()

ilObjStudyProgramme::createSettings ( )

protected

Create new settings object.

Throws when settings are already loaded or id is null.

Definition at line 182 of file class.ilObjStudyProgramme.php.

    {
        if ($this->settings !== null) {
            throw new ilException("ilObjStudyProgramme::createSettings: already loaded.");
        }
 
        $id = $this->getId();
        if (!$id) {
            throw new ilException("ilObjStudyProgramme::loadSettings: no id.");
        }
        $this->settings = ilStudyProgramme::createForObject($this);
    }

References ilObject\$id, ilStudyProgramme\createForObject(), ilObject\getId(), and settings().

Referenced by create().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilObjStudyProgramme::delete ( )

Delete Study Programme and all related data.

Returns: boolean true if all object data were removed; false if only a references were removed

Reimplemented from ilContainer.

Definition at line 265 of file class.ilObjStudyProgramme.php.

    {
        // always call parent delete function first!!
        if (!parent::delete()) {
            return false;
        }
 
        $this->deleteSettings();
        try {
            $this->deleteAssignments();
        } catch (ilStudyProgrammeTreeException $e) {
            // This would be the case when SP is in trash (#17797)
        }
 
        return true;
    }

References deleteAssignments(), and deleteSettings().

Here is the call graph for this function:

◆ deleteAssignments()

ilObjStudyProgramme::deleteAssignments ( )

protected

Delete all assignments from the DB.

Definition at line 222 of file class.ilObjStudyProgramme.php.

    {
        foreach ($this->getAssignments() as $ass) {
            $ass->delete();
        }
    }

References getAssignments().

Referenced by delete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteSettings()

ilObjStudyProgramme::deleteSettings ( )

protected

Delete settings from DB.

Throws when settings are not loaded.

Definition at line 211 of file class.ilObjStudyProgramme.php.

    {
        if ($this->settings === null) {
            throw new Exception("ilObjStudyProgramme::deleteSettings: no settings loaded.");
        }
        $this->settings->delete();
    }

References settings().

Referenced by delete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllChildren()

static ilObjStudyProgramme::getAllChildren ( $a_ref_id )

static

Get a list of all ilObjStudyProgrammes in the subtree starting at $a_ref_id.

Throws when object is not in tree.

Parameters

int $a_ref_id

Returns: [ilObjStudyProgramme]

Definition at line 439 of file class.ilObjStudyProgramme.php.

    {
        $ret = array();
        $root = self::getInstanceByRefId($a_ref_id);
        $root_id = $root->getId();
        $root->applyToSubTreeNodes(function ($prg) use (&$ret, $root_id) {
            // exclude root node of subtree.
            if ($prg->getId() == $root_id) {
                return;
            }
            $ret[] = $prg;
        });
        return $ret;
    }

References $ret, $root, and getInstanceByRefId().

Referenced by ilObjStudyProgrammeTreeGUI\confirmedDelete(), ilObjStudyProgrammeTest\testMoveTo(), and ilObjStudyProgrammeTest\testTreeGetChildren().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAmountOfAssignmentsOf()

ilObjStudyProgramme::getAmountOfAssignmentsOf ( $a_user_id )

Get the amount of assignments a user has on this program node or any node above.

Parameters

int $a_user_id

Returns: int

Definition at line 1017 of file class.ilObjStudyProgramme.php.

    {
        return count($this->getAssignmentsOf($a_user_id));
    }

References getAssignmentsOf().

Referenced by hasAssignmentOf().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAmountOfChildren()

ilObjStudyProgramme::getAmountOfChildren ( )

Get the amount of other StudyProgrammes this StudyProgramme has as children.

Throws when this object is not in tree.

Returns: int

Definition at line 542 of file class.ilObjStudyProgramme.php.

    {
        return count($this->getChildren());
    }

References getChildren().

Referenced by adjustLPMode(), and hasChildren().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAmountOfLPChildren()

ilObjStudyProgramme::getAmountOfLPChildren ( )

Get the amount of leafs, the study programme contains.

Throws when this object is not in tree.

Definition at line 632 of file class.ilObjStudyProgramme.php.

    {
        return count($this->getLPChildren());
    }

References getLPChildren().

Referenced by adjustLPMode(), and hasLPChildren().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAssignments()

ilObjStudyProgramme::getAssignments ( )

Get all assignments to this program or any node above.

Returns: [ilStudyProgrammeUserAssignment]

Definition at line 1050 of file class.ilObjStudyProgramme.php.

    {
        return array_map(function ($ass) {
            return new ilStudyProgrammeUserAssignment($ass, $this->getStudyProgrammeUserProgressDB());
        }, array_values($this->getAssignmentsRaw())); // use array values since we want keys 0...
    }

References getAssignmentsRaw(), and getStudyProgrammeUserProgressDB().

Referenced by addMissingProgresses(), deleteAssignments(), and hasAssignments().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAssignmentsOf()

ilObjStudyProgramme::getAssignmentsOf ( $a_user_id )

Get the assignments of user at this program or any node above.

The assignments are ordered by last_change, where the most recently changed assignments is the first one.

Parameters

int $a_user_id

Returns: [ilStudyProgrammeUserAssignment]

Definition at line 1030 of file class.ilObjStudyProgramme.php.

    {
        require_once("./Modules/StudyProgramme/classes/class.ilStudyProgrammeUserAssignment.php");
 
        $prg_ids = $this->getIdsFromNodesOnPathFromRootToHere();
        $assignments = ilStudyProgrammeAssignment::where(array( "usr_id" => $a_user_id
                                                                 , "root_prg_id" => $prg_ids
                                                           ))
                                                    ->orderBy("last_change", "DESC")
                                                    ->get();
        return array_map(function ($ass) {
            return new ilStudyProgrammeUserAssignment($ass, $this->getStudyProgrammeUserProgressDB());
        }, array_values($assignments)); // use array values since we want keys 0...
    }

References getIdsFromNodesOnPathFromRootToHere(), getStudyProgrammeUserProgressDB(), and ActiveRecord\where().

Referenced by getAmountOfAssignmentsOf().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAssignmentsRaw()

ilObjStudyProgramme::getAssignmentsRaw ( )

protected

Get model objects for the assignments on this programm.

Definition at line 1268 of file class.ilObjStudyProgramme.php.

    {
        require_once("./Modules/StudyProgramme/classes/class.ilStudyProgrammeUserAssignment.php");
        $prg_ids = $this->getIdsFromNodesOnPathFromRootToHere();
        return ilStudyProgrammeAssignment::where(array( "root_prg_id" => $prg_ids))
                                                ->orderBy("last_change", "DESC")
                                                ->get();
    }

References getIdsFromNodesOnPathFromRootToHere(), and ActiveRecord\where().

Referenced by getAssignments().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChildren()

ilObjStudyProgramme::getChildren ( )

Get all ilObjStudyProgrammes that are direct children of this object.

Throws when this object is not in tree.

Returns: [ilObjStudyProgramme]

Definition at line 462 of file class.ilObjStudyProgramme.php.

    {
        $this->throwIfNotInTree();
 
        if ($this->children === null) {
            $ref_ids = $this->tree->getChildsByType($this->getRefId(), "prg");
 
            // apply container sorting to tree
            $sorting = ilContainerSorting::_getInstance($this->getId());
            $ref_ids = $sorting->sortItems(array('prg' => $ref_ids));
            $ref_ids = $ref_ids['prg'];
 
            $this->children = array_map(function ($node_data) {
                return ilObjStudyProgramme::getInstanceByRefId($node_data["child"]);
            }, $ref_ids);
        }
 
        return $this->children;
    }

References $children, ilContainerSorting\_getInstance(), ilObject\getId(), getInstanceByRefId(), ilObject\getRefId(), and throwIfNotInTree().

Referenced by applyToSubTreeNodes(), and getAmountOfChildren().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCompletedCourses()

ilObjStudyProgramme::getCompletedCourses ( $a_user_id )

Get courses in this program that the given user already completed.

Parameters

int $a_user_id

Returns: array $obj_id => $ref_id

Definition at line 691 of file class.ilObjStudyProgramme.php.

    {
        require_once("Services/ContainerReference/classes/class.ilContainerReference.php");
        require_once("Services/Tracking/classes/class.ilLPStatus.php");
 
        $node_data = $this->tree->getNodeData($this->getRefId());
        $crsrs = $this->tree->getSubTree($node_data, true, "crsr");
 
        $completed_crss = array();
        foreach ($crsrs as $ref) {
            $crs_id = ilContainerReference::_lookupTargetId($ref["obj_id"]);
            if (ilLPStatus::_hasUserCompleted($crs_id, $a_user_id)) {
                $completed_crss[] = array( "crs_id" => $crs_id
                                         , "prg_ref_id" => $ref["parent"]
                                         , "crsr_ref_id" => $ref["child"]
                                         , "crsr_id" => $ref["obj_id"]
                                         , "title" => ilContainerReference::_lookupTargetTitle($ref["obj_id"])
                                         );
            }
        }
 
        return $completed_crss;
    }

References ilLPStatus\_hasUserCompleted(), ilContainerReference\_lookupTargetId(), ilContainerReference\_lookupTargetTitle(), and ilObject\getRefId().

Here is the call graph for this function:

◆ getCreatableSubObjects()

static ilObjStudyProgramme::getCreatableSubObjects	(	$a_subobjects,
		$a_ref_id
	)

static

Filter the list of possible subobjects for the objects that actually could be created on a concrete node.

Will be called by ilObjDefinition::getCreatableSubObjects.

Parameters

array	$a_subobjects
int	$a_ref_id

Returns: array

Definition at line 1388 of file class.ilObjStudyProgramme.php.

    {
        if ($a_ref_id === null) {
            return $a_subobjects;
        }
 
        if (ilObject::_lookupType($a_ref_id, true) != "prg") {
            throw new ilException("Ref-Id '$a_ref_id' does not belong to a study programme object.");
        }
 
        $parent = ilObjStudyProgramme::getInstanceByRefId($a_ref_id);
 
        $mode = $parent->getLPMode();
 
        switch ($mode) {
            case ilStudyProgramme::MODE_UNDEFINED:
                return $a_subobjects;
            case ilStudyProgramme::MODE_POINTS:
                return array("prg" => $a_subobjects["prg"]);
            case ilStudyProgramme::MODE_LP_COMPLETED:
                unset($a_subobjects["prg"]);
                return $a_subobjects;
        }
 
        throw new ilException("Undefined mode for study programme: '$mode'");
    }

References $parent, ilObject\_lookupType(), getInstanceByRefId(), ilStudyProgramme\MODE_LP_COMPLETED, ilStudyProgramme\MODE_POINTS, and ilStudyProgramme\MODE_UNDEFINED.

Referenced by ilObjectDefinition\getCreatableSubObjects(), ilObjStudyProgrammeTest\testCreatableSubObjectsRaisesOnNonProgramRef(), ilObjStudyProgrammeTest\testCreatableSubObjectsWithoutRef(), and ilObjStudyProgrammeTest\testCreateableSubObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDepth()

ilObjStudyProgramme::getDepth ( )

Get the depth of this StudyProgramme in the tree starting at the topmost StudyProgramme (not root node of the repo tree!).

Root node has depth = 0.

Throws when this object is not in tree.

Returns: int

Definition at line 555 of file class.ilObjStudyProgramme.php.

    {
        $cur = $this;
        $count = 0;
        while ($cur = $cur->getParent()) {
            $count++;
        }
        return $count;
    }

◆ getIdsFromNodesOnPathFromRootToHere()

ilObjStudyProgramme::getIdsFromNodesOnPathFromRootToHere ( )

protected

Get the ids from the nodes in the path leading from the root node of this program to this node, including the id of this node.

Definition at line 1256 of file class.ilObjStudyProgramme.php.

    {
        $prg_ids = array_map(function ($par) {
            return $par->getId();
        }, $this->getParents());
        $prg_ids[] = $this->getId();
        return $prg_ids;
    }

References ilObject\getId(), and getParents().

Referenced by getAssignmentsOf(), and getAssignmentsRaw().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIdsOfUsersWithCompletedProgress()

ilObjStudyProgramme::getIdsOfUsersWithCompletedProgress ( )

Get the ids of all users that have completed this programme.

Returns: int[]

Definition at line 1191 of file class.ilObjStudyProgramme.php.

    {
        $returns = array();
        foreach ($this->getProgresses() as $progress) {
            if ($progress->isSuccessful()) {
                $returns[] = $progress->getUserId();
            }
        }
        return array_unique($returns);
    }

References getProgresses().

Here is the call graph for this function:

◆ getIdsOfUsersWithFailedProgress()

ilObjStudyProgramme::getIdsOfUsersWithFailedProgress ( )

Get the ids of all users that have failed this programme.

Returns: int[]

Definition at line 1207 of file class.ilObjStudyProgramme.php.

    {
        $returns = array();
        foreach ($this->getProgresses() as $progress) {
            $progress->recalculateFailedToDeadline();
            if ($progress->isFailed()) {
                $returns[] = $progress->getUserId();
            }
        }
        return array_unique($returns);
    }

References getProgresses().

Here is the call graph for this function:

◆ getIdsOfUsersWithNotCompletedAndRelevantProgress()

ilObjStudyProgramme::getIdsOfUsersWithNotCompletedAndRelevantProgress ( )

Get the ids of all users that have not completed this programme but have a relevant progress on it.

Returns: int[]

Definition at line 1225 of file class.ilObjStudyProgramme.php.

    {
        $returns = array();
        foreach ($this->getProgresses() as $progress) {
            if ($progress->isRelevant() && !$progress->isSuccessful()) {
                $returns[] = $progress->getUserId();
            }
        }
        return array_unique($returns);
    }

References getProgresses().

Here is the call graph for this function:

◆ getIdsOfUsersWithRelevantProgress()

ilObjStudyProgramme::getIdsOfUsersWithRelevantProgress ( )

Get the ids of all users that have a relevant progress at this programme.

Returns: int[]

Definition at line 1175 of file class.ilObjStudyProgramme.php.

    {
        $returns = array();
        foreach ($this->getProgresses() as $progress) {
            if ($progress->isRelevant()) {
                $returns[] = $progress->getUserId();
            }
        }
        return array_unique($returns);
    }

References getProgresses().

Here is the call graph for this function:

◆ getInstanceByRefId()

static ilObjStudyProgramme::getInstanceByRefId ( $a_ref_id )

static

Get an instance of ilObjStudyProgramme, use cache.

Parameters

int $a_ref_id

Returns: ilObjStudyProgramme

Definition at line 136 of file class.ilObjStudyProgramme.php.

    {
        require_once("Modules/StudyProgramme/classes/class.ilObjStudyProgrammeCache.php");
        if (self::$study_programme_cache === null) {
            self::initStudyProgrammeCache();
        }
        return self::$study_programme_cache->getInstanceByRefId($a_ref_id);
    }

References initStudyProgrammeCache().

Referenced by ilObjStudyProgrammeAccess\_checkAccess(), getAllChildren(), getChildren(), getCreatableSubObjects(), ilObjStudyProgrammeSettingsGUI\getObject(), getParent(), ilObjStudyProgrammeTreeExplorerGUI\getRootNode(), ilStudyProgrammeAppEventListener\getStudyProgramme(), ilObjStudyProgrammeMembersGUI\getStudyProgramme(), ilStudyProgrammeUserAssignment\getStudyProgramme(), ilStudyProgrammeUserProgress\getStudyProgramme(), putInTree(), setProgressesCompletedIfParentIsProgrammeInLPCompletedMode(), ilObjStudyProgrammeTest\testDelete(), ilObjStudyProgrammeTest\testGetInstanceByRefId(), ilObjStudyProgrammeTest\testLoadByObjId(), ilObjStudyProgrammeTest\testSettings(), and ilStudyProgrammeType\updateAssignedStudyProgrammesIcons().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLastChange()

ilObjStudyProgramme::getLastChange ( )

Get the timestamp of the last change on this program or sub program.

Returns: ilDateTime

Definition at line 291 of file class.ilObjStudyProgramme.php.

    {
        return $this->settings->getLastChange();
    }

References settings().

Here is the call graph for this function:

◆ getLPChildren()

ilObjStudyProgramme::getLPChildren ( )

Get the leafs the study programme contains.

Throws when this object is not in tree.

Returns: ilStudyProgrammeLeaf[]

Definition at line 586 of file class.ilObjStudyProgramme.php.

    {
        $this->throwIfNotInTree();
 
        if ($this->lp_children === null) {
            $this->lp_children = array();
 
            // TODO: find a better way to get all elements except StudyProgramme-children
            $ref_ids = $this->tree->getChildsByType($this->getRefId(), "crsr");
 
            // apply container sorting to tree
            $sorting = ilContainerSorting::_getInstance($this->getId());
            $ref_ids = $sorting->sortItems(array('crs_ref' => $ref_ids));
            $ref_ids = $ref_ids['crs_ref'];
 
            $lp_children = array_map(function ($node_data) {
                $lp_obj = $this->object_factory->getInstanceByRefId($node_data["child"]);
 
                // filter out all StudyProgramme instances
                return ($lp_obj instanceof $this)? null : $lp_obj;
            }, $ref_ids);
 
            $this->lp_children = array_filter($lp_children);
        }
        return $this->lp_children;
    }

References $lp_children, ilContainerSorting\_getInstance(), ilObject\getId(), ilObject\getRefId(), and throwIfNotInTree().

Referenced by getAmountOfLPChildren(), and getLPChildrenIds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLPChildrenIds()

ilObjStudyProgramme::getLPChildrenIds ( )

Get the ids of the leafs the program contains.

Throws when object is not in tree.

Returns: ilStudyProgrammeLeaf[]

Definition at line 620 of file class.ilObjStudyProgramme.php.

    {
        return array_map(function ($child) {
            return $child->getId();
        }, $this->getLPChildren());
    }

References getLPChildren().

Here is the call graph for this function:

◆ getLPMode()

ilObjStudyProgramme::getLPMode ( )

Get the lp mode.

Returns: integer - one of ilStudyProgramme::$MODES

Definition at line 325 of file class.ilObjStudyProgramme.php.

    {
        return $this->settings->getLPMode();
    }

References settings().

Referenced by addNode(), and nodeInserted().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getParent()

ilObjStudyProgramme::getParent ( )

Get the parent ilObjStudyProgramme of this object.

Returns null if parent is no StudyProgramme.

Throws when this object is not in tree.

Returns: ilObjStudyProgramme | null

Definition at line 490 of file class.ilObjStudyProgramme.php.

    {
        if ($this->parent === false) {
            $this->throwIfNotInTree();
            $parent_data = $this->tree->getParentNodeData($this->getRefId());
            if ($parent_data["type"] != "prg") {
                $this->parent = null;
            } else {
                $this->parent = ilObjStudyProgramme::getInstanceByRefId($parent_data["ref_id"]);
            }
        }
        return $this->parent;
    }

References $parent, getInstanceByRefId(), ilObject\getRefId(), and throwIfNotInTree().

Referenced by moveTo(), removeNode(), and updateLastChange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getParentId()

static ilObjStudyProgramme::getParentId ( ilObject $a_object )

staticprotected

Get the obj id of the parent object for the given object.

Returns null if object is not in the tree currently.

Returns: int | null

Definition at line 1324 of file class.ilObjStudyProgramme.php.

    {
        global $DIC;
        $tree = $DIC['tree'];
        if (!$tree->isInTree($a_object->getRefId())) {
            return null;
        }
 
        $nd = $tree->getParentNodeData($a_object->getRefId());
        return $nd["obj_id"];
    }

References $DIC, $nd, $tree, and ilObject\getRefId().

Here is the call graph for this function:

◆ getParents()

ilObjStudyProgramme::getParents ( )

Get all parents of the node, where the root of the program comes first.

Returns: [ilObjStudyProgramme]

Definition at line 509 of file class.ilObjStudyProgramme.php.

    {
        $current = $this;
        $parents = array();
        while (true) {
            $current = $current->getParent();
            if ($current === null) {
                return array_reverse($parents);
            }
            $parents[] = $current;
        }
    }

References $current.

Referenced by getIdsFromNodesOnPathFromRootToHere(), and getRoot().

Here is the caller graph for this function:

◆ getPoints()

ilObjStudyProgramme::getPoints ( )

Get the amount of points.

Returns: integer - larger than zero

Definition at line 301 of file class.ilObjStudyProgramme.php.

    {
        return $this->settings->getPoints();
    }

References settings().

Referenced by ilObjStudyProgrammeSettingsGUI\buildForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProgresses()

ilObjStudyProgramme::getProgresses ( )

Get all progresses on this node.

Returns: ilStudyProgrammeUserProgress[]

Definition at line 1140 of file class.ilObjStudyProgramme.php.

    {
        return $this->getStudyProgrammeUserProgressDB()->getInstancesForProgram($this->getId());
    }

References ilObject\getId(), and getStudyProgrammeUserProgressDB().

Referenced by canBeRemoved(), getIdsOfUsersWithCompletedProgress(), getIdsOfUsersWithFailedProgress(), getIdsOfUsersWithNotCompletedAndRelevantProgress(), getIdsOfUsersWithRelevantProgress(), hasProgresses(), and hasRelevantProgresses().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProgressesOf()

ilObjStudyProgramme::getProgressesOf ( $a_user_id )

Get the progresses the user has on this node.

Parameters

int $a_user_id

Returns: ilStudyProgrammUserProgress[]

Definition at line 1102 of file class.ilObjStudyProgramme.php.

    {
        return $this->getStudyProgrammeUserProgressDB()->getInstancesForUser($this->getId(), $a_user_id);
    }

References ilObject\getId(), and getStudyProgrammeUserProgressDB().

Here is the call graph for this function:

◆ getProgressForAssignment()

ilObjStudyProgramme::getProgressForAssignment ( $a_assignment_id )

Get the progress for an assignment on this node.

Throws when assignment does not belong to this program.

Exceptions

ilException

Parameters

int $a_assignment_id

Returns: ilStudyProgrammUserProgress

Definition at line 1116 of file class.ilObjStudyProgramme.php.

    {
        return $this->getStudyProgrammeUserProgressDB()->getInstanceForAssignment($this->getId(), $a_assignment_id);
    }

References ilObject\getId(), and getStudyProgrammeUserProgressDB().

Here is the call graph for this function:

◆ getRawSettings()

ilObjStudyProgramme::getRawSettings ( )

Get the underlying model of this program.

ATTENTION: Only use the model object if you know what you are doing.

Returns: ilStudyProgramme

Definition at line 1343 of file class.ilObjStudyProgramme.php.

    {
        return $this->settings;
    }

References $settings.

◆ getRoot()

ilObjStudyProgramme::getRoot ( )

Get the ilObjStudyProgramme that is the root node of the tree this programme is in.

Throws when this object is not in tree.

Returns: ilObjStudyProgramme

Definition at line 573 of file class.ilObjStudyProgramme.php.

    {
        $parents = $this->getParents();
        return $parents[0];
    }

References getParents().

Here is the call graph for this function:

◆ getStatus()

ilObjStudyProgramme::getStatus ( )

Get the status.

Returns: integer - one of ilStudyProgramme::$STATUS

Definition at line 359 of file class.ilObjStudyProgramme.php.

    {
        return $this->settings->getStatus();
    }

References settings().

Referenced by assignUser(), ilObjStudyProgrammeSettingsGUI\buildForm(), and isActive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStudyProgrammeUserProgressDB()

ilObjStudyProgramme::getStudyProgrammeUserProgressDB ( )

Get a (cached) instance of ilStudyProgrammeUserProgressDB.

Returns: ilStudyProgrammeUserProgressDB

Definition at line 80 of file class.ilObjStudyProgramme.php.

    {
        if (!$this->sp_user_progress_db) {
            $this->sp_user_progress_db = static::_getStudyProgrammeUserProgressDB();
        }
        return $this->sp_user_progress_db;
    }

References $sp_user_progress_db.

Referenced by assignUser(), getAssignments(), getAssignmentsOf(), getProgresses(), getProgressesOf(), and getProgressForAssignment().

Here is the caller graph for this function:

◆ getSubType()

ilObjStudyProgramme::getSubType ( )

Gets the SubType Object.

Returns: ilStudyProgrammeType

Definition at line 416 of file class.ilObjStudyProgramme.php.

    {
        if (!in_array($this->getSubtypeId(), array("-", "0"))) {
            $subtype_id = $this->getSubtypeId();
            return new ilStudyProgrammeType($subtype_id);
        }
 
        return null;
    }

References getSubtypeId().

Referenced by update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSubtypeId()

ilObjStudyProgramme::getSubtypeId ( )

Gets the meta-data subtype id (allows to add additional meta-data based on a type)

Returns: integer

Definition at line 392 of file class.ilObjStudyProgramme.php.

    {
        return $this->settings->getSubtypeId();
    }

References settings().

Referenced by ilObjStudyProgrammeSettingsGUI\buildForm(), getSubType(), and ilObjStudyProgrammeSettingsGUI\updateWith().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasAssignmentOf()

ilObjStudyProgramme::hasAssignmentOf ( $a_user_id )

Check whether user is assigned to this program or any node above.

Parameters

int $a_user_id

Returns: bool

Definition at line 1005 of file class.ilObjStudyProgramme.php.

    {
        return $this->getAmountOfAssignmentsOf($a_user_id) > 0;
    }

References getAmountOfAssignmentsOf().

Here is the call graph for this function:

◆ hasAssignments()

ilObjStudyProgramme::hasAssignments ( )

Are there any assignments on this node or any node above?

Returns: bool

Definition at line 1062 of file class.ilObjStudyProgramme.php.

    {
        return count($this->getAssignments()) > 0;
    }

References getAssignments().

Here is the call graph for this function:

◆ hasChildren()

ilObjStudyProgramme::hasChildren ( )

Does this StudyProgramme have other ilObjStudyProgrammes as children?

Throws when this object is not in tree.

Returns: bool

Definition at line 529 of file class.ilObjStudyProgramme.php.

    {
        return $this->getAmountOfChildren() > 0;
    }

References getAmountOfChildren().

Referenced by addLeaf().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasLPChildren()

ilObjStudyProgramme::hasLPChildren ( )

Does this StudyProgramme has leafs?

Throws when this object is not in tree.

Returns: bool

Definition at line 644 of file class.ilObjStudyProgramme.php.

    {
        return ($this->getAmountOfLPChildren() > 0);
    }

References getAmountOfLPChildren().

Here is the call graph for this function:

◆ hasProgresses()

ilObjStudyProgramme::hasProgresses ( )

Are there any users that have a progress on this programme?

Returns: bool

Definition at line 1150 of file class.ilObjStudyProgramme.php.

    {
        return count($this->getProgresses()) > 0;
    }

References getProgresses().

Here is the call graph for this function:

◆ hasRelevantProgresses()

ilObjStudyProgramme::hasRelevantProgresses ( )

Are there any users that have a relevant progress on this programme?

Returns: bool

Definition at line 1160 of file class.ilObjStudyProgramme.php.

    {
        foreach ($this->getProgresses() as $progress) {
            if ($progress->isRelevant()) {
                return true;
            }
        }
        return false;
    }

References getProgresses().

Here is the call graph for this function:

◆ initStudyProgrammeCache()

static ilObjStudyProgramme::initStudyProgrammeCache ( )

static

Definition at line 68 of file class.ilObjStudyProgramme.php.

    {
        if (self::$study_programme_cache === null) {
            self::$study_programme_cache = ilObjStudyProgrammeCache::singleton();
        }
    }

References ilObjStudyProgrammeCache\singleton().

Referenced by __construct(), getInstanceByRefId(), and setProgressesCompletedIfParentIsProgrammeInLPCompletedMode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isActive()

ilObjStudyProgramme::isActive ( )

Check whether this programme is active.

Returns: bool

Definition at line 382 of file class.ilObjStudyProgramme.php.

    {
        return $this->getStatus() == ilStudyProgramme::STATUS_ACTIVE;
    }

References getStatus(), and ilStudyProgramme\STATUS_ACTIVE.

Here is the call graph for this function:

◆ moveTo()

ilObjStudyProgramme::moveTo ( ilObjStudyProgramme $a_new_parent )

Move this tree node to a new parent.

Throws, when manipulation of tree is not allowed due to invariants that need to hold on the tree.

Exceptions

ilStudyProgrammeTreeException

Parameters

int $a_new_parent_ref_id

Returns: $this

Definition at line 893 of file class.ilObjStudyProgramme.php.

    {
        global $DIC;
        $rbacadmin = $DIC['rbacadmin'];
 
        if ($parent = $this->getParent()) {
 
            // TODO: check if there some leafs in the new parent
 
            $this->tree->moveTree($this->getRefId(), $a_new_parent->getRefId());
            // necessary to clean up permissions
            $rbacadmin->adjustMovedObjectPermissions($this->getRefId(), $parent->getRefId());
 
            // TODO: lp-progress needs to be updated
 
            // clear caches on different nodes
            $this->clearParentCache();
 
            $parent->clearChildrenCache();
            $parent->clearLPChildrenCache();
 
            $a_new_parent->clearChildrenCache();
            $a_new_parent->clearLPChildrenCache();
        }
 
        return $this;
    }

References $DIC, $parent, ilObject\$rbacadmin, clearChildrenCache(), clearLPChildrenCache(), clearParentCache(), getParent(), and ilObject\getRefId().

Here is the call graph for this function:

◆ nodeInserted()

ilObjStudyProgramme::nodeInserted ( ilObjStudyProgramme $a_prg )

protected

Clears child chache and adds progress for new node.

Definition at line 751 of file class.ilObjStudyProgramme.php.

    {
        if ($this->getLPMode() == ilStudyProgramme::MODE_LP_COMPLETED) {
            throw new ilStudyProgrammeTreeException("Program already contains leafs.");
        }
 
        if ($this->settings->getLPMode() !== ilStudyProgramme::MODE_POINTS) {
            $this->settings->setLPMode(ilStudyProgramme::MODE_POINTS)
                           ->update();
        }
 
        $this->clearChildrenCache();
        $this->addMissingProgresses();
    }

References addMissingProgresses(), clearChildrenCache(), getLPMode(), ilStudyProgramme\MODE_LP_COMPLETED, ilStudyProgramme\MODE_POINTS, and settings().

Here is the call graph for this function:

◆ putInTree()

ilObjStudyProgramme::putInTree ( $a_parent_ref )

Overwritten from ilObject.

Calls nodeInserted on parent object if parent object is another program.

Reimplemented from ilContainer.

Definition at line 771 of file class.ilObjStudyProgramme.php.

    {
        $res = parent::putInTree($a_parent_ref);
 
        if (ilObject::_lookupType($a_parent_ref, true) == "prg") {
            $par = ilObjStudyProgramme::getInstanceByRefId($a_parent_ref);
            $par->nodeInserted($this);
        }
 
        return $res;
    }

References $res, ilObject\_lookupType(), and getInstanceByRefId().

Referenced by addNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilObjStudyProgramme::read ( )

read

@access public

Parameters

return

Reimplemented from ilContainer.

Definition at line 229 of file class.ilObjStudyProgramme.php.

    {
        parent::read();
        $this->readSettings();
    }

References readSettings().

Here is the call graph for this function:

◆ readSettings()

ilObjStudyProgramme::readSettings ( )

protected

Load Settings from DB.

Throws when settings are already loaded or id is null.

Definition at line 166 of file class.ilObjStudyProgramme.php.

    {
        if ($this->settings !== null) {
            throw new ilException("ilObjStudyProgramme::loadSettings: already loaded.");
        }
        $id = $this->getId();
        if (!$id) {
            throw new ilException("ilObjStudyProgramme::loadSettings: no id.");
        }
        $this->settings = new ilStudyProgramme($this->getId());
    }

References ilObject\$id, ilObject\getId(), and settings().

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeAssignment()

ilObjStudyProgramme::removeAssignment ( ilStudyProgrammeUserAssignment $a_assignment )

Remove an assignment from this program.

Throws when assignment doesn't have this program as root node.

Exceptions

ilException

Returns: $this

Definition at line 982 of file class.ilObjStudyProgramme.php.

    {
        require_once("./Modules/StudyProgramme/classes/class.ilStudyProgrammeEvents.php");
 
        if ($a_assignment->getStudyProgramme()->getId() != $this->getId()) {
            throw new ilException("ilObjStudyProgramme::removeAssignment: Assignment '"
                                 . $a_assignment->getId() . "' does not belong to study "
                                 . "program '" . $this->getId() . "'.");
        }
 
        ilStudyProgrammeEvents::userDeassigned($a_assignment);
 
        $a_assignment->delete();
 
        return $this;
    }

References ilStudyProgrammeUserAssignment\delete(), ilStudyProgrammeUserAssignment\getId(), ilStudyProgrammeUserAssignment\getStudyProgramme(), and ilStudyProgrammeEvents\userDeassigned().

Here is the call graph for this function:

◆ removeLeaf()

ilObjStudyProgramme::removeLeaf ( $a_leaf )

Remove a leaf from this object.

Throws when leaf is not a child of this object. Throws, when manipulation of tree is not allowed due to invariants that need to hold on the tree.

Exceptions

ilException
ilStudyProgrammeTreeException

Returns: $this

Definition at line 870 of file class.ilObjStudyProgramme.php.

    {
        if (self::getParentId($a_leaf) !== $this->getId()) {
            throw new ilStudyProgrammeTreeException("This is no parent of the given leaf node.");
        }
 
        $node_data = $this->tree->getNodeData($a_leaf->getRefId());
        $this->tree->deleteTree($node_data);
        $this->clearLPChildrenCache();
 
        return $this;
    }

References clearLPChildrenCache(), and ilObject\getId().

Here is the call graph for this function:

◆ removeNode()

ilObjStudyProgramme::removeNode ( ilObjStudyProgramme $a_prg )

Remove a node from this object.

Throws when node is no child of the object. Throws, when manipulation of tree is not allowed due to invariants that need to hold on the tree.

Exceptions

ilException
ilStudyProgrammTreeException

Returns: $this

Definition at line 793 of file class.ilObjStudyProgramme.php.

    {
        if ($a_prg->getParent()->getId() !== $this->getId()) {
            throw new ilStudyProgrammeTreeException("This is no parent of the given programm.");
        }
 
        if (!$a_prg->canBeRemoved()) {
            throw new ilStudyProgrammeTreeException("The node has relevant assignments.");
        }
 
        // *sigh*...
        $node_data = $this->tree->getNodeData($a_prg->getRefId());
        $this->tree->deleteTree($node_data);
        $a_prg->clearParentCache();
        $this->clearChildrenCache();
 
        return $this;
    }

References canBeRemoved(), clearChildrenCache(), clearParentCache(), getParent(), and ilObject\getRefId().

Here is the call graph for this function:

◆ setPoints()

ilObjStudyProgramme::setPoints ( $a_points )

Set the amount of points.

Parameters

integer $a_points - larger than zero

Exceptions

ilException

Returns: $this

Definition at line 313 of file class.ilObjStudyProgramme.php.

    {
        $this->settings->setPoints($a_points);
        $this->updateLastChange();
        return $this;
    }

References settings(), and updateLastChange().

Referenced by ilObjStudyProgrammeSettingsGUI\updateWith().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setProgressesCompletedFor()

static ilObjStudyProgramme::setProgressesCompletedFor	(	$a_obj_id,
		$a_user_id
	)

static

Set all progresses to completed where the object with given id is a leaf and that belong to the user.

Definition at line 1281 of file class.ilObjStudyProgramme.php.

    {
        // We only use courses via crs_refs
        $type = ilObject::_lookupType($a_obj_id);
        if ($type == "crs") {
            require_once("Services/ContainerReference/classes/class.ilContainerReference.php");
            $crs_reference_obj_ids = ilContainerReference::_lookupSourceIds($a_obj_id);
            foreach ($crs_reference_obj_ids as $obj_id) {
                foreach (ilObject::_getAllReferences($obj_id) as $ref_id) {
                    self::setProgressesCompletedIfParentIsProgrammeInLPCompletedMode($ref_id, $obj_id, $a_user_id);
                }
            }
        } else {
            foreach (ilObject::_getAllReferences($a_obj_id) as $ref_id) {
                self::setProgressesCompletedIfParentIsProgrammeInLPCompletedMode($ref_id, $a_obj_id, $a_user_id);
            }
        }
    }

References ilObject\$ref_id, ilObject\$type, ilObject\_getAllReferences(), ilContainerReference\_lookupSourceIds(), ilObject\_lookupType(), and setProgressesCompletedIfParentIsProgrammeInLPCompletedMode().

Referenced by ilStudyProgrammeAppEventListener\onServiceTrackingUpdateStatus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setProgressesCompletedIfParentIsProgrammeInLPCompletedMode()

static ilObjStudyProgramme::setProgressesCompletedIfParentIsProgrammeInLPCompletedMode	(	$a_ref_id,
		$a_obj_id,
		$a_user_id
	)

staticprotected

Definition at line 1300 of file class.ilObjStudyProgramme.php.

    {
        global $DIC; // TODO: replace this by a settable static for testing purpose?
        $tree = $DIC['tree'];
        $node_data = $tree->getParentNodeData($a_ref_id);
        if ($node_data["type"] !== "prg") {
            return;
        }
        self::initStudyProgrammeCache();
        $prg = ilObjStudyProgramme::getInstanceByRefId($node_data["child"]);
        if ($prg->getLPMode() != ilStudyProgramme::MODE_LP_COMPLETED) {
            return;
        }
        foreach ($prg->getProgressesOf($a_user_id) as $progress) {
            $progress->setLPCompleted($a_obj_id, $a_user_id);
        }
    }

References $DIC, $tree, getInstanceByRefId(), initStudyProgrammeCache(), and ilStudyProgramme\MODE_LP_COMPLETED.

Referenced by setProgressesCompletedFor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setStatus()

ilObjStudyProgramme::setStatus ( $a_status )

Set the status of the node.

Parameters

integer $a_status - one of ilStudyProgramme::$STATUS

Returns: $this

Definition at line 370 of file class.ilObjStudyProgramme.php.

    {
        $this->settings->setStatus($a_status);
        $this->updateLastChange();
        return $this;
    }

References settings(), and updateLastChange().

Referenced by ilObjStudyProgrammeSettingsGUI\updateWith().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSubtypeId()

ilObjStudyProgramme::setSubtypeId ( $a_subtype_id )

Sets the meta-data subtype id.

Parameters

$a_subtype_id

Returns: $this

Definition at line 405 of file class.ilObjStudyProgramme.php.

    {
        $this->settings->setSubtypeId($a_subtype_id);
        return $this;
    }

References settings().

Referenced by ilObjStudyProgrammeSettingsGUI\updateWith().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ throwIfNotInTree()

ilObjStudyProgramme::throwIfNotInTree ( )

protected

Helper function to check, weather object is in tree.

Throws ilStudyProgrammeTreeException if object is not in tree.

Definition at line 653 of file class.ilObjStudyProgramme.php.

    {
        if (!$this->tree->isInTree($this->getRefId())) {
            throw new ilStudyProgrammeTreeException("This program is not in tree.");
        }
    }

Referenced by addLeaf(), addNode(), applyToSubTreeNodes(), getChildren(), getLPChildren(), and getParent().

Here is the caller graph for this function:

◆ update()

ilObjStudyProgramme::update ( )

Update.

Reimplemented from ilContainer.

Definition at line 245 of file class.ilObjStudyProgramme.php.

    {
        parent::update();
 
        // Update selection for advanced meta data of the type
        if ($this->getSubType()) {
            ilAdvancedMDRecord::saveObjRecSelection($this->getId(), 'prg_type', $this->getSubType()->getAssignedAdvancedMDRecordIds());
        } else {
            // If no type is assigned, delete relations by passing an empty array
            ilAdvancedMDRecord::saveObjRecSelection($this->getId(), 'prg_type', array());
        }
 
        $this->updateSettings();
    }

References ilObject\getId(), getSubType(), ilAdvancedMDRecord\saveObjRecSelection(), League\Flysystem\Adapter\Polyfill\update(), and updateSettings().

Referenced by addLeaf(), updateLastChange(), and ilObjStudyProgrammeSettingsGUI\updateWith().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateAllAssignments()

ilObjStudyProgramme::updateAllAssignments ( )

Update all assignments to this program node.

Returns: $this

Definition at line 1072 of file class.ilObjStudyProgramme.php.

    {
        $assignments = ilStudyProgrammeUserAssignment::getInstancesForProgram($this->getId());
        foreach ($assignments as $ass) {
            $ass->updateFromProgram();
        }
        return $this;
    }

References ilObject\getId(), and ilStudyProgrammeUserAssignment\getInstancesForProgram().

Here is the call graph for this function:

◆ updateLastChange()

ilObjStudyProgramme::updateLastChange ( )

protected

Update last change timestamp on this node and its parents.

Definition at line 1243 of file class.ilObjStudyProgramme.php.

    {
        $this->settings->updateLastChange();
        if ($parent = $this->getParent()) {
            $parent->updateLastChange();
        }
        $this->update();
    }

References $parent, getParent(), settings(), and update().

Referenced by setPoints(), and setStatus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateSettings()

ilObjStudyProgramme::updateSettings ( )

protected

Update settings in DB.

Throws when settings are not loaded.

Definition at line 199 of file class.ilObjStudyProgramme.php.

    {
        if ($this->settings === null) {
            throw new ilException("ilObjStudyProgramme::updateSettings: no settings loaded.");
        }
        $this->settings->update();
    }

References settings().

Referenced by update().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $children

ilObjStudyProgramme::$children

protected

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

Referenced by getChildren().

◆ $ilUser

ilObjStudyProgramme::$ilUser

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

Referenced by __construct().

◆ $lp_children

ilObjStudyProgramme::$lp_children

protected

Definition at line 23 of file class.ilObjStudyProgramme.php.

Referenced by getLPChildren().

◆ $object_factory

ilObjStudyProgramme::$object_factory

Definition at line 31 of file class.ilObjStudyProgramme.php.

◆ $parent

ilObjStudyProgramme::$parent

protected

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

Referenced by getCreatableSubObjects(), getParent(), moveTo(), and updateLastChange().

◆ $settings

ilObjStudyProgramme::$settings

protected

Definition at line 20 of file class.ilObjStudyProgramme.php.

Referenced by getRawSettings().

◆ $sp_user_progress_db

ilObjStudyProgramme::$sp_user_progress_db

protected

Definition at line 38 of file class.ilObjStudyProgramme.php.

Referenced by _getStudyProgrammeUserProgressDB(), and getStudyProgrammeUserProgressDB().

◆ $study_programme_cache

ilObjStudyProgramme::$study_programme_cache = null

static

Definition at line 33 of file class.ilObjStudyProgramme.php.

◆ $tree

ilObjStudyProgramme::$tree

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

Referenced by __construct(), getParentId(), and setProgressesCompletedIfParentIsProgrammeInLPCompletedMode().

◆ $webdir

ilObjStudyProgramme::$webdir

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

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

Modules/StudyProgramme/classes/class.ilObjStudyProgramme.php

Static Public Member Functions
static	initStudyProgrammeCache ()

static	_getStudyProgrammeUserProgressDB ()
	Get an instance of ilStudyProgrammeUserProgressDB. More...

static	getInstanceByRefId ($a_ref_id)
	Get an instance of ilObjStudyProgramme, use cache. More...

static	createInstance ()
	Create an instance of ilObjStudyProgramme, put in cache. More...

static	getAllChildren ($a_ref_id)
	Get a list of all ilObjStudyProgrammes in the subtree starting at $a_ref_id. More...

static	setProgressesCompletedFor ($a_obj_id, $a_user_id)
	Set all progresses to completed where the object with given id is a leaf and that belong to the user. More...

static	getCreatableSubObjects ($a_subobjects, $a_ref_id)
	Filter the list of possible subobjects for the objects that actually could be created on a concrete node. More...

Static Public Member Functions inherited from ilContainer
static	_getContainerDirectory ($a_id)
	Get the container directory. More...

static	_lookupContainerSetting ($a_id, $a_keyword, $a_default_value=null)
	Lookup a container setting. More...

static	_writeContainerSetting ($a_id, $a_keyword, $a_value)

static	_getContainerSettings ($a_id)

static	_deleteContainerSettings ($a_id, $a_keyword=null, $a_keyword_like=false)

static	_exportContainerSettings (ilXmlWriter $a_xml, $a_obj_id)

static	getCompleteDescriptions (array $objects)
	overwrites description fields to long or short description in an assoc array keys needed (obj_id and description) More...

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupImportId ($a_obj_id)

static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

static	lookupOfflineStatus ($a_obj_id)
	Lookup offline status using objectDataCache. More...

static	_lookupOwner ($a_id)
	lookup object owner More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...

static	setDeletedDates ($a_ref_ids)
	Set deleted date. More...

static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

static	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data@access public More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...

static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...

static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...

static	fixMissingTitles ($a_type, array &$a_obj_title_map)
	Try to fix missing object titles. More...

static	_lookupCreationDate ($a_id)
	Lookup creation date. More...

static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Data Fields
	$webdir

	$tree

	$ilUser

	$object_factory

Data Fields inherited from ilContainer
const	VIEW_SESSIONS = 0

const	VIEW_OBJECTIVE = 1

const	VIEW_TIMING = 2

const	VIEW_ARCHIVE = 3

const	VIEW_SIMPLE = 4

const	VIEW_BY_TYPE = 5

const	VIEW_INHERIT = 6

const	VIEW_DEFAULT = self::VIEW_BY_TYPE

const	SORT_TITLE = 0

const	SORT_MANUAL = 1

const	SORT_ACTIVATION = 2

const	SORT_INHERIT = 3

const	SORT_CREATION = 4

const	SORT_DIRECTION_ASC = 0

const	SORT_DIRECTION_DESC = 1

const	SORT_NEW_ITEMS_POSITION_TOP = 0

const	SORT_NEW_ITEMS_POSITION_BOTTOM = 1

const	SORT_NEW_ITEMS_ORDER_TITLE = 0

const	SORT_NEW_ITEMS_ORDER_CREATION = 1

const	SORT_NEW_ITEMS_ORDER_ACTIVATION = 2

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...

const	DESC_LENGTH = 128

	$lng

	$id

	$ref_id

	$type

	$title

	$untranslatedTitle

	$desc

	$long_desc

	$owner

	$create_date

	$last_update

	$import_id

	$register = false

	$referenced

	$objectList

	$max_title

	$max_desc

	$add_dots

Protected Member Functions
	clearParentCache ()
	Clear the cached parent to query it again at the tree. More...

	clearChildrenCache ()
	Clear the cached children. More...

	clearLPChildrenCache ()
	Clear the cached lp children. More...

	readSettings ()
	Load Settings from DB. More...

	createSettings ()
	Create new settings object. More...

	updateSettings ()
	Update settings in DB. More...

	deleteSettings ()
	Delete settings from DB. More...

	deleteAssignments ()
	Delete all assignments from the DB. More...

	throwIfNotInTree ()
	Helper function to check, weather object is in tree. More...

	nodeInserted (ilObjStudyProgramme $a_prg)
	Clears child chache and adds progress for new node. More...

	updateLastChange ()
	Update last change timestamp on this node and its parents. More...

	getIdsFromNodesOnPathFromRootToHere ()
	Get the ids from the nodes in the path leading from the root node of this program to this node, including the id of this node. More...

	getAssignmentsRaw ()
	Get model objects for the assignments on this programm. More...

Static Protected Member Functions
static	setProgressesCompletedIfParentIsProgrammeInLPCompletedMode ($a_ref_id, $a_obj_id, $a_user_id)

static	getParentId (ilObject $a_object)
	Get the obj id of the parent object for the given object. More...

Protected Attributes
	$settings

	$parent

	$children

	$lp_children

	$sp_user_progress_db

Protected Attributes inherited from ilContainer
	$db

	$log

	$access

	$error

	$rbacsystem

	$tree

	$user

	$obj_definition

	$order_type = 0

	$hiddenfilesfound = false

	$news_timeline = false

	$news_timeline_auto_entries = false

	$setting

	$obj_trans = null

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Static Public Attributes
static	$study_programme_cache = null

Static Public Attributes inherited from ilContainer
static	$data_preloaded = false

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getStudyProgrammeUserProgressDB()

◆ addLeaf()

◆ addMissingProgresses()

◆ addNode()

◆ adjustLPMode()

◆ applyToSubTreeNodes()

◆ assignUser()

◆ canBeRemoved()

◆ clearChildrenCache()

◆ clearLPChildrenCache()

◆ clearParentCache()

◆ create()

◆ createInstance()

◆ createProgressForAssignment()

◆ createSettings()

◆ delete()

◆ deleteAssignments()

◆ deleteSettings()

◆ getAllChildren()

◆ getAmountOfAssignmentsOf()

◆ getAmountOfChildren()

◆ getAmountOfLPChildren()

◆ getAssignments()

◆ getAssignmentsOf()

◆ getAssignmentsRaw()

◆ getChildren()

◆ getCompletedCourses()

◆ getCreatableSubObjects()

◆ getDepth()

◆ getIdsFromNodesOnPathFromRootToHere()

◆ getIdsOfUsersWithCompletedProgress()

◆ getIdsOfUsersWithFailedProgress()

◆ getIdsOfUsersWithNotCompletedAndRelevantProgress()

◆ getIdsOfUsersWithRelevantProgress()

◆ getInstanceByRefId()

◆ getLastChange()

◆ getLPChildren()

◆ getLPChildrenIds()

◆ getLPMode()

◆ getParent()

◆ getParentId()

◆ getParents()

◆ getPoints()

◆ getProgresses()

◆ getProgressesOf()

◆ getProgressForAssignment()

◆ getRawSettings()

◆ getRoot()

◆ getStatus()

◆ getStudyProgrammeUserProgressDB()

◆ getSubType()

◆ getSubtypeId()

◆ hasAssignmentOf()

◆ hasAssignments()

◆ hasChildren()

◆ hasLPChildren()

◆ hasProgresses()

◆ hasRelevantProgresses()

◆ initStudyProgrammeCache()

◆ isActive()

◆ moveTo()

◆ nodeInserted()

◆ putInTree()

◆ read()

◆ readSettings()

◆ removeAssignment()

◆ removeLeaf()

◆ removeNode()

◆ setPoints()