BuildArtifactObjective.php

Go to the documentation of this file.

<?php


/* Copyright (c) 2019 Richard Klees <richard.klees@concepts-and-training.de>, Fabian Schmid <fs@studer-raimann.ch> Extended GPL, see docs/LICENSE */

namespace ILIAS\Setup\Artifact;

use ILIAS\Setup;

abstract class BuildArtifactObjective implements Setup\Objective
{
    abstract public function getArtifactPath() : 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->getArtifactPath());
    }

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

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

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

        // TODO: Do we want to configure this?
        $base_path = getcwd();
        $path = $base_path . "/" . $this->getArtifactPath();

        $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)) {
            mkdir($dir, 0755, true);
        }
    }
}