ILIAS\Help\Setup\ilHelpDBUpdateSteps Class Reference

Inheritance diagram for ILIAS\Help\Setup\ilHelpDBUpdateSteps:

Collaboration diagram for ILIAS\Help\Setup\ilHelpDBUpdateSteps:

Public Member Functions
	prepare (\ilDBInterface $db)
	Prepare the execution of the steps. More...
	step_1 ()
	step_2 ()
	step_3 ()
	step_4 ()
	step_5 ()
	step_6 ()
	step_7 ()
	step_8 ()
	step_9 ()
	step_10 ()
	prepare (\ilDBInterface $db)
	Prepare the execution of the steps. More...

Protected Attributes
ilDBInterface	$db

Detailed Description

Definition at line 21 of file class.ilHelpDBUpdateSteps.php.

Member Function Documentation

prepare()

ILIAS\Help\Setup\ilHelpDBUpdateSteps::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 25 of file class.ilHelpDBUpdateSteps.php.

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

References ILIAS\Help\Setup\ilHelpDBUpdateSteps\$db.

step_1()

ILIAS\Help\Setup\ilHelpDBUpdateSteps::step_1

(

)

Definition at line 30 of file class.ilHelpDBUpdateSteps.php.

                            : void
    {
        if (!$this->db->tableColumnExists('help_module', 'order_nr')) {
            $this->db->addTableColumn('help_module', 'order_nr', array(
                'type' => 'integer',
                'notnull' => true,
                'length' => 4,
                'default' => 0
            ));
        }
    }

step_10()

ILIAS\Help\Setup\ilHelpDBUpdateSteps::step_10

(

)

Definition at line 233 of file class.ilHelpDBUpdateSteps.php.

                             : void
    {
        if ($this->db->primaryExistsByFields('help_map', array(
            'chap', 'component', 'screen_id', 'screen_sub_id', 'perm', 'module_id'))) {
            $this->db->dropPrimaryKey('help_map');
        }
    }

step_2()

ILIAS\Help\Setup\ilHelpDBUpdateSteps::step_2

(

)

Definition at line 42 of file class.ilHelpDBUpdateSteps.php.

                            : void
    {
        if (!$this->db->tableColumnExists('help_module', 'active')) {
            $this->db->addTableColumn('help_module', 'active', array(
                'type' => 'integer',
                'notnull' => true,
                'length' => 1,
                'default' => 0
            ));
        }
    }

step_3()

ILIAS\Help\Setup\ilHelpDBUpdateSteps::step_3

(

)

Definition at line 54 of file class.ilHelpDBUpdateSteps.php.

                            : void
    {
        $set = $this->db->queryF(
            "SELECT value FROM settings " .
            " WHERE module = %s AND keyword = %s",
            ["text", "text"],
            ["common", "help_module"]
        );
        if ($rec = $this->db->fetchAssoc($set)) {
            $id = (int) $rec["value"];
            if ($id > 0) {
                $this->db->update(
                    "help_module",
                    [
                    "active" => ["integer", 1]
                ],
                    [    // where
                        "id" => ["integer", $id]
                    ]
                );
            }
        }
    }

References $id, and ILIAS\Repository\int().

Here is the call graph for this function:

step_4()

ILIAS\Help\Setup\ilHelpDBUpdateSteps::step_4

(

)

Definition at line 78 of file class.ilHelpDBUpdateSteps.php.

                            : void
    {
        if (!$this->db->tableColumnExists('help_map', 'full_id')) {
            $this->db->addTableColumn('help_map', 'full_id', array(
                'type' => 'text',
                'length' => 1000,
                'default' => ""
            ));
        }
    }

step_5()

ILIAS\Help\Setup\ilHelpDBUpdateSteps::step_5

(

)

Definition at line 89 of file class.ilHelpDBUpdateSteps.php.

                            : void
    {
        if (!$this->db->tableExists('help_gt_settings')) {
            $this->db->createTable(
                'help_gt_settings',
                [
                'obj_id' => [
                    'type' => 'integer',
                    'length' => 4,
                    'notnull' => true
                ],
                'active' => [
                    'type' => 'integer',
                    'length' => 1,
                    'notnull' => true,
                    'default' => 0
                ],
                'screen_ids' => [
                    'type' => 'text',
                    'length' => 1000,
                    'notnull' => true,
                    'default' => ''
                ],
                'permission' => [
                    'type' => 'integer',
                    'length' => 1,
                    'notnull' => true,
                    'default' => 0
                ],
            ]
            );
            $this->db->addPrimaryKey('help_gt_settings', ['obj_id']);
        }
    }

step_6()

ILIAS\Help\Setup\ilHelpDBUpdateSteps::step_6

(

)

Definition at line 124 of file class.ilHelpDBUpdateSteps.php.

                            : void
    {
        if (!$this->db->tableExists('help_gt_step')) {
            $this->db->createTable(
                'help_gt_step',
                [
                    'id' => [
                        'type' => 'integer',
                        'length' => 4,
                        'notnull' => true
                    ],
                    'tour_id' => [
                        'type' => 'integer',
                        'length' => 4,
                        'notnull' => true
                    ],
                    'order_nr' => [
                        'type' => 'integer',
                        'length' => 4,
                        'notnull' => true
                    ],
                    'type' => [
                        'type' => 'integer',
                        'length' => 1,
                        'notnull' => true
                    ],
                    'element_id' => [
                        'type' => 'text',
                        'length' => 1000,
                        'notnull' => true,
                        'default' => ''
                    ]
                ]
            );
            $this->db->addPrimaryKey('help_gt_step', ['id']);
        }
    }

step_7()

ILIAS\Help\Setup\ilHelpDBUpdateSteps::step_7

(

)

Definition at line 162 of file class.ilHelpDBUpdateSteps.php.

                            : void
    {
        $this->db->createSequence('help_gt_step');
    }

step_8()

ILIAS\Help\Setup\ilHelpDBUpdateSteps::step_8

(

)

Definition at line 167 of file class.ilHelpDBUpdateSteps.php.

                            : void
    {
        if (!$this->db->tableExists('help_gt_user_finished')) {
            $this->db->createTable(
                'help_gt_user_finished',
                [
                    'tour_id' => [
                        'type' => 'integer',
                        'length' => 4,
                        'notnull' => true
                    ],
                    'user_id' => [
                        'type' => 'integer',
                        'length' => 4,
                        'notnull' => true
                    ]
                ]
            );
            $this->db->addPrimaryKey('help_gt_user_finished', ['tour_id', 'user_id']);
        }
    }

step_9()

ILIAS\Help\Setup\ilHelpDBUpdateSteps::step_9

(

)

Definition at line 189 of file class.ilHelpDBUpdateSteps.php.

                            : void
    {
        // step 5 might not be run on ilias 10 systems (see 10 branch)
        if (!$this->db->tableExists('help_gt_settings')) {
            $this->db->createTable(
                'help_gt_settings',
                [
                    'obj_id' => [
                        'type' => 'integer',
                        'length' => 4,
                        'notnull' => true
                    ],
                    'active' => [
                        'type' => 'integer',
                        'length' => 1,
                        'notnull' => true,
                        'default' => 0
                    ],
                    'screen_ids' => [
                        'type' => 'text',
                        'length' => 1000,
                        'notnull' => true,
                        'default' => ''
                    ],
                    'permission' => [
                        'type' => 'integer',
                        'length' => 1,
                        'notnull' => true,
                        'default' => 0
                    ],
                ]
            );
            $this->db->addPrimaryKey('help_gt_settings', ['obj_id']);
        }
        if (!$this->db->tableColumnExists('help_gt_settings', 'lang')) {
            $this->db->addTableColumn('help_gt_settings', 'lang', array(
                'type' => 'text',
                'notnull' => true,
                'length' => 10,
                'default' => ''
            ));
        }
    }

Field Documentation

$db

ilDBInterface ILIAS\Help\Setup\ilHelpDBUpdateSteps::$db

protected

Definition at line 23 of file class.ilHelpDBUpdateSteps.php.

Referenced by ILIAS\Help\Setup\ilHelpDBUpdateSteps\prepare().

---

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

• components/ILIAS/Help/Setup/class.ilHelpDBUpdateSteps.php