ILIAS\Setup\Objective\NullObjective Class Reference

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

Inheritance diagram for ILIAS\Setup\Objective\NullObjective:

Collaboration diagram for ILIAS\Setup\Objective\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 (Setup\Environment $environment)
	achieve (Setup\Environment $environment)
	isApplicable (Setup\Environment $environment)
Public Member Functions inherited from ILIAS\Setup\Objective
	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...

Data Fields
const	LABEL = "Nothing to do."

Detailed Description

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

Definition at line 28 of file NullObjective.php.

Member Function Documentation

achieve()

ILIAS\Setup\Objective\NullObjective::achieve

(

Setup\Environment

$environment

)

Definition at line 58 of file NullObjective.php.

                                                           : Setup\Environment
    {
        return $environment;
    }

getHash()

ILIAS\Setup\Objective\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 32 of file NullObjective.php.

                             : string
    {
        return "null-objective";
    }

getLabel()

ILIAS\Setup\Objective\NullObjective::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

Definition at line 37 of file NullObjective.php.

                              : string
    {
        return self::LABEL;
    }

getPreconditions()

ILIAS\Setup\Objective\NullObjective::getPreconditions

(

Setup\Environment

$environment

)

Definition at line 50 of file NullObjective.php.

                                                                    : array
    {
        return [];
    }

isApplicable()

ILIAS\Setup\Objective\NullObjective::isApplicable

(

Setup\Environment

$environment

)

Definition at line 66 of file NullObjective.php.

                                                                : bool
    {
        return false;
    }

isNotable()

ILIAS\Setup\Objective\NullObjective::isNotable

(

)

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

Implements ILIAS\Setup\Objective.

Definition at line 42 of file NullObjective.php.

                               : bool
    {
        return false;
    }

Field Documentation

LABEL

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

Definition at line 30 of file NullObjective.php.

---

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

• components/ILIAS/Setup/src/Objective/NullObjective.php