ILIAS\Setup\Objective\ObjectiveWithPreconditions Class Reference

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

Inheritance diagram for ILIAS\Setup\Objective\ObjectiveWithPreconditions:

Collaboration diagram for ILIAS\Setup\Objective\ObjectiveWithPreconditions:

Public Member Functions
	__construct (Setup\Objective $original, Setup\Objective ... $preconditions)
	getHash ()
	@inheritdocs More...
	getLabel ()
	@inheritdocs More...
	isNotable ()
	@inheritdocs More...
	getPreconditions (Setup\Environment $environment)
	@inheritdocs More...
	achieve (Setup\Environment $environment)
	@inheritdocs More...
	isApplicable (Setup\Environment $environment)
	@inheritDoc More...
Public Member Functions inherited from ILIAS\Setup\Objective
	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...
	isApplicable (Environment $environment)
	Get to know whether the objective is applicable. More...

Protected Attributes
Setup Objective	$original
array	$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 31 of file ObjectiveWithPreconditions.php.

Constructor & Destructor Documentation

__construct()

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

Definition at line 40 of file ObjectiveWithPreconditions.php.

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

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

Member Function Documentation

achieve()

ILIAS\Setup\Objective\ObjectiveWithPreconditions::achieve

(

Setup\Environment

$environment

)

@inheritdocs

Definition at line 97 of file ObjectiveWithPreconditions.php.

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

getHash()

ILIAS\Setup\Objective\ObjectiveWithPreconditions::getHash

(

)

@inheritdocs

Implements ILIAS\Setup\Objective.

Definition at line 54 of file ObjectiveWithPreconditions.php.

                             : string
    {
        return hash(
            "sha256",
            self::class
            . $this->original->getHash()
            . implode(
                "",
                array_map(
                    fn ($o) => $o->getHash(),
                    $this->preconditions
                )
            )
        );
    }

getLabel()

ILIAS\Setup\Objective\ObjectiveWithPreconditions::getLabel

(

)

@inheritdocs

Implements ILIAS\Setup\Objective.

Definition at line 73 of file ObjectiveWithPreconditions.php.

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

getPreconditions()

ILIAS\Setup\Objective\ObjectiveWithPreconditions::getPreconditions

(

Setup\Environment

$environment

)

@inheritdocs

Definition at line 89 of file ObjectiveWithPreconditions.php.

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

isApplicable()

ILIAS\Setup\Objective\ObjectiveWithPreconditions::isApplicable

(

Setup\Environment

$environment

)

@inheritDoc

Definition at line 105 of file ObjectiveWithPreconditions.php.

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

isNotable()

ILIAS\Setup\Objective\ObjectiveWithPreconditions::isNotable

(

)

@inheritdocs

Implements ILIAS\Setup\Objective.

Definition at line 81 of file ObjectiveWithPreconditions.php.

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

Field Documentation

$original

Setup Objective ILIAS\Setup\Objective\ObjectiveWithPreconditions::$original

protected

Definition at line 33 of file ObjectiveWithPreconditions.php.

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

$preconditions

array ILIAS\Setup\Objective\ObjectiveWithPreconditions::$preconditions

protected

Definition at line 38 of file ObjectiveWithPreconditions.php.

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

---

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

• src/Setup/Objective/ObjectiveWithPreconditions.php