ilFileSystemDirectoriesCreatedObjective Class Reference

Inheritance diagram for ilFileSystemDirectoriesCreatedObjective:

Collaboration diagram for ilFileSystemDirectoriesCreatedObjective:

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)

Protected Member Functions
	deleteRecursive (string $path, bool $delete_base_dir=false)

Detailed Description

Definition at line 29 of file class.ilFileSystemDirectoriesCreatedObjective.php.

Constructor & Destructor Documentation

__construct()

ilFileSystemDirectoriesCreatedObjective::__construct

(

protected \ilFileSystemSetupConfig

$config

)

Definition at line 31 of file class.ilFileSystemDirectoriesCreatedObjective.php.

    {
    }

Member Function Documentation

achieve()

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

Implements ILIAS\Setup\Objective.

Definition at line 110 of file class.ilFileSystemDirectoriesCreatedObjective.php.

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

                                                     : Environment
    {
        $ini = $environment->getResource(Environment::RESOURCE_ILIAS_INI);

        $ini->setVariable("clients", "datadir", $this->config->getDataDir());
        if (!$ini->write()) {
            throw new UnachievableException("Could not write ilias.ini.php");
        }

        if ($environment->hasConfigFor("tmp_dir")) {
            $tmp_dir = $environment->getConfigFor("tmp_dir");
            if (!is_null($tmp_dir)) {
                $this->deleteRecursive($tmp_dir, true);
            }
        }

        return $environment;
    }

Here is the call graph for this function:

deleteRecursive()

ilFileSystemDirectoriesCreatedObjective::deleteRecursive ( string  $path, bool  $delete_base_dir = false  )

protected

Definition at line 143 of file class.ilFileSystemDirectoriesCreatedObjective.php.

Referenced by achieve().

                                                                                   : void
    {
        if (is_file($path)) {
            unlink($path);
            return;
        }

        $files = new RecursiveIteratorIterator(
            new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS),
            RecursiveIteratorIterator::CHILD_FIRST
        );

        foreach ($files as $file_info) {
            if ($file_info->isDir()) {
                rmdir($file_info->getRealPath());
                continue;
            }
            unlink($file_info->getRealPath());
        }

        if ($delete_base_dir) {
            rmdir($path);
        }
    }

Here is the caller graph for this function:

getHash()

ilFileSystemDirectoriesCreatedObjective::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 35 of file class.ilFileSystemDirectoriesCreatedObjective.php.

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

getLabel()

ilFileSystemDirectoriesCreatedObjective::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

Definition at line 40 of file class.ilFileSystemDirectoriesCreatedObjective.php.

                              : string
    {
        return "ILIAS directories are created";
    }

getPreconditions()

ilFileSystemDirectoriesCreatedObjective::getPreconditions

(

Environment

$environment

)

Returns

DirectoryCreatedObjective[]|[]

Implements ILIAS\Setup\Objective.

Definition at line 53 of file class.ilFileSystemDirectoriesCreatedObjective.php.

References $client_id, $data_dir, ILIAS\Setup\Environment\getConfigFor(), ILIAS\Setup\Environment\getResource(), and ILIAS\Setup\Environment\hasConfigFor().

                                                              : array
    {
        $client_id = $environment->getResource(Environment::RESOURCE_CLIENT_ID);
        $data_dir = $this->config->getDataDir();
        $web_dir = dirname(__DIR__, 5) . "/public/data";
        $root = dirname(__DIR__, 5);

        $client_data_dir = $data_dir . '/' . $client_id;
        $client_web_dir = $web_dir . '/' . $client_id;

        $web_dir_objective = new DirectoryCreatedObjective($client_web_dir);
        $data_dir_objective = new DirectoryCreatedObjective($client_data_dir);
        $customizing_dir_objective = new NullObjective();

        if ($environment->hasConfigFor(InstallCommand::IMPORT)) {
            $tmp_dir = $environment->getConfigFor("tmp_dir");

            $web_dir_objective = new ObjectiveWithPreconditions(
                new ilFileSystemClientDirectoryRenamedObjective(
                    $web_dir
                ),
                new ilFileSystemDirectoryCopiedRecursivelyObjective(
                    $tmp_dir . DIRECTORY_SEPARATOR . "web_data",
                    $web_dir,
                    false,
                    true
                )
            );
            $data_dir_objective = new ObjectiveWithPreconditions(
                new ilFileSystemClientDirectoryRenamedObjective(
                    $data_dir
                ),
                new ilFileSystemDirectoryCopiedRecursivelyObjective(
                    $tmp_dir . DIRECTORY_SEPARATOR . "data",
                    $data_dir,
                    false,
                    true
                )
            );
            $customizing_dir_objective = new ilFileSystemDirectoryCopiedRecursivelyObjective(
                $tmp_dir . DIRECTORY_SEPARATOR . "Customizing",
                $root . "/Customizing",
                false,
                true
            );
        }

        return [
            new ilIniFilesPopulatedObjective(),
            new DirectoryCreatedObjective($data_dir),
            new DirectoryCreatedObjective($web_dir),
            $web_dir_objective,
            $data_dir_objective,
            $customizing_dir_objective
        ];
    }

Here is the call graph for this function:

isApplicable()

ilFileSystemDirectoriesCreatedObjective::isApplicable

(

Environment

$environment

)

Implements ILIAS\Setup\Objective.

Definition at line 132 of file class.ilFileSystemDirectoriesCreatedObjective.php.

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

                                                          : bool
    {
        if ($environment->hasConfigFor(InstallCommand::IMPORT)) {
            return true;
        }

        $ini = $environment->getResource(Environment::RESOURCE_ILIAS_INI);

        return $ini->readVariable("clients", "datadir") !== $this->config->getDataDir();
    }

Here is the call graph for this function:

isNotable()

ilFileSystemDirectoriesCreatedObjective::isNotable

(

)

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

Implements ILIAS\Setup\Objective.

Definition at line 45 of file class.ilFileSystemDirectoriesCreatedObjective.php.

                               : bool
    {
        return true;
    }

---

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

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