class.ilDatabaseUpdateSteps.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 */

use ILIAS\Setup\Environment;
use ILIAS\Setup\CallableObjective;
use ILIAS\Setup\NullObjective;
use ILIAS\Setup\Objective;

abstract class ilDatabaseUpdateSteps implements Objective
{
    const STEP_METHOD_PREFIX = "step_";

    protected $steps = null;

    protected $base;

    public function __construct(
        Objective $base
    ) {
        $this->base = $base;
    }

    public function getAdditionalPreconditionsForStep(int $num) : array
    {
        return [];
    }

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

    final public function getLabel() : string
    {
        return "Database update steps in " . get_class($this);
    }

    final public function isNotable() : bool
    {
        return true;
    }

    final public function getPreconditions(Environment $environment) : array
    {
        $log = $environment->getResource(\ilDatabaseUpdateStepExecutionLog::class);

        if ($log) {
            $finished = $log->getLastFinishedStep(get_class($this));
        } else {
            $finished = 0;
        }

        return [$this->getStep($this->getLatestStepNum(), $finished)];
    }

    final public function achieve(Environment $environment) : Environment
    {
        return $environment;
    }

    final public function getStep(int $num, int $finished = 0) : ilDatabaseUpdateStep
    {
        $cur = $this->base;
        foreach ($this->getSteps() as $s) {
            if ($s <= $finished) {
                continue;
            } elseif ($s <= $num) {
                $cur = new ilDatabaseUpdateStep($this, $s, $cur, ...$this->getAdditionalPreconditionsForStep($s));
            } else {
                break;
            }
        }

        return $cur;
    }

    final public function getLatestStepNum() : int
    {
        $this->getSteps();
        return end($this->steps);
    }

    final protected function getSteps() : array
    {
        if (!is_null($this->steps)) {
            return $this->steps;
        }

        $this->steps = [];

        foreach (get_class_methods(static::class) as $method) {
            if (stripos($method, self::STEP_METHOD_PREFIX) !== 0) {
                continue;
            }

            $number = substr($method, strlen(self::STEP_METHOD_PREFIX));

            if (!preg_match("/^[1-9]\d*$/", $number)) {
                throw new \LogicException("Method $method seems to be a step but has an odd looking number");
            }

            $this->steps[(int) $number] = (int) $number;
        }

        asort($this->steps);

        return $this->steps;
    }
}