AdminConfirmedObjective.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\Objective;

use ILIAS\Setup;

class AdminConfirmedObjective implements Setup\Objective
{
    protected $message;

    public function __construct(string $message)
    {
        $this->message = $message;
    }

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

    public function getLabel() : string
    {
        return "Get a confirmation from admin.";
    }

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

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

    public function achieve(Setup\Environment $environment) : Setup\Environment
    {
        $admin_interaction = $environment->getResource(Setup\Environment::RESOURCE_ADMIN_INTERACTION);

        if (!$admin_interaction->confirmOrDeny($this->message)) {
            throw new Setup\NoConfirmationException(
                $this->message
            );
        }

        return $environment;
    }

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