Tries to enumerate all preconditions for the given objective, where the ones that can be achieved (i.e. More...

Inheritance diagram for ILIAS\Setup\ObjectiveIterator:

Collaboration diagram for ILIAS\Setup\ObjectiveIterator:

Public Member Functions
	__construct (Environment $environment, Objective $objective)

	setEnvironment (Environment $environment)

	markAsFailed (Objective $objective)

	rewind ()

	current ()

	key ()

	next ()

	valid ()

Protected Member Functions
	detectDependencyCycles (string $cur, string $next)

	setReverseDependency (string $other, string $cur)

Protected Attributes
Environment	$environment

Objective	$objective

array	$stack

Objective	$current = null

array	$returned

array	$failed

array	$reverse_dependencies

Detailed Description

Tries to enumerate all preconditions for the given objective, where the ones that can be achieved (i.e.

have no further preconditions on their own) will be returned first. Will also attempt to only return every objective once. This thus expects, that returned objectives will be achieved somehow. <string, Objective>

Definition at line 30 of file ObjectiveIterator.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Setup\ObjectiveIterator::__construct	(	Environment	$environment,
		Objective	$objective
	)

Definition at line 58 of file ObjectiveIterator.php.

    {
        $this->environment = $environment;
        $this->objective = $objective;
        $this->rewind();
    }

References ILIAS\Setup\ObjectiveIterator\$environment, ILIAS\Setup\ObjectiveIterator\$objective, ILIAS\UI\examples\Table\Presentation\environment(), and ILIAS\Setup\ObjectiveIterator\rewind().

Here is the call graph for this function:

Member Function Documentation

◆ current()

ILIAS\Setup\ObjectiveIterator::current ( )

Definition at line 91 of file ObjectiveIterator.php.

                             : \ILIAS\Setup\Objective
    {
        if ($this->current === null) {
            throw new \LogicException(
                "Iterator is finished or wasn't initialized correctly internally."
            );
        }
        return $this->current;
    }

References ILIAS\Setup\ObjectiveIterator\$current, and ILIAS\Setup\ObjectiveIterator\current().

Referenced by ILIAS\Setup\ObjectiveIterator\current(), ILIAS\Setup\ObjectiveIterator\key(), ILIAS\Setup\ObjectiveIterator\next(), ILIAS\Setup\ObjectiveIterator\rewind(), and ILIAS\Setup\ObjectiveIterator\valid().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ detectDependencyCycles()

ILIAS\Setup\ObjectiveIterator::detectDependencyCycles	(	string	$cur,
		string	$next
	)

protected

Definition at line 177 of file ObjectiveIterator.php.

                                                                        : void
    {
        if (!isset($this->reverse_dependencies[$next])) {
            return;
        }
        if (in_array($cur, $this->reverse_dependencies[$next])) {
            throw new UnachievableException(
                "The objectives contain a dependency cycle and won't all be achievable."
            );
        }
        foreach ($this->reverse_dependencies[$next] as $d) {
            $this->detectDependencyCycles($cur, $d);
        }
    }

References Vendor\Package\$d, and ILIAS\Setup\ObjectiveIterator\detectDependencyCycles().

Referenced by ILIAS\Setup\ObjectiveIterator\detectDependencyCycles(), and ILIAS\Setup\ObjectiveIterator\next().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ key()

ILIAS\Setup\ObjectiveIterator::key ( )

Definition at line 101 of file ObjectiveIterator.php.

                         : string
    {
        return $this->current()->getHash();
    }

References ILIAS\Setup\ObjectiveIterator\current().

Here is the call graph for this function:

◆ markAsFailed()

ILIAS\Setup\ObjectiveIterator::markAsFailed ( Objective $objective )

Definition at line 70 of file ObjectiveIterator.php.

                                                      : void
    {
        if (!isset($this->returned[$objective->getHash()])) {
            throw new \LogicException(
                "You may only mark objectives as failed that have been returned by this iterator."
            );
        }
 
        $this->failed[$objective->getHash()] = true;
    }

References ILIAS\Setup\ObjectiveIterator\$objective, and ILIAS\Setup\Objective\getHash().

Referenced by ILIAS\Setup\ObjectiveIterator\next().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ next()

ILIAS\Setup\ObjectiveIterator::next ( )

Definition at line 106 of file ObjectiveIterator.php.

                          : void
    {
        if ($this->stack === []) {
            $this->current = null;
            return;
        }
 
        $cur = array_pop($this->stack);
        $hash = $cur->getHash();
 
        if (isset($this->returned[$hash]) || isset($this->failed[$hash])) {
            $this->next();
            return;
        }
 
        $preconditions = [];
        $failed_preconditions = [];
        foreach ($cur->getPreconditions($this->environment) as $p) {
            $h = $p->getHash();
            if (!isset($this->returned[$h]) || isset($this->failed[$h])) {
                $preconditions[] = $p;
            }
 
            if (isset($this->failed[$h])) {
                $failed_preconditions[] = $p;
            }
        }
 
        // We only have preconditions left that we know to have failed.
        if (
            $preconditions !== [] &&
            count($preconditions) === count($failed_preconditions)
        ) {
            $this->returned[$hash] = true;
            $this->markAsFailed($cur);
            if ($this->stack === []) {
                // Since the current objective doesn't need to be achieved,
                // we are fine and can simply stop here.
                if ($cur instanceof Objective\Tentatively) {
                    return;
                }
                throw new UnachievableException(
                    "Objective '" . $cur->getLabel() . "' had failed preconditions:\n  - " .
                    implode("\n  - ", array_map(fn ($o) => $o->getLabel(), $failed_preconditions))
                );
            }
            $this->next();
            return;
        }
 
        // No preconditions open, we can proceed with the objective.
        if ($preconditions === []) {
            $this->returned[$hash] = true;
            $this->current = $cur;
            return;
        }
 
        $this->stack[] = $cur;
        $this->detectDependencyCycles($hash, $hash);
        foreach (array_reverse($preconditions) as $p) {
            $this->stack[] = $p;
            $this->setReverseDependency($p->getHash(), $hash);
        }
        $this->next();
    }

References ILIAS\Setup\ObjectiveIterator\current(), ILIAS\Setup\ObjectiveIterator\detectDependencyCycles(), ILIAS\Setup\ObjectiveIterator\markAsFailed(), ILIAS\Setup\ObjectiveIterator\next(), and ILIAS\Setup\ObjectiveIterator\setReverseDependency().

Referenced by ILIAS\Setup\ObjectiveIterator\next(), and ILIAS\Setup\ObjectiveIterator\rewind().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rewind()

ILIAS\Setup\ObjectiveIterator::rewind ( )

Definition at line 81 of file ObjectiveIterator.php.

                            : void
    {
        $this->stack = [$this->objective];
        $this->current = null;
        $this->returned = [];
        $this->failed = [];
        $this->reverse_dependencies = [];
        $this->next();
    }

References ILIAS\Setup\ObjectiveIterator\$objective, ILIAS\Setup\ObjectiveIterator\current(), and ILIAS\Setup\ObjectiveIterator\next().

Referenced by ILIAS\Setup\ObjectiveIterator\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setEnvironment()

ILIAS\Setup\ObjectiveIterator::setEnvironment ( Environment $environment )

Definition at line 65 of file ObjectiveIterator.php.

                                                            : void
    {
        $this->environment = $environment;
    }

References ILIAS\Setup\ObjectiveIterator\$environment, and ILIAS\UI\examples\Table\Presentation\environment().

Here is the call graph for this function:

◆ setReverseDependency()

ILIAS\Setup\ObjectiveIterator::setReverseDependency	(	string	$other,
		string	$cur
	)

protected

Definition at line 192 of file ObjectiveIterator.php.

                                                                       : void
    {
        if (!isset($this->reverse_dependencies[$other])) {
            $this->reverse_dependencies[$other] = [];
        }
        $this->reverse_dependencies[$other][] = $cur;
    }

Referenced by ILIAS\Setup\ObjectiveIterator\next().

Here is the caller graph for this function:

◆ valid()

ILIAS\Setup\ObjectiveIterator::valid ( )

Definition at line 172 of file ObjectiveIterator.php.

                           : bool
    {
        return $this->current !== null;
    }

References ILIAS\Setup\ObjectiveIterator\current().

Here is the call graph for this function:

Field Documentation

◆ $current

Objective ILIAS\Setup\ObjectiveIterator::$current = null

protected

Definition at line 40 of file ObjectiveIterator.php.

Referenced by ILIAS\Setup\ObjectiveIterator\current().

◆ $environment

Environment ILIAS\Setup\ObjectiveIterator::$environment

protected

Definition at line 32 of file ObjectiveIterator.php.

Referenced by ILIAS\Setup\ObjectiveIterator\__construct(), ILIAS\UI\Implementation\Component\Table\Presentation\getEnvironment(), ILIAS\Setup\ObjectiveIterator\setEnvironment(), and ILIAS\UI\Implementation\Component\Table\Presentation\withEnvironment().

◆ $failed

array ILIAS\Setup\ObjectiveIterator::$failed

protected

Definition at line 50 of file ObjectiveIterator.php.

◆ $objective

Objective ILIAS\Setup\ObjectiveIterator::$objective

protected

Definition at line 33 of file ObjectiveIterator.php.

Referenced by ILIAS\Setup\ObjectiveIterator\__construct(), ILIAS\Setup\ObjectiveIterator\markAsFailed(), and ILIAS\Setup\ObjectiveIterator\rewind().

◆ $returned

array ILIAS\Setup\ObjectiveIterator::$returned

protected

Definition at line 45 of file ObjectiveIterator.php.

◆ $reverse_dependencies

array ILIAS\Setup\ObjectiveIterator::$reverse_dependencies

protected

Definition at line 55 of file ObjectiveIterator.php.

◆ $stack

array ILIAS\Setup\ObjectiveIterator::$stack

protected

Definition at line 38 of file ObjectiveIterator.php.

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

components/ILIAS/Setup/src/ObjectiveIterator.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ current()

◆ detectDependencyCycles()

◆ key()

◆ markAsFailed()

◆ next()

◆ rewind()

◆ setEnvironment()

◆ setReverseDependency()

◆ valid()

Field Documentation

◆ $current

◆ $environment

◆ $failed

◆ $objective

◆ $returned

◆ $reverse_dependencies

◆ $stack