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
	$objective
	$stack
	$current
	$returned
	$failed
	$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 13 of file ObjectiveIterator.php.

Constructor & Destructor Documentation

__construct()

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

Definition at line 51 of file ObjectiveIterator.php.

References ILIAS\Setup\ObjectiveIterator\$environment, ILIAS\Setup\ObjectiveIterator\$objective, 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 84 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().

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

References $d.

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

    {
        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 94 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 63 of file ObjectiveIterator.php.

References ILIAS\Setup\Objective\getHash().

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

    {
        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 99 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().

    {
        if (count($this->stack) === 0) {
            $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 (
            count($preconditions) !== 0 &&
            count($preconditions) === count($failed_preconditions)
        ) {
            $this->returned[$hash] = true;
            $this->markAsFailed($cur);
            if (count($this->stack) === 0) {
                throw new UnachievableException(
                    "Objective '" . $cur->getLabel() . "' had failed preconditions:\n  - " .
                    implode("\n  - ", array_map(function ($o) {
                        return $o->getLabel();
                    }, $failed_preconditions))
                );
            }
            $this->next();
            return;
        }

        // No preconditions open, we can proceed with the objective.
        if (count($preconditions) === 0) {
            $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 74 of file ObjectiveIterator.php.

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

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

    {
        $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 58 of file ObjectiveIterator.php.

References ILIAS\Setup\ObjectiveIterator\$environment, and 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 182 of file ObjectiveIterator.php.

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

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

References ILIAS\Setup\ObjectiveIterator\current().

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

Here is the call graph for this function:

Field Documentation

$current

ILIAS\Setup\ObjectiveIterator::$current

protected

Definition at line 33 of file ObjectiveIterator.php.

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

$environment

ILIAS\Setup\ObjectiveIterator::$environment

protected

Definition at line 18 of file ObjectiveIterator.php.

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

$failed

ILIAS\Setup\ObjectiveIterator::$failed

protected

Definition at line 43 of file ObjectiveIterator.php.

$objective

ILIAS\Setup\ObjectiveIterator::$objective

protected

Definition at line 23 of file ObjectiveIterator.php.

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

$returned

ILIAS\Setup\ObjectiveIterator::$returned

protected

Definition at line 38 of file ObjectiveIterator.php.

$reverse_dependencies

ILIAS\Setup\ObjectiveIterator::$reverse_dependencies

protected

Definition at line 48 of file ObjectiveIterator.php.

$stack

ILIAS\Setup\ObjectiveIterator::$stack

protected

Definition at line 28 of file ObjectiveIterator.php.

---

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

• src/Setup/ObjectiveIterator.php