BuildArtifactObjective.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Setup\Artifact;

use ILIAS\Setup;

abstract class BuildArtifactObjective implements Setup\Objective
{
    protected const ARTIFACTS = __DIR__ . "/../../../../../artifacts";

    final public static function PATH(): string
    {
        return realpath(self::ARTIFACTS) . "/" . md5(static::class) . ".php";
    }

    private const COMPONENTS_DIRECTORY = "components";

    abstract public function getArtifactName(): string;

    abstract public function build(): Setup\Artifact;

    public function buildIn(Setup\Environment $env): Setup\Artifact
    {
        return $this->build();
    }

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

    public function getHash(): string
    {
        return hash("sha256", $this->getArtifactName());
    }

    public function getLabel(): string
    {
        return 'Build ' . $this->getArtifactName() . ' Artifact';
    }

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

    protected function getPath(): string
    {
        return static::PATH();
    }

    public function achieve(Setup\Environment $environment): Setup\Environment
    {
        $artifact = $this->buildIn($environment);

        $path = $this->getPath();

        $this->makeDirectoryFor($path);

        file_put_contents($path, $artifact->serialize());

        return $environment;
    }

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

    protected function makeDirectoryFor(string $path): void
    {
        $dir = pathinfo($path)["dirname"];
        if (!file_exists($dir)) {
            if (!mkdir($dir, 0755, true) && !is_dir($dir)) {
                throw new \RuntimeException(sprintf('Directory "%s" was not created', $dir));
            }
        }
    }
}