ILIAS\Setup\Objective\CalledFromRootObjective Class Reference

Verify that the setip is called from ILIAS root directory. More...

Inheritance diagram for ILIAS\Setup\Objective\CalledFromRootObjective:

Collaboration diagram for ILIAS\Setup\Objective\CalledFromRootObjective:

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

Detailed Description

Verify that the setip is called from ILIAS root directory.

Definition at line 28 of file CalledFromRootObjective.php.

Member Function Documentation

achieve()

ILIAS\Setup\Objective\CalledFromRootObjective::achieve

(

Setup\Environment

$environment

)

Definition at line 50 of file CalledFromRootObjective.php.

                                                           : Setup\Environment
    {
        $ilroot = dirname(__DIR__, 5);
        if (getcwd() !== $ilroot) {
            $msg = "Please run the setup from ILIAS root - "
                . "there are components using relative pathes.";
            throw new Setup\UnachievableException($msg);
        }
        return $environment;
    }

getHash()

ILIAS\Setup\Objective\CalledFromRootObjective::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 30 of file CalledFromRootObjective.php.

                             : string
    {
        return hash("sha256", self::class);
    }

getLabel()

ILIAS\Setup\Objective\CalledFromRootObjective::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

Definition at line 35 of file CalledFromRootObjective.php.

                              : string
    {
        return "Verify that the setup is called from ilias' root-directory.";
    }

getPreconditions()

ILIAS\Setup\Objective\CalledFromRootObjective::getPreconditions

(

Setup\Environment

$environment

)

Definition at line 45 of file CalledFromRootObjective.php.

                                                                    : array
    {
        return [];
    }

isApplicable()

ILIAS\Setup\Objective\CalledFromRootObjective::isApplicable

(

Setup\Environment

$environment

)

Definition at line 61 of file CalledFromRootObjective.php.

                                                                : bool
    {
        return true;
    }

isNotable()

ILIAS\Setup\Objective\CalledFromRootObjective::isNotable

(

)

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

Implements ILIAS\Setup\Objective.

Definition at line 40 of file CalledFromRootObjective.php.

                               : bool
    {
        return true;
    }

---

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

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