This logs the execution of database update steps. More...

Inheritance diagram for ilDBStepExecutionDB:

Collaboration diagram for ilDBStepExecutionDB:

Public Member Functions
	__construct (protected ilDBInterface $db, callable $get_now)

	started (string $class, int $step)

	finished (string $class, int $step)

	getLastStartedStep (string $class)
	Returns 0 as "first" step. More...

	getLastFinishedStep (string $class)
	Returns 0 as "first" step. More...

	started (string $class, int $step)

	finished (string $class, int $step)

	getLastStartedStep (string $class)
	Returns 0 as "first" step. More...

	getLastFinishedStep (string $class)
	Returns 0 as "first" step. More...

Data Fields
const	TABLE_NAME = "il_db_steps"

const	FIELD_CLASS = "class"

const	FIELD_STEP = "step"

const	FIELD_STARTED = "started"

const	FIELD_FINISHED = "finished"

Protected Member Functions
	throwIfClassNameTooLong (string $class)

	getFormattedNow ()

Protected Attributes
	$get_now

Detailed Description

This logs the execution of database update steps.

Author: : Richard Klees

Definition at line 26 of file class.ilDBStepExecutionDB.php.

Constructor & Destructor Documentation

◆ __construct()

ilDBStepExecutionDB::__construct	(	protected ilDBInterface	$db,
		callable	$get_now
	)

Parameters

callable $get_now must return a DateTime object indicating the very moment the callable was called.

Definition at line 40 of file class.ilDBStepExecutionDB.php.

    {
        $this->get_now = $get_now;
    }

References $get_now.

Member Function Documentation

◆ finished()

ilDBStepExecutionDB::finished	(	string	$class,
		int	$step
	)

Exceptions

LogicException if the finished step does not match the previously started step

Implements ilDatabaseUpdateStepExecutionLog.

Definition at line 81 of file class.ilDBStepExecutionDB.php.

                                                      : void
    {
        $this->throwIfClassNameTooLong($class);
 
        $last_started_step = $this->getLastStartedStep($class);
        if ($last_started_step !== $step) {
            throw new \RuntimeException(
                "The step $step for $class is supposed to be finished, but" .
                " $last_started_step was $step started last."
            );
        }
 
        $this->db->update(
            self::TABLE_NAME,
            [
                self::FIELD_FINISHED => ["text", $this->getFormattedNow()]
            ],
            [
                self::FIELD_CLASS => ["text", $class],
                self::FIELD_STEP => ["integer", $step]
            ]
        );
    }

References getFormattedNow(), getLastStartedStep(), and throwIfClassNameTooLong().

Referenced by ilDBStepExecutionDBTest\testFinishedThrowsWhenOtherStepThenLastIsFinished(), and ilDBStepExecutionDBTest\testFinishedWritesToDB().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFormattedNow()

ilDBStepExecutionDB::getFormattedNow ( )

protected

Definition at line 143 of file class.ilDBStepExecutionDB.php.

                                        : string
    {
        $now = ($this->get_now)();
        if (!($now instanceof \DateTime)) {
            throw new \LogicException(
                "Expected \$get_now to return a DateTime."
            );
        }
        return $now->format("Y-m-d H:i:s.u");
    }

References $get_now.

Referenced by finished(), and started().

Here is the caller graph for this function:

◆ getLastFinishedStep()

ilDBStepExecutionDB::getLastFinishedStep ( string $class )

Returns 0 as "first" step.

Implements ilDatabaseUpdateStepExecutionLog.

Definition at line 119 of file class.ilDBStepExecutionDB.php.

                                                      : int
    {
        $this->throwIfClassNameTooLong($class);
 
        $res = $this->db->query(
            "SELECT MAX(" . self::FIELD_STEP . ") AS " . self::FIELD_STEP .
            " FROM " . self::TABLE_NAME .
            " WHERE " . self::FIELD_CLASS . " = " . $this->db->quote($class, "text") .
            " AND " . self::FIELD_FINISHED . " IS NOT NULL"
        );
 
        $row = $this->db->fetchAssoc($res);
        return (int) ($row[self::FIELD_STEP] ?? 0);
    }

References $res, FIELD_STEP, and throwIfClassNameTooLong().

Referenced by started().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLastStartedStep()

ilDBStepExecutionDB::getLastStartedStep ( string $class )

Returns 0 as "first" step.

Implements ilDatabaseUpdateStepExecutionLog.

Definition at line 105 of file class.ilDBStepExecutionDB.php.

                                                     : int
    {
        $this->throwIfClassNameTooLong($class);
 
        $res = $this->db->query(
            "SELECT MAX(" . self::FIELD_STEP . ") AS " . self::FIELD_STEP .
            " FROM " . self::TABLE_NAME .
            " WHERE " . self::FIELD_CLASS . " = " . $this->db->quote($class, "text")
        );
 
        $row = $this->db->fetchAssoc($res);
        return (int) ($row[self::FIELD_STEP] ?? 0);
    }

References $res, FIELD_STEP, and throwIfClassNameTooLong().

Referenced by finished(), and started().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ started()

ilDBStepExecutionDB::started	(	string	$class,
		int	$step
	)

Exceptions

LogicException if the previously started step has not finished

Implements ilDatabaseUpdateStepExecutionLog.

Definition at line 48 of file class.ilDBStepExecutionDB.php.

                                                     : void
    {
        $this->throwIfClassNameTooLong($class);
 
        $last_started_step = $this->getLastStartedStep($class);
        if ($last_started_step >= $step) {
            throw new \RuntimeException(
                "The last started step for $class was $last_started_step, which" .
                " is higher then the step $step started now."
            );
        }
 
        $last_finished_step = $this->getLastFinishedStep($class);
        if ($last_started_step !== $last_finished_step) {
            throw new \RuntimeException(
                "Step $step should be started for $class, but last step $last_started_step " .
                "has not finished by now."
            );
        }
 
        $this->db->insert(
            self::TABLE_NAME,
            [
                self::FIELD_CLASS => ["text", $class],
                self::FIELD_STEP => ["integer", $step],
                self::FIELD_STARTED => ["text", $this->getFormattedNow()]
            ]
        );
    }

References getFormattedNow(), getLastFinishedStep(), getLastStartedStep(), and throwIfClassNameTooLong().

Referenced by ilDBStepExecutionDBTest\testStartedThrowsOnStartStepNotLargerThenLastFinishedStep(), ilDBStepExecutionDBTest\testStartedThrowsWhenLastStepNotFinished(), and ilDBStepExecutionDBTest\testStartedWritesToDB().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ throwIfClassNameTooLong()

ilDBStepExecutionDB::throwIfClassNameTooLong ( string $class )

protected

Definition at line 134 of file class.ilDBStepExecutionDB.php.

                                                             : void
    {
        if (strlen($class) > 200) {
            throw new \InvalidArgumentException(
                "This ilDatabaseUpdateStepExecutionLog only supports class names up to 200 chars."
            );
        }
    }