ILIAS\StudyProgramme\Assignment\Node Class Reference

Inheritance diagram for ILIAS\StudyProgramme\Assignment\Node:

Collaboration diagram for ILIAS\StudyProgramme\Assignment\Node:

Public Member Functions
	__construct ($id)
	setSubnodes (array $subnodes)
	withContainer (Node $node)
	this is only used internally - do not use apart from constructing the tree! More...
	withSubnode ($node)
	getSubnodes ()
	getSubnode (string $id)
	getPath ()
	findSubnodePath (string $id, ?Node $node=null)
	getId ()

Protected Member Functions
	getContainer ()

Protected Attributes
array	$subnodes = []
Node	$container = null
string	$id
int	$current_points = 0

Detailed Description

Definition at line 23 of file Node.php.

Constructor & Destructor Documentation

__construct()

ILIAS\StudyProgramme\Assignment\Node::__construct

(

$id

)

Definition at line 32 of file Node.php.

References ILIAS\StudyProgramme\Assignment\Node\$id.

    {
        $this->id = $id;
    }

Member Function Documentation

findSubnodePath()

ILIAS\StudyProgramme\Assignment\Node::findSubnodePath	(	string	$id,
		?Node	$node = null
	)

Definition at line 89 of file Node.php.

References ILIAS\StudyProgramme\Assignment\Node\$id, and null.

                                                                   : ?array
    {
        if (!$node) {
            $node = $this;
        }
        if ($node->getId() == $id) {
            return $node->getPath();
        }
        foreach ($node->getSubnodes() as $subnode) {
            $result = $this->findSubnodePath($id, $subnode);
            if ($result) {
                return $result;
            }
        }

        return null;
    }

getContainer()

ILIAS\StudyProgramme\Assignment\Node::getContainer ( )

protected

Definition at line 57 of file Node.php.

References ILIAS\StudyProgramme\Assignment\Node\$container.

                                     : ?Node
    {
        return $this->container;
    }

getId()

ILIAS\StudyProgramme\Assignment\Node::getId

(

)

Definition at line 107 of file Node.php.

References ILIAS\StudyProgramme\Assignment\Node\$id.

Referenced by ilStudyProgrammeProgressListGUI\buildProgressBar(), ILIAS\StudyProgramme\Assignment\Node\getPath(), ilStudyProgrammeProgressListGUI\getTitleAndIconTarget(), and ilPRGProgress\withStatus().

                           : string
    {
        return $this->id;
    }

Here is the caller graph for this function:

getPath()

ILIAS\StudyProgramme\Assignment\Node::getPath

(

)

Definition at line 79 of file Node.php.

References ILIAS\StudyProgramme\Assignment\Node\getId().

Referenced by invalidate(), and markProgressesFailedForExpiredDeadline().

                             : array
    {
        $ret = [$this->getId()];
        $node = $this;
        while ($node = $node->getContainer()) {
            $ret[] = $node->getId();
        }
        return array_reverse($ret);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSubnode()

ILIAS\StudyProgramme\Assignment\Node::getSubnode

(

string

$id

)

Definition at line 74 of file Node.php.

References ILIAS\StudyProgramme\Assignment\Node\$id.

                                          : ?Node
    {
        return $this->subnodes[$id];
    }

getSubnodes()

ILIAS\StudyProgramme\Assignment\Node::getSubnodes

(

)

Definition at line 69 of file Node.php.

Referenced by ilStudyProgrammeUserTable\completionByToCollection(), ilPRGProgress\getAchievedPointsOfChildren(), and ilPRGProgress\getPossiblePointsOfRelevantChildren().

                                 : array
    {
        return array_values($this->subnodes);
    }

Here is the caller graph for this function:

setSubnodes()

ILIAS\StudyProgramme\Assignment\Node::setSubnodes

(

array

$subnodes

)

Definition at line 37 of file Node.php.

    {
        if ($this->subnodes !== []) {
            throw new \Exception("Use 'setSubnodes' during construction only", 1);
        }
        foreach ($subnodes as $subnode) {
            $this->subnodes[$subnode->getId()] = $subnode->withContainer($this);
        }
        return $this;
    }

withContainer()

ILIAS\StudyProgramme\Assignment\Node::withContainer

(

Node

$node

)

this is only used internally - do not use apart from constructing the tree!

Definition at line 51 of file Node.php.

                                             : self
    {
        $this->container = $node;
        return $this;
    }

withSubnode()

ILIAS\StudyProgramme\Assignment\Node::withSubnode

(

$node

)

Definition at line 62 of file Node.php.

    {
        $clone = clone $this;
        $clone->subnodes[$node->getId()] = $node->withContainer($this);
        return $clone;
    }

Field Documentation

$container

Node ILIAS\StudyProgramme\Assignment\Node::$container = null

protected

Definition at line 26 of file Node.php.

Referenced by ILIAS\StudyProgramme\Assignment\Node\getContainer().

$current_points

int ILIAS\StudyProgramme\Assignment\Node::$current_points = 0

protected

Definition at line 30 of file Node.php.

$id

string ILIAS\StudyProgramme\Assignment\Node::$id

protected

Definition at line 27 of file Node.php.

Referenced by ILIAS\StudyProgramme\Assignment\Node\__construct(), ILIAS\StudyProgramme\Assignment\Node\findSubnodePath(), ILIAS\StudyProgramme\Assignment\Node\getId(), and ILIAS\StudyProgramme\Assignment\Node\getSubnode().

$subnodes

array ILIAS\StudyProgramme\Assignment\Node::$subnodes = []

protected

Definition at line 25 of file Node.php.

Referenced by ilStudyProgrammeProgressTreeTest\build().

---

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

• components/ILIAS/StudyProgramme/classes/model/Assignments/Node.php