CalledFromRootObjective.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Setup\Objective;
 
use ILIAS\Setup;
 
class CalledFromRootObjective implements Setup\Objective
{
    public function getHash(): string
    {
        return hash("sha256", self::class);
    }
 
    public function getLabel(): string
    {
        return "Verify that the setup is called from ilias' root-directory.";
    }
 
    public function isNotable(): bool
    {
        return true;
    }
 
    public function getPreconditions(Setup\Environment $environment): array
    {
        return [];
    }
 
    public function achieve(Setup\Environment $environment): 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;
    }
 
    public function isApplicable(Setup\Environment $environment): bool
    {
        return true;
    }
}