ilFileSystemConfigNotChangedObjective Class Reference

Inheritance diagram for ilFileSystemConfigNotChangedObjective:

Collaboration diagram for ilFileSystemConfigNotChangedObjective:

Public Member Functions
	__construct (protected \ilFileSystemSetupConfig $config)
	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)
	achieve (Environment $environment)
	Objectives can be achieved. More...
	isApplicable (Environment $environment)
	@inheritDoc 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...
	isApplicable (Environment $environment)
	Get to know whether the objective is applicable. More...

Detailed Description

Definition at line 23 of file class.ilFileSystemConfigNotChangedObjective.php.

Constructor & Destructor Documentation

__construct()

ilFileSystemConfigNotChangedObjective::__construct

(

protected \ilFileSystemSetupConfig

$config

)

Definition at line 25 of file class.ilFileSystemConfigNotChangedObjective.php.

    {
    }

Member Function Documentation

achieve()

ilFileSystemConfigNotChangedObjective::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

LogicException if there are unfullfilled preconditions.

Exceptions

RuntimeException if there are missing resources.

Implements ILIAS\Setup\Objective.

Definition at line 55 of file class.ilFileSystemConfigNotChangedObjective.php.

                                                     : Environment
    {
        $ini = $environment->getResource(Environment::RESOURCE_ILIAS_INI);
 
        $current = $ini->readVariable("clients", "datadir");
        $new = $this->config->getDataDir();
        if ($current !== $new) {
            throw new UnachievableException(
                "You seem to try to move the ILIAS data-directory from '$current' " .
                "to '$new', the client.ini.php contains a different path then the " .
                "config you are using. This is not supported by the setup."
            );
        }
 
        return $environment;
    }

References $ini, and ILIAS\Setup\Environment\getResource().

Here is the call graph for this function:

getHash()

ilFileSystemConfigNotChangedObjective::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 29 of file class.ilFileSystemConfigNotChangedObjective.php.

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

getLabel()

ilFileSystemConfigNotChangedObjective::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

Definition at line 34 of file class.ilFileSystemConfigNotChangedObjective.php.

                              : string
    {
        return "Config for Filesystems did not change.";
    }

getPreconditions()

ilFileSystemConfigNotChangedObjective::getPreconditions

(

Environment

$environment

)

Returns

\ilFileSystemDirectoriesCreatedObjective[]|\ilIniFilesLoadedObjective[]

Implements ILIAS\Setup\Objective.

Definition at line 47 of file class.ilFileSystemConfigNotChangedObjective.php.

                                                              : array
    {
        return [
            new ilIniFilesLoadedObjective(),
            new ilFileSystemDirectoriesCreatedObjective($this->config)
        ];
    }

isApplicable()

ilFileSystemConfigNotChangedObjective::isApplicable

(

Environment

$environment

)

@inheritDoc

Implements ILIAS\Setup\Objective.

Definition at line 75 of file class.ilFileSystemConfigNotChangedObjective.php.

                                                          : bool
    {
        $ini = $environment->getResource(Environment::RESOURCE_ILIAS_INI);
 
        return $ini->readVariable("clients", "datadir") !== $this->config->getDataDir();
    }

References $ini, and ILIAS\Setup\Environment\getResource().

Here is the call graph for this function:

isNotable()

ilFileSystemConfigNotChangedObjective::isNotable

(

)

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

Implements ILIAS\Setup\Objective.

Definition at line 39 of file class.ilFileSystemConfigNotChangedObjective.php.

                               : bool
    {
        return false;
    }

---

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

• components/ILIAS/Filesystem/classes/Setup/class.ilFileSystemConfigNotChangedObjective.php