class.ilFileSystemClientDirectoryRenamedObjective.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Setup;

class ilFileSystemClientDirectoryRenamedObjective implements Setup\Objective
{
    public const DEFAULT_CLIENT_ID = "default";

    protected string $path;

    public function __construct(string $path)
    {
        $this->path = $path;
    }

    public function getHash(): string
    {
        return hash("sha256", self::class) . $this->path;
    }

    public function getLabel(): string
    {
        return "Switch client names for export/import";
    }

    public function isNotable(): bool
    {
        return true;
    }

    public function getPreconditions(Setup\Environment $environment): array
    {
        return [
            new ilIniFilesPopulatedObjective()
        ];
    }

    public function achieve(Setup\Environment $environment): Setup\Environment
    {
        $client_id = $environment->getResource(Setup\Environment::RESOURCE_CLIENT_ID);

        $old_name = $this->path . DIRECTORY_SEPARATOR . $client_id;
        $new_name = $this->path . DIRECTORY_SEPARATOR . self::DEFAULT_CLIENT_ID;

        if ($environment->hasConfigFor(Setup\CLI\InstallCommand::IMPORT)) {
            $old_name = $this->path . DIRECTORY_SEPARATOR . self::DEFAULT_CLIENT_ID;
            $new_name = $this->path . DIRECTORY_SEPARATOR . $client_id;
        }

        rename($old_name, $new_name);

        return $environment;
    }

    public function isApplicable(Setup\Environment $environment): bool
    {
        return true;
    }
}