ExternalConditionObjective.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Setup\Condition;

use ILIAS\Setup;

class ExternalConditionObjective implements Setup\Objective
{
    protected string $label;
    protected \Closure $condition;
    protected ?string $message;
    protected bool $block_setup;

    public function __construct(
        string $label,
        \Closure $condition,
        string $message = null,
        bool $block_setup = false
    ) {
        $this->condition = $condition;
        $this->label = $label;
        $this->message = $message;
        $this->block_setup = $block_setup;
    }

    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);
        }
        if ($this->block_setup) {
            throw new Setup\NotExecutableException("An external condition was not met: $this->label");
        }

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

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