ObjectiveHelper.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Setup\CLI;

use ILIAS\Setup\Objective;
use ILIAS\Setup\Environment;
use ILIAS\Setup\ObjectiveIterator;
use ILIAS\Setup\NotExecutableException;

trait ObjectiveHelper
{
    protected function achieveObjective(
        Objective $objective,
        Environment $environment,
        IOWrapper $io = null
    ): Environment {
        $iterator = new ObjectiveIterator($environment, $objective);
        $current = null;

        register_shutdown_function(static function () use (&$current) {
            if (null !== $current) {
                throw new \RuntimeException("Objective '{$current->getLabel()}' failed because it halted the program.");
            }
        });

        while ($iterator->valid()) {
            $current = $iterator->current();
            if (!$current->isApplicable($environment)) {
                // reset objective to mark it as processed without halting the program.
                $current = null;
                $iterator->next();
                continue;
            }
            if ($io !== null) {
                $io->startObjective($current->getLabel(), $current->isNotable());
            }
            try {
                $environment = $current->achieve($environment);
                if ($io !== null) {
                    $io->finishedLastObjective();
                }
                $iterator->setEnvironment($environment);
            } catch (NotExecutableException $e) {
                throw $e;
            } catch (\Throwable $e) {
                $iterator->markAsFailed($current);
                if ($io !== null) {
                    $message = $e->getMessage();
                    $io->failedLastObjective();
                    if ($io->isVerbose()) {
                        $message .= "\n\n" . $e->getTraceAsString();
                    }
                    $io->error($message);
                }
            } finally {
                // reset objective to mark it as processed without halting the program.
                $current = null;
            }
            $iterator->next();
        }

        return $environment;
    }
}