ILIAS\Setup\ObjectiveWithPreconditions Class Reference

A wrapper around an objective that adds some preconditions. More...

Inheritance diagram for ILIAS\Setup\ObjectiveWithPreconditions:

Collaboration diagram for ILIAS\Setup\ObjectiveWithPreconditions:

Public Member Functions
	__construct (Objective $original, Objective ... $preconditions)
	getHash ()
	@inheritdocs More...
	getLabel ()
	@inheritdocs More...
	isNotable ()
	@inheritdocs More...
	getPreconditions (Environment $environment)
	@inheritdocs More...
	achieve (Environment $environment)
	@inheritdocs More...
	getHash ()
	Get a hash for this objective. More...
	getLabel ()
	Get a label that describes this objective. More...
	isNotable ()
	Get to know if this is an interesting objective for a human. More...
	getPreconditions (Environment $environment)
	Objectives might depend on other objectives. More...
	achieve (Environment $environment)
	Objectives can be achieved. More...

Protected Attributes
	$original
	$preconditions

Detailed Description

A wrapper around an objective that adds some preconditions.

ATTENTION: This will use the same hash then the original objective and will therefore be indistinguishable.

Definition at line 15 of file ObjectiveWithPreconditions.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Setup\ObjectiveWithPreconditions::__construct	(	Objective	$original,
		Objective ...	$preconditions
	)

Definition at line 27 of file ObjectiveWithPreconditions.php.

    {
        if (count($preconditions) === 0) {
            throw new \InvalidArgumentException(
                "Expected at least one precondition."
            );
        }
        $this->original = $original;
        $this->preconditions = $preconditions;
    }

References ILIAS\Setup\ObjectiveWithPreconditions\$original, and ILIAS\Setup\ObjectiveWithPreconditions\$preconditions.

Member Function Documentation

achieve()

ILIAS\Setup\ObjectiveWithPreconditions::achieve

(

Environment

$environment

)

@inheritdocs

Implements ILIAS\Setup\Objective.

Definition at line 73 of file ObjectiveWithPreconditions.php.

                                                      : Environment
    {
        return $this->original->achieve($environment);
    }

getHash()

ILIAS\Setup\ObjectiveWithPreconditions::getHash

(

)

@inheritdocs

Implements ILIAS\Setup\Objective.

Definition at line 41 of file ObjectiveWithPreconditions.php.

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

getLabel()

ILIAS\Setup\ObjectiveWithPreconditions::getLabel

(

)

@inheritdocs

Implements ILIAS\Setup\Objective.

Definition at line 49 of file ObjectiveWithPreconditions.php.

                               : string
    {
        return $this->original->getLabel();
    }

getPreconditions()

ILIAS\Setup\ObjectiveWithPreconditions::getPreconditions

(

Environment

$environment

)

@inheritdocs

Implements ILIAS\Setup\Objective.

Definition at line 65 of file ObjectiveWithPreconditions.php.

                                                               : array
    {
        return array_merge($this->preconditions, $this->original->getPreconditions($environment));
    }

isNotable()

ILIAS\Setup\ObjectiveWithPreconditions::isNotable

(

)

@inheritdocs

Implements ILIAS\Setup\Objective.

Definition at line 57 of file ObjectiveWithPreconditions.php.

                                : bool
    {
        return $this->original->isNotable();
    }

Field Documentation

$original

ILIAS\Setup\ObjectiveWithPreconditions::$original

protected

Definition at line 20 of file ObjectiveWithPreconditions.php.

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

$preconditions

ILIAS\Setup\ObjectiveWithPreconditions::$preconditions

protected

Definition at line 25 of file ObjectiveWithPreconditions.php.

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

---

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

• src/Setup/ObjectiveWithPreconditions.php