ExternalConditionObjective.php

Go to the documentation of this file.

<?php

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

namespace ILIAS\Setup\Condition;

use ILIAS\Setup;

class ExternalConditionObjective implements Setup\Objective
{
    protected $label;

    protected $condition;

    protected $message;

    public function __construct(string $label, callable $condition, string $message = null)
    {
        $this->condition = $condition;
        $this->label = $label;
        $this->message = $message;
    }

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

    public function getLabel() : string
    {
        return $this->label;
    }

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

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

    public function achieve(Setup\Environment $environment) : Setup\Environment
    {
        if (($this->condition)($environment)) {
            return $environment;
        }

        if ($this->message) {
            $admin_interaction = $environment->getResource(Setup\Environment::RESOURCE_ADMIN_INTERACTION);
            $admin_interaction->inform($this->message);
        }

        throw new Setup\UnachievableException(
            "An external condition was not met: {$this->label}"
        );
    }

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