CallableObjective.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Setup\Objective;

use ILIAS\Setup;

class CallableObjective implements Setup\Objective
{
    protected $callable;

    protected string $label;

    protected bool $is_notable;

    protected array $preconditions;

    public function __construct(callable $callable, string $label, bool $is_notable, Setup\Objective ...$preconditions)
    {
        $this->callable = $callable;
        $this->label = $label;
        $this->is_notable = $is_notable;
        $this->preconditions = $preconditions;
    }

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

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

    public function isNotable(): bool
    {
        return $this->is_notable;
    }

    public function getPreconditions(Setup\Environment $environment): array
    {
        return $this->preconditions;
    }

    public function achieve(Setup\Environment $environment): Setup\Environment
    {
        $res = call_user_func($this->callable, $environment);
        if ($res instanceof Setup\Environment) {
            return $res;
        }
        return $environment;
    }

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