UpdateSteps.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\LegalDocuments\Setup;

use ilDatabaseUpdateSteps;
use ilDBInterface;
use ilDBConstants;

class UpdateSteps implements ilDatabaseUpdateSteps
{
    protected ilDBInterface $database;

    public function prepare(ilDBInterface $database): void
    {
        $this->database = $database;
    }

    public function step_1(): void
    {
        $this->renameTables([
            'tos_documents' => 'ldoc_documents',
            'tos_criterion_to_doc' => 'ldoc_criteria',
            'tos_acceptance_track' => 'ldoc_acceptance_track',
            'tos_versions' => 'ldoc_versions',
        ]);

        $this->ensureColumn('ldoc_documents', 'provider', [
            'type' => ilDBConstants::T_TEXT,
            'notnull' => true,
            'default' => 'tos',
            'length' => 255,
        ]);

        $this->ensureColumn('ldoc_documents', 'hash', [
            'type' => ilDBConstants::T_TEXT,
            'notnull' => true,
            'default' => '',
            'length' => 255,
        ]);

        foreach (['ldoc_documents', 'ldoc_versions'] as $table) {
            $this->ensureColumn($table, 'type', [
                'type' => ilDBConstants::T_TEXT,
                'notnull' => true,
                'default' => 'html',
                'length' => 255,
            ]);
        }
    }

    public function step_2(): void
    {
        // Keep
    }

    public function step_3(): void
    {
        $this->ensureColumn('ldoc_versions', 'provider', [
            'type' => ilDBConstants::T_TEXT,
            'notnull' => true,
            'default' => '',
            'length' => 255,
        ]);

        $select_provider = '(SELECT d.provider FROM ldoc_documents AS d WHERE v.doc_id = d.id)';
        $this->database->manipulate("UPDATE ldoc_versions AS v SET provider = $select_provider WHERE provider = '' AND EXISTS $select_provider");
    }

    private function ensureColumn(string $table, string $name, array $attributes): void
    {
        if (!$this->database->tableColumnExists($table, $name)) {
            $this->database->addTableColumn($table, $name, $attributes);
        }
    }

    private function renameTables(array $tables): void
    {
        foreach ($tables as $old => $new) {
            if (!$this->database->tableExists($new)) {
                $this->database->renameTable($old, $new);
            }
        }
    }
}