ilMobLastChangeMigration Class Reference

Inheritance diagram for ilMobLastChangeMigration:

Collaboration diagram for ilMobLastChangeMigration:

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...
	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.ilMobLastChangeMigration.php.

Member Function Documentation

getDefaultAmountOfStepsPerRun()

ilMobLastChangeMigration::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.ilMobLastChangeMigration.php.

                                                   : int
    {
        return 10000;
    }

getLabel()

ilMobLastChangeMigration::getLabel

(

)

Returns

string - a meaningful and concise description for your migration.

Implements ILIAS\Setup\Migration.

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

                              : string
    {
        return 'Migration for setting date of last change of existing media objects to their creation date.';
    }

getPreconditions()

ilMobLastChangeMigration::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.ilMobLastChangeMigration.php.

                                                              : array
    {
        return [
            new \ilDatabaseInitializedObjective(),
            new \ilDatabaseUpdatedObjective()
        ];
    }

getRemainingAmountOfSteps()

ilMobLastChangeMigration::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 71 of file class.ilMobLastChangeMigration.php.

                                               : int
    {
        $res = $this->db->query(
            "SELECT COUNT(mob_data.id) AS count FROM mob_data JOIN object_data ON object_data.obj_id = mob_data.id" .
            " WHERE last_change = 0"
        );
        if ($row = $this->db->fetchAssoc($res)) {
            return $row['count'] ?? 0;
        }
        return 0;
    }

References $res.

prepare()

ilMobLastChangeMigration::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 46 of file class.ilMobLastChangeMigration.php.

                                                     : void
    {
        $this->db = $environment->getResource(Environment::RESOURCE_DATABASE);
    }

References ILIAS\Setup\Environment\getResource().

Here is the call graph for this function:

step()

ilMobLastChangeMigration::step

(

Environment

$environment

)

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 51 of file class.ilMobLastChangeMigration.php.

                                                  : void
    {
        $res = $this->db->query(
            "SELECT mob_data.id AS mob_id, object_data.create_date AS date FROM mob_data" .
            " LEFT JOIN object_data ON object_data.obj_id = mob_data.id" .
            " WHERE last_change = 0 ORDER BY mob_id LIMIT 1"
        );
        if (!($row = $this->db->fetchAssoc($res))) {
            return;
        }
        $mob_id = (int) $row['mob_id'];
        $date = new DateTimeImmutable((string) $row['date']);
 
        $this->db->update(
            'mob_data',
            ['last_change' => ['integer', $date->getTimestamp()]],
            ['id' => ['integer', $mob_id]]
        );
    }

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

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilMobLastChangeMigration::$db

protected

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

---

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

• components/ILIAS/MediaObjects/classes/Setup/class.ilMobLastChangeMigration.php