ilDatabaseUpdateSteps Class Reference

This base-class simplifies the creation of (consecutive) database updates. More...

Inheritance diagram for ilDatabaseUpdateSteps:

Collaboration diagram for ilDatabaseUpdateSteps:

Public Member Functions
	__construct (Objective $base)
	getAdditionalPreconditionsForStep (int $num)
	Get preconditions for steps. More...
	getHash ()
	The hash for the objective is calculated over the classname and the steps that are contained. More...
	getLabel ()
	Get a label that describes this objective. More...
	isNotable ()
	getPreconditions (Environment $environment)
	achieve (Environment $environment)
	isApplicable (Environment $environment)
	getStep (int $num, int $finished=0)
	Get a database update step. More...
	getLatestStepNum ()
	Get the number of latest database step in this class. More...

Data Fields
const	STEP_METHOD_PREFIX = "step_"

Protected Member Functions
	getSteps ()
	Get the numbers of the steps in this class. More...

Protected Attributes
	$steps = null
	$base

Detailed Description

This base-class simplifies the creation of (consecutive) database updates.

Implement update steps on one or more tables by creating methods that follow this schema:

public function step_1( $db) { ... }

The class will figure out which of them haven't been performed yet and need to be executed.

If the class takes care of only one table or a set of related tables it will be easier to maintain.

If for some reason you rely on other objectives, e.g. steps from other db-update classes, implement getAdditionalPreconditionsForStep.

Definition at line 25 of file class.ilDatabaseUpdateSteps.php.

Constructor & Destructor Documentation

__construct()

ilDatabaseUpdateSteps::__construct

(

Objective

$base

)

Parameters

Objective

$base

for the update steps, i.e. the objective that should have been reached before the steps of this class can even begin. Most probably this should be .

Definition at line 45 of file class.ilDatabaseUpdateSteps.php.

References $base, and base().

      {
        $this->base = $base;
    }

Here is the call graph for this function:

Member Function Documentation

achieve()

ilDatabaseUpdateSteps::achieve ( Environment  $environment )

final

Implements ILIAS\Setup\Objective.

Definition at line 108 of file class.ilDatabaseUpdateSteps.php.

                                                            : Environment
    {
        return $environment;
    }

getAdditionalPreconditionsForStep()

ilDatabaseUpdateSteps::getAdditionalPreconditionsForStep

(

int

$num

)

Get preconditions for steps.

The previous step will automatically be a precondition of every step but will not be returned from this method.

Returns

Objective[]

Definition at line 59 of file class.ilDatabaseUpdateSteps.php.

Referenced by getStep().

                                                                : array
    {
        return [];
    }

Here is the caller graph for this function:

getHash()

ilDatabaseUpdateSteps::getHash ( )

final

The hash for the objective is calculated over the classname and the steps that are contained.

Implements ILIAS\Setup\Objective.

Definition at line 68 of file class.ilDatabaseUpdateSteps.php.

                                    : string
    {
        return hash(
            "sha256",
            get_class($this)
        );
    }

getLabel()

ilDatabaseUpdateSteps::getLabel ( )

final

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

Definition at line 76 of file class.ilDatabaseUpdateSteps.php.

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

getLatestStepNum()

ilDatabaseUpdateSteps::getLatestStepNum ( )

final

Get the number of latest database step in this class.

Definition at line 146 of file class.ilDatabaseUpdateSteps.php.

References getSteps().

Referenced by getPreconditions().

                                             : int
    {
        $this->getSteps();
        return end($this->steps);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPreconditions()

ilDatabaseUpdateSteps::getPreconditions ( Environment  $environment )

final

Implements ILIAS\Setup\Objective.

Definition at line 92 of file class.ilDatabaseUpdateSteps.php.

References $log, getLatestStepNum(), ILIAS\Setup\Environment\getResource(), and getStep().

                                                                     : array
    {
        $log = $environment->getResource(\ilDatabaseUpdateStepExecutionLog::class);

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

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

Here is the call graph for this function:

getStep()

ilDatabaseUpdateSteps::getStep ( int  $num, int  $finished = 0  )

final

Get a database update step.

Optionally tell which step is known to have been finished to exclude it from the preconditions of the newer steps.

Exceptions

Definition at line 127 of file class.ilDatabaseUpdateSteps.php.

References $base, getAdditionalPreconditionsForStep(), and getSteps().

Referenced by getPreconditions().

                                                               : 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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSteps()

ilDatabaseUpdateSteps::getSteps ( )

finalprotected

Get the numbers of the steps in this class.

Returns

int[]

Definition at line 157 of file class.ilDatabaseUpdateSteps.php.

References $steps.

Referenced by Test_ilDatabaseUpdateSteps\_getSteps(), getLatestStepNum(), and getStep().

                                        : 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;
    }

Here is the caller graph for this function:

isApplicable()

ilDatabaseUpdateSteps::isApplicable ( Environment  $environment )

final

Implements ILIAS\Setup\Objective.

Definition at line 116 of file class.ilDatabaseUpdateSteps.php.

                                                                 : bool
    {
        return true;
    }

isNotable()

ilDatabaseUpdateSteps::isNotable ( )

final

Implements ILIAS\Setup\Objective.

Definition at line 84 of file class.ilDatabaseUpdateSteps.php.

                                      : bool
    {
        return true;
    }

Field Documentation

$base

ilDatabaseUpdateSteps::$base

protected

Definition at line 37 of file class.ilDatabaseUpdateSteps.php.

Referenced by __construct(), and getStep().

$steps

ilDatabaseUpdateSteps::$steps = null

protected

Definition at line 32 of file class.ilDatabaseUpdateSteps.php.

Referenced by getSteps(), and ilDatabaseUpdateStepsTest\testGetAllSteps().

STEP_METHOD_PREFIX

const ilDatabaseUpdateSteps::STEP_METHOD_PREFIX = "step_"

Definition at line 27 of file class.ilDatabaseUpdateSteps.php.

Referenced by ilDatabaseUpdateStep\__construct().

---

The documentation for this class was generated from the following file:

• Services/Database/classes/Setup/class.ilDatabaseUpdateSteps.php