ILIAS\Registration\DualOptIn\Setup\DualOptInDatabaseUpdateSteps Class Reference

Inheritance diagram for ILIAS\Registration\DualOptIn\Setup\DualOptInDatabaseUpdateSteps:

Collaboration diagram for ILIAS\Registration\DualOptIn\Setup\DualOptInDatabaseUpdateSteps:

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

Protected Attributes
ilDBInterface	$db

Detailed Description

Definition at line 25 of file DualOptInDatabaseUpdateSteps.php.

Member Function Documentation

prepare()

ILIAS\Registration\DualOptIn\Setup\DualOptInDatabaseUpdateSteps::prepare

(

\ilDBInterface

$db

)

Prepare the execution of the steps.

Do not use anything from the globals or the DIC inside your steps, only use the instance of the database provided here.

Implements ilDatabaseUpdateSteps.

Definition at line 29 of file DualOptInDatabaseUpdateSteps.php.

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

References ILIAS\Registration\DualOptIn\Setup\DualOptInDatabaseUpdateSteps\$db.

step_1()

ILIAS\Registration\DualOptIn\Setup\DualOptInDatabaseUpdateSteps::step_1

(

)

Definition at line 34 of file DualOptInDatabaseUpdateSteps.php.

                            : void
    {
        if ($this->db->tableExists('reg_dual_opt_in')) {
            return;
        }
 
        $fields = [
            'id' => [
                'type' => \ilDBConstants::T_TEXT,
                'length' => 36,
                'fixed' => true,
                'notnull' => true,
            ],
            'usr_id' => [
                'type' => \ilDBConstants::T_INTEGER,
                'length' => 8,
                'notnull' => true
            ],
            'reg_hash' => [
                'type' => \ilDBConstants::T_TEXT,
                'length' => 16,
                'fixed' => true,
                'notnull' => true
            ],
            'creation_date' => [
                'type' => \ilDBConstants::T_INTEGER,
                'length' => 8,
                'notnull' => true
            ]
        ];
 
        $this->db->createTable('reg_dual_opt_in', $fields);
        $this->db->addPrimaryKey('reg_dual_opt_in', ['id']);
    }

References ilDBConstants\T_INTEGER, ilDBConstants\T_TEXT, and true.

step_2()

ILIAS\Registration\DualOptIn\Setup\DualOptInDatabaseUpdateSteps::step_2

(

)

Definition at line 69 of file DualOptInDatabaseUpdateSteps.php.

                            : void
    {
        if (!$this->db->tableExists('usr_data') ||
            !$this->db->tableColumnExists('usr_data', 'reg_hash')) {
            return;
        }
 
        $res = $this->db->query(
            <<<SQL
            SELECT ud.usr_id, ud.reg_hash, ud.create_date
            FROM usr_data ud
            INNER JOIN object_data od ON od.obj_id = ud.usr_id
            WHERE ud.reg_hash IS NOT NULL AND ud.reg_hash <> ''
SQL
        );
 
        while ($row = $res->fetchRow(\ilDBConstants::FETCHMODE_OBJECT)) {
            $this->db->manipulateF(
                'INSERT INTO reg_dual_opt_in (id, usr_id, reg_hash, creation_date) VALUES (%s, %s, %s, %s)',
                [
                    \ilDBConstants::T_TEXT,
                    \ilDBConstants::T_INTEGER,
                    \ilDBConstants::T_TEXT,
                    \ilDBConstants::T_INTEGER
                ],
                [
                    (new UUIDFactory())->uuid4(),
                    $row->usr_id,
                    $row->reg_hash,
                    (new \DateTimeImmutable($row->create_date, new \DateTimeZone('UTC')))->getTimestamp()
                ]
            );
        }
    }

References $res, ilDBConstants\FETCHMODE_OBJECT, ILIAS\Data\Description\NULL, ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

step_3()

ILIAS\Registration\DualOptIn\Setup\DualOptInDatabaseUpdateSteps::step_3

(

)

Definition at line 104 of file DualOptInDatabaseUpdateSteps.php.

                            : void
    {
        if (!$this->db->tableExists('usr_data') ||
            !$this->db->tableColumnExists('usr_data', 'reg_hash')) {
            return;
        }
 
        $this->db->dropTableColumn('usr_data', 'reg_hash');
    }

step_4()

ILIAS\Registration\DualOptIn\Setup\DualOptInDatabaseUpdateSteps::step_4

(

)

Definition at line 114 of file DualOptInDatabaseUpdateSteps.php.

                            : void
    {
        if ($this->db->tableExists('reg_dual_opt_in') &&
            !$this->db->indexExistsByFields('reg_dual_opt_in', ['reg_hash'])) {
            $this->db->addIndex('reg_dual_opt_in', ['reg_hash'], 'i1');
        }
 
        if ($this->db->tableExists('reg_dual_opt_in') &&
            !$this->db->indexExistsByFields('reg_dual_opt_in', ['usr_id'])) {
            $this->db->addIndex('reg_dual_opt_in', ['usr_id'], 'i2');
        }
    }

Field Documentation

$db

ilDBInterface ILIAS\Registration\DualOptIn\Setup\DualOptInDatabaseUpdateSteps::$db

protected

Definition at line 27 of file DualOptInDatabaseUpdateSteps.php.

Referenced by ILIAS\Registration\DualOptIn\Setup\DualOptInDatabaseUpdateSteps\prepare().

---

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

• components/ILIAS/Registration/src/DualOptIn/Setup/DualOptInDatabaseUpdateSteps.php