ilContentStyle9Migration Class Reference

Inheritance diagram for ilContentStyle9Migration:

Collaboration diagram for ilContentStyle9Migration:

Public Member Functions
	getLabel ()
	getDefaultAmountOfStepsPerRun ()
	Tell the default amount of steps to be executed for one run of the migration. More...
	getPreconditions (Environment $environment)
	Objectives the migration depend on. More...
	prepare (Environment $environment)
	Prepare the migration by means of some environment. More...
	step (Environment $environment)
	Run one step of the migration. More...
	getRemainingAmountOfSteps ()
	Count up how many "things" need to be migrated. More...

Protected Attributes
ilDBInterface	$db

Additional Inherited Members
Data Fields inherited from ILIAS\Setup\Migration
const	INFINITE = -1

Detailed Description

Definition at line 24 of file class.ilContentStyle9Migration.php.

Member Function Documentation

getDefaultAmountOfStepsPerRun()

ilContentStyle9Migration::getDefaultAmountOfStepsPerRun

(

)

Tell the default amount of steps to be executed for one run of the migration.

Return Migration::INFINITE if all units should be migrated at once.

Implements ILIAS\Setup\Migration.

Definition at line 33 of file class.ilContentStyle9Migration.php.

                                                   : int
    {
        return 50000;
    }

getLabel()

ilContentStyle9Migration::getLabel

(

)

Returns

string - a meaningful and concise description for your migration.

Implements ILIAS\Setup\Migration.

Definition at line 28 of file class.ilContentStyle9Migration.php.

                              : string
    {
        return "Migrate content styles to ILIAS 9.";
    }

getPreconditions()

ilContentStyle9Migration::getPreconditions

(

Environment

$environment

)

Objectives the migration depend on.

Exceptions

UnachievableException

if the objective is not achievable

Returns

Objective[]

Implements ILIAS\Setup\Migration.

Definition at line 38 of file class.ilContentStyle9Migration.php.

                                                              : array
    {
        return [
            new ilIniFilesLoadedObjective(),
            new ilDatabaseInitializedObjective(),
            new ilDatabaseUpdatedObjective(),
            new ilDatabaseUpdateStepsExecutedObjective(new ilResourceStorageDB90())
        ];
    }

getRemainingAmountOfSteps()

ilContentStyle9Migration::getRemainingAmountOfSteps

(

)

Count up how many "things" need to be migrated.

This helps the admin to decide how big he can create the steps and also how long a migration takes

Implements ILIAS\Setup\Migration.

Definition at line 117 of file class.ilContentStyle9Migration.php.

                                               : int
    {
        $set = $this->db->queryF(
            "SELECT count(*) as amount FROM style_parameter " .
            " WHERE type = %s AND tag = %s",
            ["text", "text"],
            ["text_block", "div"]
        );
        if ($rec = $this->db->fetchAssoc($set)) {
            return (int) $rec["amount"];
        }

        return 0;
    }

prepare()

ilContentStyle9Migration::prepare

(

Environment

$environment

)

Prepare the migration by means of some environment.

This is not supposed to modify the environment, but will be run to prime the migration object to run step and getRemainingAmountOfSteps afterwards.

Implements ILIAS\Setup\Migration.

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

References ILIAS\Setup\Environment\getResource().

                                                     : void
    {
        $this->db = $environment->getResource(Environment::RESOURCE_DATABASE);
        /*
        $ilias_ini = $environment->getResource(Environment::RESOURCE_ILIAS_INI);
        $client_id = $environment->getResource(Environment::RESOURCE_CLIENT_ID);
        $data_dir = $ilias_ini->readVariable('clients', 'datadir');
        $client_data_dir = "{$data_dir}/{$client_id}";
        if (!defined("CLIENT_WEB_DIR")) {
            define("CLIENT_WEB_DIR", dirname(__DIR__, 4) . "/data/" . $client_id);
        }
        if (!defined("ILIAS_WEB_DIR")) {
            define("ILIAS_WEB_DIR", dirname(__DIR__, 4));
        }
        if (!defined("CLIENT_ID")) {
            define("CLIENT_ID", $client_id);
        }
        if (!defined("ILIAS_DATA_DIR")) {
            define("ILIAS_DATA_DIR", $data_dir);
        }*/
    }

Here is the call graph for this function:

step()

ilContentStyle9Migration::step

(

Environment

$environment

)

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 70 of file class.ilContentStyle9Migration.php.

                                                  : void
    {
        $set = $this->db->queryF(
            "SELECT * FROM style_parameter " .
            " WHERE type = %s AND tag = %s LIMIT 1",
            ["text", "text"],
            ["text_block", "div"]
        );
        if ($rec = $this->db->fetchAssoc($set)) {
            // check, if a similar parameter is not already been set
            $set2 = $this->db->queryF(
                "SELECT * FROM style_parameter " .
                " WHERE style_id = %s AND tag = %s AND class = %s AND type = %s AND parameter = %s",
                ["integer", "text", "text", "text", "text"],
                [$rec["style_id"], "p", $rec["class"], "text_block", $rec["parameter"]]
            );
            if (!$this->db->fetchAssoc($set2)) {
                $this->db->update(
                    "style_parameter",
                    [
                    "tag" => ["text", "p"]
                ],
                    [    // where
                        "id" => ["integer", $rec["id"]]
                    ]
                );

                $this->db->update(
                    "style_data",
                    [
                    "uptodate" => ["integer", 0]
                ],
                    [    // where
                        "id" => ["integer", $rec["style_id"]]
                    ]
                );
            } else {
                $this->db->manipulateF(
                    "DELETE FROM style_parameter WHERE " .
                    " id = %s",
                    ["integer"],
                    [$rec["id"]]
                );
            }
        }
    }

Field Documentation

$db

ilDBInterface ilContentStyle9Migration::$db

protected

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

---

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

• Services/Style/Content/Setup/class.ilContentStyle9Migration.php