CollectedObjective.php

Go to the documentation of this file.

<?php
 
/* Copyright (c) 2020 Richard Klees <richard.klees@concepts-and-training.de> Extended GPL, see docs/LICENSE */
 
namespace ILIAS\Setup\Metrics;
 
use ILIAS\Setup;
 
abstract class CollectedObjective implements Setup\Objective
{
    protected $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.";
    }
 
    public function isNotable() : bool
    {
        return false;
    }
 
    public function getPreconditions(Setup\Environment $environment) : array
    {
        return array_map(
            function (Setup\Objective $o) {
                return 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;
    }
}