CollectedObjective.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Setup\Metrics;

use ILIAS\Setup;

abstract class CollectedObjective implements Setup\Objective
{
    protected Storage $storage;

    public function __construct(Storage $storage)
    {
        $this->storage = $storage;
    }

    abstract protected function collectFrom(Setup\Environment $environment, Storage $storage): void;

    abstract protected function getTentativePreconditions(Setup\Environment $environment): array;

    public function getHash(): string
    {
        return hash("sha256", static::class);
    }

    public function getLabel(): string
    {
        return "Collect metrics: " . get_class($this);
    }

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

    public function getPreconditions(Setup\Environment $environment): array
    {
        return array_map(
            fn (Setup\Objective $o): \ILIAS\Setup\Objective\Tentatively => new Setup\Objective\Tentatively($o),
            $this->getTentativePreconditions($environment)
        );
    }

    public function achieve(Setup\Environment $environment): Setup\Environment
    {
        $this->collectFrom($environment, $this->storage);
        return $environment;
    }

    public function isApplicable(Setup\Environment $environment): bool
    {
        // We want to always collect fresh metrics.
        return true;
    }
}