Inheritance diagram for ILIAS\User\Setup\UserProfileMigrations:

Collaboration diagram for ILIAS\User\Setup\UserProfileMigrations:

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

Private Member Functions
	migrateCustomFieldAccess ()

	migrateStandardFieldConfig ()

	updateCountryField (array $property_attributes)

	fetchConfigValuesFromSettings (string $field_id, array $attributes)

	retrievePropertyAttributeValue (string $field_id, string $attribute)

	insertConfig (string $field_id, int $visible_in_registration, int $visible_to_user, int $visible_in_lua, int $visible_in_crss, int $visible_in_grps, int $visible_in_prgs, int $changeable_by_user, int $changeable_in_lua, int $required, int $export, int $searchable, int $available_in_certs)

Private Attributes
const string	MIGRATION_COMPLETED = 'usr_profile_migration_completed'

ilDBInterface	$db

ilSetting	$settings

AdminInteraction	$admin_interaction

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

Detailed Description

Definition at line 28 of file UserProfileMigrations.php.

Member Function Documentation

◆ fetchConfigValuesFromSettings()

ILIAS\User\Setup\UserProfileMigrations::fetchConfigValuesFromSettings	(	string	$field_id,
		array	$attributes
	)

private

Definition at line 272 of file UserProfileMigrations.php.

     : array {
        return array_map(
            function (string $v) use ($field_id): bool {
                if ($field_id === 'username' && $v === 'usr_settings_disable') {
                    return $this->settings->get('allow_change_loginname', '0') === '1';
                }
                $value = $this->retrievePropertyAttributeValue($field_id, $v);
                if (in_array($v, ['usr_settings_hide', 'usr_settings_disable'])) {
                    return !$value;
                }
                return $value;
            },
            $attributes
        );
    }

References ILIAS\Repository\settings().

Referenced by ILIAS\User\Setup\UserProfileMigrations\migrateStandardFieldConfig(), and ILIAS\User\Setup\UserProfileMigrations\updateCountryField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultAmountOfStepsPerRun()

ILIAS\User\Setup\UserProfileMigrations::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 40 of file UserProfileMigrations.php.

◆ getLabel()

ILIAS\User\Setup\UserProfileMigrations::getLabel ( )

Returns: string - a meaningful and concise description for your migration.

Implements ILIAS\Setup\Migration.

Definition at line 35 of file UserProfileMigrations.php.

                              : string
    {
        return 'Clean-Up and Consolidate User Profile Fields';
    }

◆ getPreconditions()

ILIAS\User\Setup\UserProfileMigrations::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 45 of file UserProfileMigrations.php.

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

◆ getRemainingAmountOfSteps()

ILIAS\User\Setup\UserProfileMigrations::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 68 of file UserProfileMigrations.php.

                                               : int
    {
        return $this->settings->get(self::MIGRATION_COMPLETED) === '1' ? 0 : 1;
    }

References ILIAS\Repository\settings().

Here is the call graph for this function:

◆ insertConfig()

ILIAS\User\Setup\UserProfileMigrations::insertConfig	(	string	$field_id,
		int	$visible_in_registration,
		int	$visible_to_user,
		int	$visible_in_lua,
		int	$visible_in_crss,
		int	$visible_in_grps,
		int	$visible_in_prgs,
		int	$changeable_by_user,
		int	$changeable_in_lua,
		int	$required,
		int	$export,
		int	$searchable,
		int	$available_in_certs
	)

private

Definition at line 296 of file UserProfileMigrations.php.

     : void {
        if ($this->db->fetchAll(
            $this->db->query(
                "SELECT count(field_id) as cnt FROM usr_field_config WHERE field_id='{$field_id}'"
            ),
            \ilDBConstants::FETCHMODE_OBJECT
        )[0]->cnt !== 0) {
            return;
        }
        $this->db->insert(
            'usr_field_config',
            [
                'field_id' => [
                    \ilDBConstants::T_TEXT,
                    $field_id
                ],
                'visible_in_registration' => [
                    \ilDBConstants::T_INTEGER,
                    $visible_in_registration
                ],
                'visible_to_user' => [
                    \ilDBConstants::T_INTEGER,
                    $visible_to_user
                ],
                'visible_in_lua' => [
                    \ilDBConstants::T_INTEGER,
                    $visible_in_lua
                ],
                'visible_in_crss' => [
                    \ilDBConstants::T_INTEGER,
                    $visible_in_crss
                ],
                'visible_in_grps' => [
                    \ilDBConstants::T_INTEGER,
                    $visible_in_grps
                ],
                'visible_in_prgs' => [
                    \ilDBConstants::T_INTEGER,
                    $visible_in_prgs
                ],
                'changeable_by_user' => [
                    \ilDBConstants::T_INTEGER,
                    $changeable_by_user
                ],
                'changeable_in_lua' => [
                    \ilDBConstants::T_INTEGER,
                    $changeable_in_lua
                ],
                'required' => [
                    \ilDBConstants::T_INTEGER,
                    $required
                ],
                'export' => [
                    \ilDBConstants::T_INTEGER,
                    $export
                ],
                'searchable' => [
                    \ilDBConstants::T_INTEGER,
                    $searchable
                ],
                'available_in_certs' => [
                    \ilDBConstants::T_INTEGER,
                    $available_in_certs
                ]
            ]
        );
    }

Referenced by ILIAS\User\Setup\UserProfileMigrations\migrateCustomFieldAccess(), ILIAS\User\Setup\UserProfileMigrations\migrateStandardFieldConfig(), and ILIAS\User\Setup\UserProfileMigrations\updateCountryField().

Here is the caller graph for this function:

◆ migrateCustomFieldAccess()

ILIAS\User\Setup\UserProfileMigrations::migrateCustomFieldAccess ( )

private

Definition at line 73 of file UserProfileMigrations.php.

                                               : void
    {
        if (!$this->db->tableColumnExists('udf_definition', 'prg_export')) {
            return;
        }
 
        $custom_fields_query = $this->db->query('SELECT * FROM udf_definition');
 
        while (($row = $this->db->fetchObject($custom_fields_query))) {
            $this->insertConfig(
                $row->field_id,
                $row->registration_visible,
                $row->visible,
                $row->visible_lua,
                $row->course_export,
                $row->group_export,
                $row->prg_export,
                $row->changeable,
                $row->changeable_lua,
                $row->required,
                $row->export,
                $row->searchable,
                $row->certificate
            );
        }
        $this->db->dropTableColumn(
            'udf_definition',
            'visible'
        );
        $this->db->dropTableColumn(
            'udf_definition',
            'changeable'
        );
        $this->db->dropTableColumn(
            'udf_definition',
            'required'
        );
        $this->db->dropTableColumn(
            'udf_definition',
            'searchable'
        );
        $this->db->dropTableColumn(
            'udf_definition',
            'export'
        );
        $this->db->dropTableColumn(
            'udf_definition',
            'course_export'
        );
        $this->db->dropTableColumn(
            'udf_definition',
            'registration_visible'
        );
        $this->db->dropTableColumn(
            'udf_definition',
            'visible_lua'
        );
        $this->db->dropTableColumn(
            'udf_definition',
            'changeable_lua'
        );
        $this->db->dropTableColumn(
            'udf_definition',
            'group_export'
        );
        $this->db->dropTableColumn(
            'udf_definition',
            'certificate'
        );
        $this->db->dropTableColumn(
            'udf_definition',
            'prg_export'
        );
    }

References ILIAS\User\Setup\UserProfileMigrations\insertConfig().

Referenced by ILIAS\User\Setup\UserProfileMigrations\step().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ migrateStandardFieldConfig()

ILIAS\User\Setup\UserProfileMigrations::migrateStandardFieldConfig ( )

private

Definition at line 148 of file UserProfileMigrations.php.

                                                 : void
    {
        $field_ids = [
            'username',
            'firstname',
            'lastname',
            'title',
            'birthday',
            'gender',
            'avatar',
            'roles',
            'org_units',
            'interests_general' ,
            'interests_help_offered',
            'interests_help_looking',
            'institution',
            'department',
            'street',
            'zipcode',
            'city',
            'country',
            'phone_office',
            'phone_home',
            'phone_mobile',
            'fax',
            'email',
            'second_email',
            'hobby',
            'referral_comment',
            'matriculation',
            'awrn_user_show',
            'allow_contact_request',
            'incoming_mail',
            'language',
            'skin_style',
            'session_reminder'
        ];
 
        $property_attributes = [
            'usr_settings_visib_reg',
            'usr_settings_hide',
            'usr_settings_visib_lua',
            'usr_settings_course_export',
            'usr_settings_group_export',
            'usr_settings_prg_export',
            'usr_settings_disable',
            'usr_settings_changeable_lua',
            'require',
            'usr_settings_export',
            'search_enabled',
            'certificate',
        ];
 
        $this->updateCountryField($property_attributes);
        foreach ($field_ids as $field_id) {
            $this->insertConfig(
                $field_id,
                ...$this->fetchConfigValuesFromSettings($field_id, $property_attributes)
            );
 
            foreach ($property_attributes as $attribute) {
                $this->settings->delete("{$attribute}_{$field_id}");
            }
        }
    }

References ILIAS\User\Setup\UserProfileMigrations\fetchConfigValuesFromSettings(), ILIAS\User\Setup\UserProfileMigrations\insertConfig(), ILIAS\Repository\settings(), and ILIAS\User\Setup\UserProfileMigrations\updateCountryField().

Referenced by ILIAS\User\Setup\UserProfileMigrations\step().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prepare()

ILIAS\User\Setup\UserProfileMigrations::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 54 of file UserProfileMigrations.php.

                                                     : void
    {
        $this->db = $environment->getResource(Environment::RESOURCE_DATABASE);
        $this->settings = $environment->getResource(Environment::RESOURCE_SETTINGS_FACTORY)->settingsFor();
        $this->admin_interaction = $environment->getResource(Environment::RESOURCE_ADMIN_INTERACTION);
    }

References ILIAS\Setup\Environment\getResource(), ILIAS\Setup\Environment\RESOURCE_ADMIN_INTERACTION, ILIAS\Setup\Environment\RESOURCE_DATABASE, ILIAS\Setup\Environment\RESOURCE_SETTINGS_FACTORY, and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ retrievePropertyAttributeValue()

ILIAS\User\Setup\UserProfileMigrations::retrievePropertyAttributeValue	(	string	$field_id,
		string	$attribute
	)

private

Definition at line 291 of file UserProfileMigrations.php.

                                                                                        : bool
    {
        return $this->settings->get("{$attribute}_{$field_id}", '0') === '1';
    }

References ILIAS\Repository\settings().

Here is the call graph for this function:

◆ step()

ILIAS\User\Setup\UserProfileMigrations::step ( Environment $environment )

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 61 of file UserProfileMigrations.php.

                                                  : void
    {
        $this->migrateCustomFieldAccess();
        $this->migrateStandardFieldConfig();
        $this->settings->set(self::MIGRATION_COMPLETED, '1');
    }

References ILIAS\User\Setup\UserProfileMigrations\migrateCustomFieldAccess(), ILIAS\User\Setup\UserProfileMigrations\migrateStandardFieldConfig(), and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ updateCountryField()

ILIAS\User\Setup\UserProfileMigrations::updateCountryField ( array $property_attributes )

private

Definition at line 214 of file UserProfileMigrations.php.

                                                                   : void
    {
        $message = 'ILIAS up to now knows two types of country information: One selectable by a dropdown '
            . 'the other one as a text field. The latter one will be removed. Would you like us to move '
            . 'the current information in the text field to a custom field with the name "Country"? If you '
            . 'choose to not move the information it will simply be deleted.';
 
        if ($this->admin_interaction->confirmOrDeny($message)) {
            $uuid = (new UUIDFactory())->uuid4AsString();
            $this->db->insert(
                'udf_definition',
                [
                    'field_id' => [
                        \ilDBConstants::T_TEXT,
                        $uuid
                    ],
                    'field_name' => [
                        \ilDBConstants::T_TEXT,
                        'Country'
                    ],
                    'field_type' => [
                        \ilDBConstants::T_TEXT,
                        Text::class
                    ],
                    'section' => [
                        \ilDBConstants::T_TEXT,
                        AvailableSections::ContactData->value
                    ]
                ]
            );
            $this->insertConfig(
                $uuid,
                ...$this->fetchConfigValuesFromSettings('old_country', $property_attributes)
            );
            $query = $this->db->query(
                'SELECT usr_id, old_country FROM usr_data WHERE old_country IS NOT NULL AND NOT old_country = ""'
            );
 
            $insert = [];
            while (($row = $this->db->fetchObject($query))) {
                $insert[] = "('{$row->usr_id}', '{$uuid}', {$this->db->quote($row->old_country, \ilDBConstants::T_TEXT)})";
            }
 
            if ($insert === []) {
                return;
            }
 
            $this->db->manipulate(
                'INSERT INTO usr_profile_data (usr_id, field_id, value) VALUES ' . implode(',', $insert)
            );
        }
 
        foreach ($property_attributes as $attribute) {
            $this->settings->delete("{$attribute}_old_country");
        }
        $this->db->dropTableColumn('usr_data', 'old_country');
    }

References $message, ILIAS\User\Setup\UserProfileMigrations\fetchConfigValuesFromSettings(), ILIAS\User\Setup\UserProfileMigrations\insertConfig(), ILIAS\Repository\settings(), and ilDBConstants\T_TEXT.

Referenced by ILIAS\User\Setup\UserProfileMigrations\migrateStandardFieldConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $admin_interaction

AdminInteraction ILIAS\User\Setup\UserProfileMigrations::$admin_interaction

private

Definition at line 33 of file UserProfileMigrations.php.

◆ $db

ilDBInterface ILIAS\User\Setup\UserProfileMigrations::$db

private

Definition at line 31 of file UserProfileMigrations.php.

◆ $settings

ilSetting ILIAS\User\Setup\UserProfileMigrations::$settings

private

Definition at line 32 of file UserProfileMigrations.php.

◆ MIGRATION_COMPLETED

const string ILIAS\User\Setup\UserProfileMigrations::MIGRATION_COMPLETED = 'usr_profile_migration_completed'

private

Definition at line 30 of file UserProfileMigrations.php.

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

components/ILIAS/User/src/Setup/UserProfileMigrations.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ fetchConfigValuesFromSettings()

◆ getDefaultAmountOfStepsPerRun()

◆ getLabel()

◆ getPreconditions()

◆ getRemainingAmountOfSteps()

◆ insertConfig()

◆ migrateCustomFieldAccess()

◆ migrateStandardFieldConfig()

◆ prepare()

◆ retrievePropertyAttributeValue()

◆ step()

◆ updateCountryField()

Field Documentation

◆ $admin_interaction

◆ $db

◆ $settings

◆ MIGRATION_COMPLETED