An objective is a desired state of the system that is supposed to be created by the setup. More...

Inheritance diagram for ILIAS\Setup\Objective:

Collaboration diagram for ILIAS\Setup\Objective:

Public Member Functions
	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...

Detailed Description

An objective is a desired state of the system that is supposed to be created by the setup.

This interface would benefit from generics, in fact it would be parametrized with a Config-type.

Definition at line 14 of file Objective.php.

Member Function Documentation

◆ achieve()

ILIAS\Setup\Objective::achieve ( Environment $environment )

Objectives can be achieved.

They might add resources to the environment when they have been achieved.

This method needs to be idempotent for a given environment. That means: if this is executed a second time, nothing new should happen. Or the other way round: if the environment already looks like desired, the objective should not take any further actions when this is called.

Exceptions

Implemented in ilDatabaseUpdateSteps, ILIAS\Setup\ObjectiveCollection, ILIAS\Setup\BuildArtifactObjective, ILIAS\Setup\CallableObjective, ILIAS\Setup\DirectoryCreatedObjective, ILIAS\Setup\ExternalConditionObjective, ilStyleReplaceResponsiveLogoObjective, ILIAS\Setup\ObjectiveWithPreconditions, ILIAS\Setup\AdminConfirmedObjective, and ILIAS\Setup\NullObjective.

◆ getHash()

ILIAS\Setup\Objective::getHash ( )

Get a hash for this objective.

The hash of two objectives must be the same, if they are the same objective, with the same config on the same environment, i.e. if the one is achieved the other is achieved as well because they are the same.

Implemented in ilDatabaseUpdateSteps, ilDatabaseUpdateStep, ILIAS\Setup\BuildArtifactObjective, ilStyleReplaceResponsiveLogoObjective, ILIAS\Setup\CallableObjective, ILIAS\Setup\ObjectiveCollection, ILIAS\Setup\ExternalConditionObjective, ILIAS\Setup\DirectoryCreatedObjective, ILIAS\Setup\ObjectiveWithPreconditions, ILIAS\Setup\AdminConfirmedObjective, and ILIAS\Setup\NullObjective.