ILIAS\Setup\NullObjective Class Reference

A non-objective, nothing to do to achieve it... More...

Inheritance diagram for ILIAS\Setup\NullObjective:

Collaboration diagram for ILIAS\Setup\NullObjective:

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)
	@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...

Data Fields
const	LABEL = "Nothing to do."

Detailed Description

A non-objective, nothing to do to achieve it...

Definition at line 12 of file NullObjective.php.

Member Function Documentation

achieve()

ILIAS\Setup\NullObjective::achieve

(

Environment

$environment

)

@inheritdocs

Implements ILIAS\Setup\Objective.

Definition at line 42 of file NullObjective.php.

                                                      : Environment
    {
        return $environment;
    }

getHash()

ILIAS\Setup\NullObjective::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.

Implements ILIAS\Setup\Objective.

Definition at line 16 of file NullObjective.php.

                              : string
    {
        return "null-objective";
    }

getLabel()

ILIAS\Setup\NullObjective::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

Definition at line 21 of file NullObjective.php.

                               : string
    {
        return self::LABEL;
    }

References ILIAS\Setup\NullObjective\LABEL.

getPreconditions()

ILIAS\Setup\NullObjective::getPreconditions

(

Environment

$environment

)

Objectives might depend on other objectives.

Exceptions

UnachievableException

if the objective is not achievable

Returns

Objective[]

Implements ILIAS\Setup\Objective.

Definition at line 34 of file NullObjective.php.

                                                               : array
    {
        return [];
    }

Referenced by ilDatabaseUpdateStepsTest\testGetStep2WithAdditionalPrecondition().

Here is the caller graph for this function:

isNotable()

ILIAS\Setup\NullObjective::isNotable

(

)

Get to know if this is an interesting objective for a human.

Implements ILIAS\Setup\Objective.

Definition at line 26 of file NullObjective.php.

                                : bool
    {
        return false;
    }

Field Documentation

LABEL

const ILIAS\Setup\NullObjective::LABEL = "Nothing to do."

Definition at line 14 of file NullObjective.php.

Referenced by ILIAS\Setup\NullObjective\getLabel().

---

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

• src/Setup/NullObjective.php