ILIAS\Setup\ObjectiveIterator Class Reference

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.

Definition at line 29 of file ObjectiveIterator.php.

Constructor & Destructor Documentation

__construct()

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

Definition at line 57 of file ObjectiveIterator.php.

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

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

Here is the call graph for this function:

Member Function Documentation

current()

ILIAS\Setup\ObjectiveIterator::current

(

)

Definition at line 90 of file ObjectiveIterator.php.

References ILIAS\Setup\ObjectiveIterator\$current.

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

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

Here is the caller graph for this function:

detectDependencyCycles()

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

protected

Definition at line 176 of file ObjectiveIterator.php.

References $d.

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

                                                                        : 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);
        }
    }

Here is the caller graph for this function:

key()

ILIAS\Setup\ObjectiveIterator::key

(

)

Definition at line 100 of file ObjectiveIterator.php.

References ILIAS\Setup\ObjectiveIterator\current().

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

Here is the call graph for this function:

markAsFailed()

ILIAS\Setup\ObjectiveIterator::markAsFailed

(

Objective

$objective

)

Definition at line 69 of file ObjectiveIterator.php.

References ILIAS\Setup\Objective\getHash().

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

                                                      : 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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

next()

ILIAS\Setup\ObjectiveIterator::next

(

)

Definition at line 105 of file ObjectiveIterator.php.

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

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

                          : 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();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

rewind()

ILIAS\Setup\ObjectiveIterator::rewind

(

)

Definition at line 80 of file ObjectiveIterator.php.

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

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

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

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 64 of file ObjectiveIterator.php.

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

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

Here is the call graph for this function:

setReverseDependency()

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

protected

Definition at line 191 of file ObjectiveIterator.php.

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

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

Here is the caller graph for this function:

valid()

ILIAS\Setup\ObjectiveIterator::valid

(

)

Definition at line 171 of file ObjectiveIterator.php.

References ILIAS\Setup\ObjectiveIterator\current().

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

Here is the call graph for this function:

Field Documentation

$current

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

protected

Definition at line 39 of file ObjectiveIterator.php.

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

$environment

Environment ILIAS\Setup\ObjectiveIterator::$environment

protected

Definition at line 31 of file ObjectiveIterator.php.

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

$failed

array ILIAS\Setup\ObjectiveIterator::$failed

protected

Definition at line 49 of file ObjectiveIterator.php.

$objective

Objective ILIAS\Setup\ObjectiveIterator::$objective

protected

Definition at line 32 of file ObjectiveIterator.php.

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

$returned

array ILIAS\Setup\ObjectiveIterator::$returned

protected

Definition at line 44 of file ObjectiveIterator.php.

$reverse_dependencies

array ILIAS\Setup\ObjectiveIterator::$reverse_dependencies

protected

Definition at line 54 of file ObjectiveIterator.php.

$stack

array ILIAS\Setup\ObjectiveIterator::$stack

protected

Definition at line 37 of file ObjectiveIterator.php.

---

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

• src/Setup/ObjectiveIterator.php