ILIAS\LegalDocuments\Setup\UpdateSteps Class Reference

Inheritance diagram for ILIAS\LegalDocuments\Setup\UpdateSteps:

Collaboration diagram for ILIAS\LegalDocuments\Setup\UpdateSteps:

Public Member Functions
	prepare (ilDBInterface $database)
	step_1 ()
	step_2 ()
	step_3 ()
Public Member Functions inherited from ilDatabaseUpdateSteps
	prepare (\ilDBInterface $db)
	Prepare the execution of the steps. More...

Protected Attributes
ilDBInterface	$database

Private Member Functions
	ensureColumn (string $table, string $name, array $attributes)
	renameTables (array $tables)

Detailed Description

Definition at line 27 of file UpdateSteps.php.

Member Function Documentation

ensureColumn()

ILIAS\LegalDocuments\Setup\UpdateSteps::ensureColumn ( string  $table, string  $name, array  $attributes  )

private

Parameters

array<string,mixed>

$attributes

Definition at line 90 of file UpdateSteps.php.

Referenced by ILIAS\LegalDocuments\Setup\UpdateSteps\step_1(), and ILIAS\LegalDocuments\Setup\UpdateSteps\step_3().

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

Here is the caller graph for this function:

prepare()

ILIAS\LegalDocuments\Setup\UpdateSteps::prepare

(

ilDBInterface

$database

)

Definition at line 31 of file UpdateSteps.php.

                                                    : void
    {
        $this->database = $database;
    }

renameTables()

ILIAS\LegalDocuments\Setup\UpdateSteps::renameTables ( array  $tables )

private

Parameters

array<string|int,mixed>

$tables

Definition at line 100 of file UpdateSteps.php.

Referenced by ILIAS\LegalDocuments\Setup\UpdateSteps\step_1().

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

Here is the caller graph for this function:

step_1()

ILIAS\LegalDocuments\Setup\UpdateSteps::step_1

(

)

Definition at line 36 of file UpdateSteps.php.

References ILIAS\LegalDocuments\Setup\UpdateSteps\ensureColumn(), ILIAS\LegalDocuments\Setup\UpdateSteps\renameTables(), and ilDBConstants\T_TEXT.

                            : 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,
            ]);
        }
    }

Here is the call graph for this function:

step_2()

ILIAS\LegalDocuments\Setup\UpdateSteps::step_2

(

)

Definition at line 69 of file UpdateSteps.php.

                            : void
    {
        // Keep
    }

step_3()

ILIAS\LegalDocuments\Setup\UpdateSteps::step_3

(

)

Definition at line 74 of file UpdateSteps.php.

References ILIAS\LegalDocuments\Setup\UpdateSteps\ensureColumn(), and ilDBConstants\T_TEXT.

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

Here is the call graph for this function:

Field Documentation

$database

ilDBInterface ILIAS\LegalDocuments\Setup\UpdateSteps::$database

protected

Definition at line 29 of file UpdateSteps.php.

---

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

• components/ILIAS/LegalDocuments/classes/Setup/UpdateSteps.php