GUI class for personal profile. More...

Collaboration diagram for ILIAS\User\Profile\PersonalProfileGUI:

Public Member Functions
	executeCommand ()

	userSettingVisible (string $setting)

	showProfile ()
	show profile form More...

	setTabs ()

	setHeader ()

	showPersonalData (bool $a_no_init=false)

	initPersonalDataForm ()

	savePersonalData ()

	goToEmailConfirmation ()

	changeEmail ()

	showPublicProfile (bool $a_no_init=false)

	showPublicProfileFields (\ilPropertyFormGUI $form, ?array $prefs=null, \ilRadioOption\|\ilCheckboxGroupInputGUI\|null $parent=null, bool $anonymized=false, string $key_suffix='')

	savePublicProfile ()

	showExportImport ()

	exportPersonalData ()

	downloadPersonalData ()
	Download personal data export file. More...

	importPersonalDataSelection ()

	initPersonalDataImportForm ()

	importPersonalData ()

Data Fields
const	CHANGE_EMAIL_CMD = 'changeEmail'

Private Member Functions
	buildInfoText ()

	emailChanged ()

	emailCompletionForced ()

	addEmailChangeModal ()

	loginChanged ()

	updateLoginOrSetErrorMessages ()

	addDataFromFormToUser ()

	getProfilePortfolio ()

	initPublicProfileForm ()

	showChecklist (int $active_step)

	getPublishedFromPost (string $identifier)

	buildKeySuffix ()

Private Attributes
const	PERSONAL_DATA_FORM_ID = 'pd'

const	PUBLISH_SETTINGS_PREFIX = 'chk_'

ilGlobalTemplateInterface	$tpl

ilAppEventHandler	$event

ilPropertyFormGUI	$form

ilSetting	$settings

ilObjUser	$user

ilAuthSession	$auth_session

StaticUrlServices	$static_url

Language	$lng

ilCtrl	$ctrl

ilTabsGUI	$tabs

ilToolbarGUI	$toolbar

ilHelpGUI	$help

HTTP	$http

ilErrorHandling	$error_handler

ChecklistGUI	$checklist

ChecklistStatus	$checklist_status

UIFactory	$ui_factory

UIRenderer	$ui_renderer

Refinery	$refinery

ChangeMailRepository	$change_mail_token_repo

PromptRepository	$prompt_repository

GUIRequest	$profile_request

Profile	$profile

UserSettings	$user_settings

ilLogger	$logger

FileUpload	$uploads

Interruptive	$email_change_confirmation_modal = null

Detailed Description

GUI class for personal profile.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de @ilCtrl_Calls ILIAS\User\Profile\PersonalProfileGUI: ILIAS\User\Profile\PublicProfileGUI @ilCtrl_Calls ILIAS\User\Profile\PersonalProfileGUI: ILIAS\User\Privacy\SettingsGUI @ilCtrl_Calls ILIAS\User\Profile\PersonalProfileGUI: ilLegalDocumentsAgreementGUI, ilLegalDocumentsWithdrawalGUI

Definition at line 49 of file class.PersonalProfileGUI.php.

Member Function Documentation

◆ addDataFromFormToUser()

ILIAS\User\Profile\PersonalProfileGUI::addDataFromFormToUser ( )

private

Definition at line 478 of file class.PersonalProfileGUI.php.

                                            : void
    {
        $this->user = $this->profile->addFormValuesToUser($this->form, Context::User, $this->user);
        $this->user->setProfileIncomplete(false);
 
        $this->user->setTitle($this->user->getFullname());
        $this->user->setDescription($this->user->getEmail());
    }

References ILIAS\Repository\form(), ILIAS\Repository\profile(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ addEmailChangeModal()

ILIAS\User\Profile\PersonalProfileGUI::addEmailChangeModal ( )

private

Definition at line 391 of file class.PersonalProfileGUI.php.

                                          : bool
    {
        $form_id = 'form_' . self::PERSONAL_DATA_FORM_ID;
 
        $message = $this->lng->txt('confirm_logout_for_email_change');
        if ((int) $this->settings->get('new_registration_type', '1') === \ilRegistrationSettings::IL_REG_ACTIVATION) {
            $message .= '<br>' . $this->lng->txt('confirm_logout_for_email_change_with_confirmation');
        }
 
        $modal = $this->ui_factory->modal()->interruptive(
            $this->lng->txt('confirm'),
            $message,
            ''
        )->withActionButtonLabel($this->lng->txt('change'));
        $this->email_change_confirmation_modal = $modal->withOnLoad($modal->getShowSignal())
            ->withAdditionalOnLoadCode(
                static function ($id) use ($form_id) {
                    return "var button = {$id}.querySelector('input[type=\"submit\"]'); "
                    . "button.addEventListener('click', (e) => {e.preventDefault();"
                    . "document.getElementById('{$form_id}').submit();});";
                }
            );
 
        $this->form->setFormAction($this->ctrl->getFormActionByClass(self::class, 'goToEmailConfirmation'));
        return true;
    }

References $id, $message, ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ilRegistrationSettings\IL_REG_ACTIVATION, ILIAS\Repository\lng(), and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ buildInfoText()

ILIAS\User\Profile\PersonalProfileGUI::buildInfoText ( )

private

Definition at line 288 of file class.PersonalProfileGUI.php.

                                    : string
    {
        $change_mail_info = '';
        if ($this->change_mail_token_repo->hasUserValidEmailConfirmationToken($this->user)) {
            $change_mail_info = $this->lng->txt('change_email_info_message');
        }
 
        $it = '';
        if ($this->profile_request->getPrompted() === 1) {
            $it = $this->prompt_repository->getSettings()->getPromptText($this->user->getLanguage());
        }
        if ($it === '') {
            $it = $this->prompt_repository->getSettings()->getInfoText($this->user->getLanguage());
        }
        if (trim($it) === '') {
            return $change_mail_info === ''
                ? ''
                : $this->ui_renderer->render($this->ui_factory->messageBox()->info($change_mail_info));
        }
 
        if ($change_mail_info !== '') {
            $it .= '<br>' . $change_mail_info;
        }
 
        $pub_prof = in_array($this->user->getPref('public_profile'), ['y', 'n', 'g'])
            ? $this->user->getPref('public_profile')
            : 'n';
        $box = $this->ui_factory->messageBox()->info($it);
        if ($pub_prof === 'n') {
            $box = $box->withLinks(
                [$this->ui_factory->link()->standard(
                    $this->lng->txt('user_make_profile_public'),
                    $this->ctrl->getLinkTarget($this, 'showPublicProfile')
                )]
            );
        }
        return $this->ui_renderer->render($box);
    }

References ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ buildKeySuffix()

ILIAS\User\Profile\PersonalProfileGUI::buildKeySuffix ( )

private

Definition at line 893 of file class.PersonalProfileGUI.php.

                                     : string
    {
        switch ($this->form->getInput('public_profile')) {
            case 'y':
                return '-1';
            case 'g':
                return '-2';
            default:
                return '';
        }
    }

References ILIAS\Repository\form().

Here is the call graph for this function:

◆ changeEmail()

ILIAS\User\Profile\PersonalProfileGUI::changeEmail ( )

Definition at line 487 of file class.PersonalProfileGUI.php.

                                 : void
    {
        $token = $this->change_mail_token_repo->getTokenForTokenString(
            $this->profile_request->getToken(),
            $this->user
        );
 
        if ($token === null) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('email_could_not_be_changed'));
            $this->showPublicProfile();
            return;
        }
 
        if ($token->getStatus() === ChangeMailStatus::Login
            && (int) $this->settings->get('new_registration_type', '1') === \ilRegistrationSettings::IL_REG_ACTIVATION) {
            (new ChangeMailMail(
                $this->user,
                $this->change_mail_token_repo->moveToNextStep($token, time())
                        ->getUriForStatus($this->static_url->builder()),
                $this->lng,
                $this->logger
            ))->send($token->getNewEmail(), ChangeMailStatus::EmailConfirmation->getValidity($this->settings));
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('change_email_email_sent'));
            $this->showPublicProfile();
            return;
        }
 
        $this->user->setEmail($token->getNewEmail());
        $this->user->update();
        $this->change_mail_token_repo->deleteEntryByToken($token->getToken());
        $this->change_mail_token_repo->deleteExpiredEntries();
 
        $this->tpl->setOnScreenMessage(
            'success',
            $this->lng->txt('saved_successfully')
        );
        $this->showPublicProfile();
        return;
    }

References $token, ilRegistrationSettings\IL_REG_ACTIVATION, ILIAS\Repository\lng(), send(), ILIAS\Repository\settings(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ downloadPersonalData()

ILIAS\User\Profile\PersonalProfileGUI::downloadPersonalData ( )

Download personal data export file.

Definition at line 802 of file class.PersonalProfileGUI.php.

                                          : void
    {
        $this->user->sendPersonalDataFile();
    }

References ILIAS\Repository\user().

Here is the call graph for this function:

◆ emailChanged()

ILIAS\User\Profile\PersonalProfileGUI::emailChanged ( )

private

Definition at line 366 of file class.PersonalProfileGUI.php.

                                   : bool
    {
        $email_input = $this->form->getItemByPostVar('usr_email');
        if ($email_input !== null && !$email_input->getDisabled()
            && $this->form->getInput('usr_email') !== $this->user->getEmail()) {
            return true;
        }
 
        return false;
    }

References ILIAS\Repository\form().

Here is the call graph for this function:

◆ emailCompletionForced()

ILIAS\User\Profile\PersonalProfileGUI::emailCompletionForced ( )

private

Definition at line 377 of file class.PersonalProfileGUI.php.

                                            : bool
    {
        $current_email = $this->user->getEmail();
        if (
            $this->user->getProfileIncomplete()
            && $this->settings->get('require_email') === '1'
            && ($current_email === null || $current_email === '')
        ) {
            return true;
        }
 
        return false;
    }

References ILIAS\Repository\user().

Here is the call graph for this function:

◆ executeCommand()

ILIAS\User\Profile\PersonalProfileGUI::executeCommand ( )

Definition at line 145 of file class.PersonalProfileGUI.php.

                                    : void
    {
        $next_class = $this->ctrl->getNextClass();
 
        switch ($next_class) {
            case strtolower(PublicProfileGUI::class):
                $pub_profile_gui = new PublicProfileGUI($this->user->getId());
                $pub_profile_gui->setBackUrl($this->ctrl->getLinkTarget($this, 'showPersonalData'));
                $this->ctrl->forwardCommand($pub_profile_gui);
                $this->tpl->printToStdout();
                break;
 
            case strtolower(PrivacySettingsGUI::class):
                $this->setHeader();
                $this->setTabs();
                $this->tabs->activateTab('visibility_settings');
                $this->showChecklist(ChecklistStatus::STEP_VISIBILITY_OPTIONS);
                $this->ctrl->forwardCommand(
                    new PrivacySettingsGUI(
                        $this->lng,
                        $this->ctrl,
                        $this->event,
                        $this->http->request(),
                        $this->user,
                        $this->settings,
                        $this->tpl,
                        $this->ui_factory,
                        $this->ui_renderer,
                        $this->user_settings,
                        new Visibility(
                            $this->lng,
                            $this->settings,
                            $this->user
                        ),
                        $this->checklist_status,
                        new \ilSetting('chatroom'),
                        new \ilSetting('notifications')
                    )
                );
                break;
 
            case strtolower(\ilLegalDocumentsAgreementGUI::class):
                $this->ctrl->forwardCommand(new \ilLegalDocumentsAgreementGUI());
                $this->tpl->printToStdout();
                break;
 
            case strtolower(\ilLegalDocumentsWithdrawalGUI::class):
                $this->ctrl->forwardCommand(new \ilLegalDocumentsWithdrawalGUI());
                $this->tpl->printToStdout();
                break;
 
            default:
                $this->setTabs();
                $cmd = $this->ctrl->getCmd('showPersonalData');
                $this->$cmd();
                break;
        }
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\event(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\User\Profile\PersonalProfileGUI\setHeader(), ILIAS\User\Profile\PersonalProfileGUI\setTabs(), ILIAS\Repository\settings(), ILIAS\User\Profile\PersonalProfileGUI\showChecklist(), ILIAS\User\Profile\ChecklistStatus\STEP_VISIBILITY_OPTIONS, ILIAS\Repository\tabs(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ exportPersonalData()

ILIAS\User\Profile\PersonalProfileGUI::exportPersonalData ( )

Definition at line 792 of file class.PersonalProfileGUI.php.

                                        : void
    {
        $this->user->exportPersonalData();
        $this->user->sendPersonalDataFile();
        $this->ctrl->redirect($this, 'showExportImport');
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ getProfilePortfolio()

ILIAS\User\Profile\PersonalProfileGUI::getProfilePortfolio ( )

private

Definition at line 542 of file class.PersonalProfileGUI.php.

                                          : ?int
    {
        if ($this->settings->get('user_portfolios')) {
            return \ilObjPortfolio::getDefaultPortfolio($this->user->getId());
        }
        return null;
    }

References ILIAS\Repository\settings(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ getPublishedFromPost()

ILIAS\User\Profile\PersonalProfileGUI::getPublishedFromPost ( string $identifier )

private

Definition at line 879 of file class.PersonalProfileGUI.php.

                                                             : bool
    {
        $key = self::PUBLISH_SETTINGS_PREFIX . $identifier . $this->buildKeySuffix();
 
        if (!$this->http->wrapper()->post()->has($key)) {
            return false;
        }
 
        return $this->http->wrapper()->post()->retrieve(
            $key,
            $this->refinery->kindlyTo()->string()
        ) === '1';
    }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ goToEmailConfirmation()

ILIAS\User\Profile\PersonalProfileGUI::goToEmailConfirmation ( )

Definition at line 453 of file class.PersonalProfileGUI.php.

                                           : void
    {
        $this->initPersonalDataForm();
        if (!$this->form->checkInput()
            || $this->loginChanged() && !$this->updateLoginOrSetErrorMessages()) {
            $this->form->setValuesByPost();
            $this->showPersonalData(true);
            return;
        }
        $this->addDataFromFormToUser();
        $this->user->update();
 
        \ilSession::setClosingContext(\ilSession::SESSION_CLOSE_USER);
        $this->auth_session->logout();
        session_unset();
        $token = $this->change_mail_token_repo->getNewTokenForUser(
            $this->user,
            $this->form->getInput('usr_email'),
            time()
        );
        $this->ctrl->redirectToURL(
            $token->getUriForStatus($this->static_url->builder())->__toString()
        );
    }

References $token, ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ilSession\SESSION_CLOSE_USER, ilSession\setClosingContext(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ importPersonalData()

ILIAS\User\Profile\PersonalProfileGUI::importPersonalData ( )

Definition at line 851 of file class.PersonalProfileGUI.php.

                                        : void
    {
        $this->initPersonalDataImportForm();
        if ($this->form->checkInput()) {
            $this->user->importPersonalData(
                $_FILES['file'],
                (bool) $this->form->getInput('profile_data'),
                (bool) $this->form->getInput('settings'),
                (bool) $this->form->getInput('notes'),
                (bool) $this->form->getInput('calendar')
            );
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
            $this->ctrl->redirect($this, '');
        } else {
            $this->tabs->activateTab('export');
            $this->setHeader();
            $this->form->setValuesByPost();
            $this->tpl->setContent($this->form->getHTML());
            $this->tpl->printToStdout();
        }
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ILIAS\Repository\lng(), ILIAS\Repository\tabs(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ importPersonalDataSelection()

ILIAS\User\Profile\PersonalProfileGUI::importPersonalDataSelection ( )

Definition at line 807 of file class.PersonalProfileGUI.php.

                                                 : void
    {
        $this->tabs->activateTab('export');
        $this->setHeader();
 
        $this->initPersonalDataImportForm();
 
        $this->tpl->setContent($this->form->getHTML());
        $this->tpl->printToStdout();
    }

References ILIAS\Repository\form(), and ILIAS\Repository\tabs().

Here is the call graph for this function:

◆ initPersonalDataForm()

ILIAS\User\Profile\PersonalProfileGUI::initPersonalDataForm ( )

Definition at line 327 of file class.PersonalProfileGUI.php.

                                          : void
    {
        $this->form = new \ilPropertyFormGUI();
        $this->form->setFormAction($this->ctrl->getFormAction($this));
        $this->form->setId(self::PERSONAL_DATA_FORM_ID);
 
        $this->form = $this->profile->addFieldsToForm($this->form, Context::User, true, $this->user);
 
        $this->form->addCommandButton('savePersonalData', $this->lng->txt('user_save_continue'));
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ILIAS\Repository\lng(), ILIAS\Repository\profile(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ initPersonalDataImportForm()

ILIAS\User\Profile\PersonalProfileGUI::initPersonalDataImportForm ( )

Definition at line 818 of file class.PersonalProfileGUI.php.

                                                : void
    {
        $this->form = new \ilPropertyFormGUI();
 
        // input file
        $fi = new \ilFileInputGUI($this->lng->txt('file'), 'file');
        $fi->setRequired(true);
        $fi->setSuffixes(['zip']);
        $this->form->addItem($fi);
 
        // profile data
        $cb = new \ilCheckboxInputGUI($this->lng->txt('pd_profile_data'), 'profile_data');
        $this->form->addItem($cb);
 
        // settings
        $cb = new \ilCheckboxInputGUI($this->lng->txt('settings'), 'settings');
        $this->form->addItem($cb);
 
        // personal notes
        $cb = new \ilCheckboxInputGUI($this->lng->txt('notes'), 'notes');
        $this->form->addItem($cb);
 
        // calendar entries
        $cb = new \ilCheckboxInputGUI($this->lng->txt('pd_private_calendars'), 'calendar');
        $this->form->addItem($cb);
 
        $this->form->addCommandButton('importPersonalData', $this->lng->txt('import'));
        $this->form->addCommandButton('showExportImport', $this->lng->txt('cancel'));
 
        $this->form->setTitle($this->lng->txt('pd_import_personal_data'));
        $this->form->setFormAction($this->ctrl->getFormAction($this));
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\form(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ initPublicProfileForm()

ILIAS\User\Profile\PersonalProfileGUI::initPublicProfileForm ( )

private

Definition at line 550 of file class.PersonalProfileGUI.php.

                                            : void
    {
        $this->form = new \ilPropertyFormGUI();
 
        $this->form->setTitle($this->lng->txt('user_publish_options'));
        $this->form->setDescription($this->lng->txt('user_public_profile_info'));
        $this->form->setFormAction($this->ctrl->getFormAction($this));
 
        $portfolio_id = $this->getProfilePortfolio();
 
        if (!$portfolio_id) {
            // Activate public profile
            $radg = new \ilRadioGroupInputGUI($this->lng->txt('user_activate_public_profile'), 'public_profile');
            $info = $this->lng->txt('user_activate_public_profile_info');
            $radg->setValue(
                (new Visibility($this->lng, $this->settings, $this->user))->getMode()
            );
            $op1 = new \ilRadioOption($this->lng->txt('usr_public_profile_disabled'), 'n', $this->lng->txt('usr_public_profile_disabled_info'));
            $radg->addOption($op1);
            $op2 = new \ilRadioOption($this->lng->txt('usr_public_profile_logged_in'), 'y');
            $radg->addOption($op2);
            if ($this->settings->get('enable_global_profiles')) {
                $op3 = new \ilRadioOption($this->lng->txt('usr_public_profile_global'), 'g');
                $radg->addOption($op3);
            }
            $this->form->addItem($radg);
 
            // #11773
            if ($this->settings->get('user_portfolios')) {
                // #10826
                $href = $this->ctrl->getLinkTargetByClass(\ilDashboardGUI::class, 'jumpToPortfolio');
                $prtf = '<br />' . $this->lng->txt('user_profile_portfolio');
                $prtf .= '<br /><a href="' . $href . '">&raquo; ' .
                    $this->lng->txt('user_portfolios') . '</a>';
                $info .= $prtf;
            }
 
            $radg->setInfo($info);
        } else {
            $this->ctrl->setParameterByClass(\ilDashboardGUI::class, 'prt_id', $portfolio_id);
            $href = $this->ctrl->getLinkTargetByClass(\ilDashboardGUI::class, 'jumpToPortfolio');
            $this->ctrl->clearParameterByClass(\ilDashboardGUI::class, 'prt_id');
            $prtf = $this->lng->txt('user_profile_portfolio_selected');
            $prtf .= '<br /><a href="' . $href . '">&raquo; ' .
                $this->lng->txt('portfolio') . '</a>';
 
            $info = new \ilCustomInputGUI($this->lng->txt('user_activate_public_profile'));
            $info->setHtml($prtf);
            $this->form->addItem($info);
            $this->showPublicProfileFields($this->form);
        }
 
        if (isset($op2)) {
            $this->showPublicProfileFields($this->form, null, $op2, false, '-1');
        }
        if (isset($op3)) {
            $this->showPublicProfileFields($this->form, null, $op3, false, '-2');
        }
        $this->form->setForceTopButtons(true);
        $this->form->addCommandButton('savePublicProfile', $this->lng->txt('user_save_continue'));
    }

References $info, ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ loginChanged()

ILIAS\User\Profile\PersonalProfileGUI::loginChanged ( )

private

Definition at line 418 of file class.PersonalProfileGUI.php.

                                   : bool
    {
        if ($this->profile->userFieldEditableByUser('username')
            && $this->form->getInput('username') !== $this->user->getLogin()) {
            return true;
        }
 
        return false;
    }

References ILIAS\Repository\profile().

Here is the call graph for this function:

◆ savePersonalData()

ILIAS\User\Profile\PersonalProfileGUI::savePersonalData ( )

Definition at line 338 of file class.PersonalProfileGUI.php.

                                      : void
    {
        $this->initPersonalDataForm();
        $this->uploads->process();
 
        if (!$this->form->checkInput()
            || !$this->emailCompletionForced()
                && $this->emailChanged()
                && $this->addEmailChangeModal()
            || $this->loginChanged() && !$this->updateLoginOrSetErrorMessages()) {
            $this->form->setValuesByPost();
            $this->profile->tempStorePicture($this->form);
            $this->showPersonalData(true);
            return;
        }
 
        $this->addDataFromFormToUser();
 
        $this->user = $this->checklist_status->setStepSucessOnUser(
            ChecklistStatus::STEP_PROFILE_DATA,
            $this->user
        );
        $this->user->update();
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
        $this->ctrl->redirect($this, 'showPublicProfile');
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ILIAS\Repository\lng(), ILIAS\Repository\profile(), ILIAS\User\Profile\ChecklistStatus\STEP_PROFILE_DATA, and ILIAS\Repository\user().

Here is the call graph for this function:

◆ savePublicProfile()

ILIAS\User\Profile\PersonalProfileGUI::savePublicProfile ( )

Definition at line 714 of file class.PersonalProfileGUI.php.

                                       : void
    {
        $this->initPublicProfileForm();
        if (!$this->form->checkInput()) {
            $this->form->setValuesByPost();
            $this->tpl->showPublicProfile(true);
        }
 
        if ($this->form->getInput('public_profile') !== '') {
            $this->user->setPref('public_profile', $this->form->getInput('public_profile'));
        }
 
        $this->user = array_reduce(
            $this->profile->getVisibleFields(Context::User, $this->user),
            fn(\ilObjUser $c, ProfileField $v): \ilObjUser =>
                $v->setPublishedOnUser($c, $this->getPublishedFromPost($v->getIdentifier())),
            $this->user
        );
 
        if (\ilBadgeHandler::getInstance()->isActive()) {
            $badge_positions = $this->form->getInput('bpos' . $this->buildKeySuffix()) ?? [];
            if (is_array($badge_positions) && $badge_positions !== []) {
                \ilBadgeAssignment::updatePositions($this->user->getId(), $badge_positions);
            }
        }
 
        $this->user = $this->checklist_status->setStepSucessOnUser(
            ChecklistStatus::STEP_PUBLISH_OPTIONS,
            $this->user
        );
        $this->user->update();
 
        // update lucene index
        \ilLuceneIndexer::updateLuceneIndex([(int) $this->user->getId()]);
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
 
        if (\ilSession::get('orig_request_target')) {
            $target = \ilSession::get('orig_request_target');
            \ilSession::set('orig_request_target', '');
            \ilUtil::redirect($target);
        }
 
        $this->ctrl->redirectByClass([self::class, PrivacySettingsGUI::class], '');
    }

References $c, ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ilSession\get(), ilBadgeHandler\getInstance(), ILIAS\Repository\lng(), ILIAS\Repository\profile(), ilUtil\redirect(), ilSession\set(), ilLuceneIndexer\updateLuceneIndex(), ilBadgeAssignment\updatePositions(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ setHeader()

ILIAS\User\Profile\PersonalProfileGUI::setHeader ( )

Definition at line 256 of file class.PersonalProfileGUI.php.

                               : void
    {
        $this->tpl->setTitle($this->lng->txt('personal_profile'));
    }

References ILIAS\Repository\lng().

Referenced by ILIAS\User\Profile\PersonalProfileGUI\executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTabs()

ILIAS\User\Profile\PersonalProfileGUI::setTabs ( )

Definition at line 220 of file class.PersonalProfileGUI.php.

                             : void
    {
        $this->help->setScreenIdComponent('user');
 
        // personal data
        $this->tabs->addTab(
            'personal_data',
            $this->lng->txt('user_profile_data'),
            $this->ctrl->getLinkTarget($this, 'showPersonalData')
        );
 
        // publishing options
        $this->tabs->addTab(
            'public_profile',
            $this->lng->txt('user_publish_options'),
            $this->ctrl->getLinkTarget($this, 'showPublicProfile')
        );
 
        // visibility settings
        $txt_visibility = $this->checklist_status->anyVisibilitySettings()
            ? $this->lng->txt('user_visibility_settings')
            : $this->lng->txt('preview');
        $this->tabs->addTab(
            'visibility_settings',
            $txt_visibility,
            $this->ctrl->getLinkTargetByClass(PrivacySettingsGUI::class, '')
        );
 
        // export
        $this->tabs->addTab(
            'export',
            $this->lng->txt('export') . '/' . $this->lng->txt('import'),
            $this->ctrl->getLinkTarget($this, 'showExportImport')
        );
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

Referenced by ILIAS\User\Profile\PersonalProfileGUI\executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showChecklist()

ILIAS\User\Profile\PersonalProfileGUI::showChecklist ( int $active_step )

private

Definition at line 873 of file class.PersonalProfileGUI.php.

                                                    : void
    {
        $main_tpl = $this->tpl;
        $main_tpl->setRightContent($this->checklist->render($active_step));
    }

Referenced by ILIAS\User\Profile\PersonalProfileGUI\executeCommand().

Here is the caller graph for this function:

◆ showExportImport()

ILIAS\User\Profile\PersonalProfileGUI::showExportImport ( )

Definition at line 759 of file class.PersonalProfileGUI.php.

                                      : void
    {
        $this->tabs->activateTab('export');
        $this->setHeader();
 
        $button = $this->ui_factory->link()->standard(
            $this->lng->txt('pd_export_profile'),
            $this->ctrl->getLinkTarget($this, 'exportPersonalData')
        );
        $this->toolbar->addStickyItem($button);
 
        $exp_file = $this->user->getPersonalDataExportFile();
        if ($exp_file != '') {
            $this->toolbar->addSeparator();
            $this->toolbar->addComponent(
                $this->ui_factory->link()->standard(
                    $this->lng->txt("pd_download_last_export_file"),
                    $this->ctrl->getLinkTarget($this, "downloadPersonalData")
                )
            );
        }
 
        $this->toolbar->addSeparator();
        $this->toolbar->addComponent(
            $this->ui_factory->link()->standard(
                $this->lng->txt("pd_import_personal_data"),
                $this->ctrl->getLinkTarget($this, "importPersonalDataSelection")
            )
        );
 
        $this->tpl->printToStdout();
    }

References ILIAS\Repository\lng(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ showPersonalData()

ILIAS\User\Profile\PersonalProfileGUI::showPersonalData ( bool $a_no_init = false )

Definition at line 261 of file class.PersonalProfileGUI.php.

     : void {
        $this->tabs->activateTab('personal_data');
 
        $this->setHeader();
 
        $this->showChecklist(ChecklistStatus::STEP_PROFILE_DATA);
 
        if (!$a_no_init) {
            $this->initPersonalDataForm();
            // catch feedback message
            if ($this->user->getProfileIncomplete()) {
                $this->tpl->setOnScreenMessage('info', $this->lng->txt('profile_incomplete'));
            }
        }
 
        $modal = '';
        if ($this->email_change_confirmation_modal !== null) {
            $modal = $this->ui_renderer->render($this->email_change_confirmation_modal);
        }
 
        $this->tpl->setContent($this->buildInfoText() . $this->form->getHTML() . $modal);
 
        $this->tpl->printToStdout();
    }

Referenced by ILIAS\User\Profile\PersonalProfileGUI\showProfile().

Here is the caller graph for this function:

◆ showProfile()

ILIAS\User\Profile\PersonalProfileGUI::showProfile ( )

show profile form

/OLD IMPLEMENTATION DEPRECATED

Definition at line 214 of file class.PersonalProfileGUI.php.

                                 : void
    {
        $this->showPersonalData();
    }

References ILIAS\User\Profile\PersonalProfileGUI\showPersonalData().

Here is the call graph for this function:

◆ showPublicProfile()

ILIAS\User\Profile\PersonalProfileGUI::showPublicProfile ( bool $a_no_init = false )

Definition at line 527 of file class.PersonalProfileGUI.php.

                                                              : void
    {
        $this->tabs->activateTab('public_profile');
        $this->showChecklist(ChecklistStatus::STEP_PUBLISH_OPTIONS);
 
        $this->setHeader();
 
        if (!$a_no_init) {
            $this->initPublicProfileForm();
        }
 
        $this->tpl->setContent($this->form->getHTML());
        $this->tpl->printToStdout();
    }

References ILIAS\Repository\form(), ILIAS\User\Profile\ChecklistStatus\STEP_PUBLISH_OPTIONS, and ILIAS\Repository\tabs().

Here is the call graph for this function:

◆ showPublicProfileFields()

ILIAS\User\Profile\PersonalProfileGUI::showPublicProfileFields	(	\ilPropertyFormGUI	$form,
		?array	$prefs = `null`,
		\ilRadioOption\|\ilCheckboxGroupInputGUI\|null	$parent = `null`,
		bool	$anonymized = `false`,
		string	$key_suffix = `''`
	)

Definition at line 612 of file class.PersonalProfileGUI.php.

     : void {
        foreach ($this->profile->getVisibleFields(Context::User) as $field) {
            $value = $field->retrieveValueFromUser($this->user);
            if (!$anonymized && ($value === '' || $value === '-')) {
                continue;
            }
            if ($anonymized) {
                $value = null;
            }
 
            if ($field->isVisibleToUser()) {
                // #18795 - we should use ilUserProfile
                switch ($field->getIdentifier()) {
                    case 'upload':
                        $caption = 'personal_picture';
                        break;
 
                    case 'title':
                        $caption = 'person_title';
                        break;
 
                    default:
                        $caption = $field->getLabel($this->lng);
                }
                $cb = new \ilCheckboxInputGUI($caption, self::PUBLISH_SETTINGS_PREFIX . $field->getIdentifier() . $key_suffix);
                $cb->setChecked(
                    $prefs === null
                        ? $field->isPublishedByUser($this->user)
                        : $prefs["public_{$field->getIdentifier()}"] ?? false
                );
 
                $cb->setOptionTitle(
                    $this->refinery->byTrying([
                        $this->refinery->kindlyTo()->string(),
                        $this->refinery->custom()->transformation(
                            function (mixed $v): string {
                                return array_reduce(
                                    $this->refinery->kindlyTo()->listOf(
                                        $this->refinery->kindlyTo()->string()
                                    )->transform($v),
                                    static fn(string $c, string $v): string => $c === ''
                                        ? $v : "{$c}, {$v}",
                                    ''
                                );
                            }
                        ),
                        $this->refinery->always('')
                    ])->transform($value)
                );
 
                if (!$parent) {
                    $form->addItem($cb);
                } else {
                    $parent->addSubItem($cb);
                }
            }
        }
 
        if (!$anonymized) {
            $handler = \ilBadgeHandler::getInstance();
            if ($handler->isActive()) {
                $badge_options = [];
 
                foreach (\ilBadgeAssignment::getInstancesByUserId($this->user->getId()) as $ass) {
                    // only active
                    if ($ass->getPosition()) {
                        $badge = new \ilBadge($ass->getBadgeId());
                        $badge_options[] = $badge->getTitle();
                    }
                }
 
                if (count($badge_options) > 1) {
                    $badge_order = new \ilNonEditableValueGUI($this->lng->txt('obj_bdga'), 'bpos' . $key_suffix);
                    $badge_order->setMultiValues($badge_options);
                    $badge_order->setValue(array_shift($badge_options));
                    $badge_order->setMulti(true, true, false);
 
                    if (!$parent) {
                        $form->addItem($badge_order);
                    } else {
                        $parent->addSubItem($badge_order);
                    }
                }
            }
        }
 
        // permalink
        $ne = new \ilNonEditableValueGUI($this->lng->txt('perma_link'), '');
        $ne->setValue(\ilLink::_getLink($this->user->getId(), 'usr'));
        if (!$parent) {
            $form->addItem($ne);
        } else {
            $parent->addSubItem($ne);
        }
    }

References $c, ilPropertyFormGUI\addItem(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Refinery\transform(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ updateLoginOrSetErrorMessages()

ILIAS\User\Profile\PersonalProfileGUI::updateLoginOrSetErrorMessages ( )

private

Definition at line 428 of file class.PersonalProfileGUI.php.

                                                    : bool
    {
        $login = $this->form->getInput('username');
        if ($login === '' || !\ilUtil::isLogin($login)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('form_input_not_valid'));
            $this->form->getItemByPostVar('username')->setAlert($this->lng->txt('login_invalid'));
            return false;
        }
 
        if (\ilObjUser::_loginExists($login, $this->user->getId())) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('form_input_not_valid'));
            $this->form->getItemByPostVar('username')->setAlert($this->lng->txt('loginname_already_exists'));
            return false;
        }
 
        try {
            $this->user->updateLogin($login);
            return true;
        } catch (\ilUserException $e) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('form_input_not_valid'));
            $this->form->getItemByPostVar('username')->setAlert($e->getMessage());
            return false;
        }
    }

References Vendor\Package\$e, ilObjUser\_loginExists(), ILIAS\Repository\form(), ilUtil\isLogin(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ userSettingVisible()

ILIAS\User\Profile\PersonalProfileGUI::userSettingVisible ( string $setting )

Definition at line 204 of file class.PersonalProfileGUI.php.

                                                       : bool
    {
        return $this->user_settings_config->isVisible($setting);
    }

References ILIAS\$setting.

Field Documentation

◆ $auth_session

ilAuthSession ILIAS\User\Profile\PersonalProfileGUI::$auth_session

private

Definition at line 60 of file class.PersonalProfileGUI.php.

◆ $change_mail_token_repo

ChangeMailRepository ILIAS\User\Profile\PersonalProfileGUI::$change_mail_token_repo

private

Definition at line 75 of file class.PersonalProfileGUI.php.

◆ $checklist

ChecklistGUI ILIAS\User\Profile\PersonalProfileGUI::$checklist

private

Definition at line 69 of file class.PersonalProfileGUI.php.

◆ $checklist_status

ChecklistStatus ILIAS\User\Profile\PersonalProfileGUI::$checklist_status

private

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

◆ $ctrl

ilCtrl ILIAS\User\Profile\PersonalProfileGUI::$ctrl

private

Definition at line 63 of file class.PersonalProfileGUI.php.

◆ $email_change_confirmation_modal

Interruptive ILIAS\User\Profile\PersonalProfileGUI::$email_change_confirmation_modal = null

private

Definition at line 84 of file class.PersonalProfileGUI.php.

◆ $error_handler

ilErrorHandling ILIAS\User\Profile\PersonalProfileGUI::$error_handler

private

Definition at line 68 of file class.PersonalProfileGUI.php.

◆ $event

ilAppEventHandler ILIAS\User\Profile\PersonalProfileGUI::$event

private

Definition at line 56 of file class.PersonalProfileGUI.php.

◆ $form

ilPropertyFormGUI ILIAS\User\Profile\PersonalProfileGUI::$form

private

Definition at line 57 of file class.PersonalProfileGUI.php.

◆ $help

ilHelpGUI ILIAS\User\Profile\PersonalProfileGUI::$help

private

Definition at line 66 of file class.PersonalProfileGUI.php.

◆ $http

HTTP ILIAS\User\Profile\PersonalProfileGUI::$http

private

Definition at line 67 of file class.PersonalProfileGUI.php.

◆ $lng

Language ILIAS\User\Profile\PersonalProfileGUI::$lng

private

Definition at line 62 of file class.PersonalProfileGUI.php.

◆ $logger

ilLogger ILIAS\User\Profile\PersonalProfileGUI::$logger

private

Definition at line 81 of file class.PersonalProfileGUI.php.

◆ $profile

Profile ILIAS\User\Profile\PersonalProfileGUI::$profile

private

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

◆ $profile_request

GUIRequest ILIAS\User\Profile\PersonalProfileGUI::$profile_request

private

Definition at line 77 of file class.PersonalProfileGUI.php.

◆ $prompt_repository

PromptRepository ILIAS\User\Profile\PersonalProfileGUI::$prompt_repository

private

Definition at line 76 of file class.PersonalProfileGUI.php.

◆ $refinery

Refinery ILIAS\User\Profile\PersonalProfileGUI::$refinery

private

Definition at line 73 of file class.PersonalProfileGUI.php.

◆ $settings

ilSetting ILIAS\User\Profile\PersonalProfileGUI::$settings

private

Definition at line 58 of file class.PersonalProfileGUI.php.

◆ $static_url

StaticUrlServices ILIAS\User\Profile\PersonalProfileGUI::$static_url

private

Definition at line 61 of file class.PersonalProfileGUI.php.

◆ $tabs

ilTabsGUI ILIAS\User\Profile\PersonalProfileGUI::$tabs

private

Definition at line 64 of file class.PersonalProfileGUI.php.

◆ $toolbar

ilToolbarGUI ILIAS\User\Profile\PersonalProfileGUI::$toolbar

private

Definition at line 65 of file class.PersonalProfileGUI.php.

◆ $tpl

ilGlobalTemplateInterface ILIAS\User\Profile\PersonalProfileGUI::$tpl

private

Definition at line 55 of file class.PersonalProfileGUI.php.

◆ $ui_factory

UIFactory ILIAS\User\Profile\PersonalProfileGUI::$ui_factory

private

Definition at line 71 of file class.PersonalProfileGUI.php.

◆ $ui_renderer

UIRenderer ILIAS\User\Profile\PersonalProfileGUI::$ui_renderer

private

Definition at line 72 of file class.PersonalProfileGUI.php.

◆ $uploads

FileUpload ILIAS\User\Profile\PersonalProfileGUI::$uploads

private

Definition at line 82 of file class.PersonalProfileGUI.php.

◆ $user

ilObjUser ILIAS\User\Profile\PersonalProfileGUI::$user

private

Definition at line 59 of file class.PersonalProfileGUI.php.

◆ $user_settings

UserSettings ILIAS\User\Profile\PersonalProfileGUI::$user_settings

private

Definition at line 79 of file class.PersonalProfileGUI.php.

◆ CHANGE_EMAIL_CMD

const ILIAS\User\Profile\PersonalProfileGUI::CHANGE_EMAIL_CMD = 'changeEmail'

Definition at line 53 of file class.PersonalProfileGUI.php.

Referenced by ILIAS\User\StaticURLHandler\buildChangeEmailUrl().

◆ PERSONAL_DATA_FORM_ID

const ILIAS\User\Profile\PersonalProfileGUI::PERSONAL_DATA_FORM_ID = 'pd'

private

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

◆ PUBLISH_SETTINGS_PREFIX

const ILIAS\User\Profile\PersonalProfileGUI::PUBLISH_SETTINGS_PREFIX = 'chk_'

private

Definition at line 52 of file class.PersonalProfileGUI.php.

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

components/ILIAS/User/src/Profile/class.PersonalProfileGUI.php

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ addDataFromFormToUser()

◆ addEmailChangeModal()

◆ buildInfoText()

◆ buildKeySuffix()

◆ changeEmail()

◆ downloadPersonalData()

◆ emailChanged()

◆ emailCompletionForced()

◆ executeCommand()

◆ exportPersonalData()

◆ getProfilePortfolio()

◆ getPublishedFromPost()

◆ goToEmailConfirmation()

◆ importPersonalData()

◆ importPersonalDataSelection()

◆ initPersonalDataForm()

◆ initPersonalDataImportForm()

◆ initPublicProfileForm()

◆ loginChanged()

◆ savePersonalData()

◆ savePublicProfile()

◆ setHeader()

◆ setTabs()

◆ showChecklist()

◆ showExportImport()

◆ showPersonalData()

◆ showProfile()

◆ showPublicProfile()

◆ showPublicProfileFields()

◆ updateLoginOrSetErrorMessages()

◆ userSettingVisible()

Field Documentation

◆ $auth_session

◆ $change_mail_token_repo

◆ $checklist

◆ $checklist_status

◆ $ctrl

◆ $email_change_confirmation_modal

◆ $error_handler

◆ $event

◆ $form

◆ $help

◆ $http

◆ $lng

◆ $logger

◆ $profile

◆ $profile_request

◆ $prompt_repository

◆ $refinery

◆ $settings

◆ $static_url

◆ $tabs

◆ $toolbar

◆ $tpl

◆ $ui_factory

◆ $ui_renderer

◆ $uploads

◆ $user

◆ $user_settings

◆ CHANGE_EMAIL_CMD

◆ PERSONAL_DATA_FORM_ID

◆ PUBLISH_SETTINGS_PREFIX