Collaboration diagram for ilUserProfile:

Public Member Functions
	getStandardFields ()

	getLocalUserAdministrationFields ()

	skipGroup (string $group)

	skipField (string $field)

	addStandardFieldsToForm (ilPropertyFormGUI $form, ?ilObjUser $user=null, array $custom_fields=[])

	setAjaxCallback (string $href)

	userSettingVisible (string $setting)

	setMode (int $mode)

	isProfileIncomplete (ilObjUser $user, bool $include_udf=true, bool $personal_data_only=true)

	getIgnorableRequiredSettings ()

Data Fields
const	MODE_DESKTOP = 1

const	MODE_REGISTRATION = 2

Protected Member Functions
	isEditableByUser (string $setting)

Protected Attributes
string	$ajax_href

array	$skip_fields

array	$skip_groups

ilUserSettingsConfig	$user_settings_config

Private Member Functions
	addRegistrationFieldsToFieldArray ()

	handleSectionChange (ilPropertyFormGUI $form, string $current_group, string $next_group, array $custom_fields, bool $custom_fields_done)

	addFieldToForm (string $field_id, array $field_definition, ?ilObjUser $user, ilPropertyFormGUI $form, ?ilRegistrationSettings $registration_settings)

	getTextInput (string $field_id, array $field_definition, string $method, string $lang_var, ?ilObjUser $user)

	getTextareaInput (string $field_id, array $field_definition, string $method, string $lang_var, ?ilObjUser $user)

	getMultitextInput (string $field_id, array $field_definition, string $method, string $lang_var, ?ilObjUser $user)

	getRadioInput (string $field_id, array $field_definition, string $method, string $lang_var, ?ilObjUser $user)

	getLoginInput (array $field_definition, ?ilObjUser $user)

	getCountryInput (string $field_id, string $method, string $lang_var, ?ilObjUser $user)

	getBirthdayInput (string $field_id, string $method, string $lang_var, ?ilObjUser $user)

	getImageInput (array $file_upload, ?ilObjUser $user)

	getRolesInput (string $field_id, ?ilRegistrationSettings $registration_settings, ?ilObjUser $user)

	getEmailInput (string $field_id, string $method, string $lang_var, ?ilObjUser $user)

	getPasswordInput (string $field_id, string $lang_var, ilRegistrationSettings $registration_settings)

	getLanguageInput (string $field_id, string $method, string $lang_var, ?ilObjUser $user)

	getNonEditableInput (string $method, string $lang_var, ilObjUser $user)

	addCustomFieldsToForm (ilPropertyFormGUI $form, array $custom_fields, string $current_group)

Private Attributes
int	$mode = self::MODE_DESKTOP

ilSetting	$settings

ilLanguage	$lng

ilRbacReview	$rbac_review

array	$user_fields

Detailed Description

Class ilUserProfile.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 25 of file class.ilUserProfile.php.

Member Function Documentation

◆ addCustomFieldsToForm()

ilUserProfile::addCustomFieldsToForm	(	ilPropertyFormGUI	$form,
		array	$custom_fields,
		string	$current_group
	)

private

Definition at line 656 of file class.ilUserProfile.php.

References ilPropertyFormGUI\addItem(), and ILIAS\Repository\lng().

Referenced by addStandardFieldsToForm(), and handleSectionChange().

      : ilPropertyFormGUI {
         if ($current_group !== 'other') {
             $section_header = new ilFormSectionHeaderGUI();
             $section_header->setTitle($this->lng->txt('other'));
             $form->addItem($section_header);
         }
         foreach ($custom_fields as $custom_field) {
             $form->addItem($custom_field);
         }
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addFieldToForm()

ilUserProfile::addFieldToForm	(	string	$field_id,
		array	$field_definition,
		?ilObjUser	$user,
		ilPropertyFormGUI	$form,
		?ilRegistrationSettings	$registration_settings
	)

private

Definition at line 183 of file class.ilUserProfile.php.

References ilPropertyFormGUI\addItem(), getBirthdayInput(), getCountryInput(), getEmailInput(), ilPropertyFormGUI\getFileUpload(), getImageInput(), getLanguageInput(), getLoginInput(), getMultitextInput(), getNonEditableInput(), getPasswordInput(), getRadioInput(), getRolesInput(), getTextareaInput(), getTextInput(), and userSettingVisible().

Referenced by addStandardFieldsToForm().

      : ilPropertyFormGUI {
         $method = $field_definition['method'] ?? '';
 
         $lang_var = (isset($field_definition['lang_var']) && $field_definition['lang_var'] !== '')
             ? $field_definition['lang_var']
             : $field_id;
 
         switch ($field_definition['input']) {
             case 'text':
                 if (!$this->userSettingVisible($field_id)) {
                     break;
                 }
 
                 $form->addItem(
                     $this->getTextInput(
                         $field_id,
                         $field_definition,
                         $method,
                         $lang_var,
                         $user
                     )
                 );
                 break;
 
             case 'textarea':
                 if (!$this->userSettingVisible($field_id)) {
                     break;
                 }
 
                 $form->addItem(
                     $this->getTextareaInput(
                         $field_id,
                         $field_definition,
                         $method,
                         $lang_var,
                         $user
                     )
                 );
                 break;
 
             case 'multitext':
                 if (!$this->userSettingVisible($field_id)) {
                     break;
                 }
 
                 $form->addItem(
                     $this->getMultitextInput(
                         $field_id,
                         $field_definition,
                         $method,
                         $lang_var,
                         $user
                     )
                 );
                 break;
 
             case 'radio':
                 if (!$this->userSettingVisible($field_id)) {
                     break;
                 }
 
                 $form->addItem(
                     $this->getRadioInput(
                         $field_id,
                         $field_definition,
                         $method,
                         $lang_var,
                         $user
                     )
                 );
                 break;
 
             case 'login':
                 $form->addItem(
                     $this->getLoginInput($field_definition, $user)
                 );
                 break;
 
             case 'sel_country':
                 if (!$this->userSettingVisible($field_id)) {
                     break;
                 }
 
                 $form->addItem(
                     $this->getCountryInput($field_id, $method, $lang_var, $user)
                 );
                 break;
 
             case 'birthday':
                 if (!$this->userSettingVisible($field_id)) {
                     break;
                 }
 
                 $form->addItem(
                     $this->getBirthdayInput($field_id, $method, $lang_var, $user)
                 );
                 break;
 
             case 'picture':
                 if (!$this->userSettingVisible($field_id) || $user === null) {
                     break;
                 }
 
                 $form->addItem(
                     $this->getImageInput($form->getFileUpload('userfile'), $user)
                 );
                 break;
 
             case 'roles':
                 $roles_input = $this->getRolesInput($field_id, $registration_settings, $user);
                 if ($roles_input !== null) {
                     $form->addItem($roles_input);
                 }
                 break;
 
             case 'second_email':
             case 'email':
                 if (!$this->userSettingVisible($field_id)) {
                     break;
                 }
 
                 $form->addItem(
                     $this->getEmailInput($field_id, $method, $lang_var, $user)
                 );
                 break;
 
             case 'password':
                 if ($this->mode !== self::MODE_REGISTRATION) {
                     break;
                 }
 
                 $form->addItem(
                     $this->getPasswordInput(
                         $field_id,
                         $lang_var,
                         $registration_settings
                     )
                 );
                 break;
 
             case 'language':
                 if (!$this->userSettingVisible($field_id)) {
                     break;
                 }
 
                 $form->addItem(
                     $this->getLanguageInput(
                         $field_id,
                         $method,
                         $lang_var,
                         $user
                     )
                 );
                 break;
 
             case 'noneditable':
                 if ($this->mode !== self::MODE_DESKTOP || !$this->userSettingVisible($field_id)) {
                     break;
                 }
 
                 $form->addItem(
                     $this->getNonEditableInput($method, $lang_var, $user)
                 );
                 break;
         }
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addRegistrationFieldsToFieldArray()

ilUserProfile::addRegistrationFieldsToFieldArray ( )

private

Definition at line 142 of file class.ilUserProfile.php.

References ILIAS\Repository\lng().

Referenced by addStandardFieldsToForm().

                                                         : void
     {
         $this->user_fields['username']['group'] = 'login_data';
         $this->user_fields['password']['group'] = 'login_data';
         $this->user_fields['language']['default'] = $this->lng->lang_key;
 
         // different position for role
         $roles = $this->user_fields['roles'];
         unset($this->user_fields['roles']);
         $this->user_fields['roles'] = $roles;
         $this->user_fields['roles']['group'] = 'settings';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addStandardFieldsToForm()

ilUserProfile::addStandardFieldsToForm	(	ilPropertyFormGUI	$form,
		?ilObjUser	$user = `null`,
		array	$custom_fields = `[]`
	)

Definition at line 98 of file class.ilUserProfile.php.

References addCustomFieldsToForm(), addFieldToForm(), addRegistrationFieldsToFieldArray(), getStandardFields(), handleSectionChange(), and userSettingVisible().

      : void {
         $registration_settings = null;
         if ($this->mode == self::MODE_REGISTRATION) {
             $registration_settings = new ilRegistrationSettings();
             $this->addRegistrationFieldsToFieldArray();
         }
 
         $current_group = '';
         $custom_fields_done = false;
         foreach ($this->getStandardFields() as $field_id => $field_definition) {
             // next group? -> diplay subheader
             if (($field_definition['group'] !== $current_group) &&
                 $this->userSettingVisible($field_id)) {
                 list($form, $current_group, $custom_fields_done) = $this->handleSectionChange(
                     $form,
                     $current_group,
                     $field_definition['group'],
                     $custom_fields,
                     $custom_fields_done
                 );
             }
             $form = $this->addFieldToForm(
                 $field_id,
                 $field_definition,
                 $user,
                 $form,
                 $registration_settings
             );
         }
 
         // append custom fields as 'other'
         if ($custom_fields !== [] && !$custom_fields_done) {
             $form = $this->addCustomFieldsToForm(
                 $form,
                 $custom_fields,
                 $current_group
             );
         }
     }

Here is the call graph for this function:

◆ getBirthdayInput()

ilUserProfile::getBirthdayInput	(	string	$field_id,
		string	$method,
		string	$lang_var,
		?ilObjUser	$user
	)

private

Definition at line 483 of file class.ilUserProfile.php.

References IL_CAL_DATE, ILIAS\Repository\lng(), and ILIAS\Repository\settings().

Referenced by addFieldToForm().

      : ilFormPropertyGUI {
         $birthday_input = new ilBirthdayInputGUI($this->lng->txt($lang_var), 'usr_' . $field_id);
         $date = null;
         if ($user && $user->$method() && strlen($user->$method())) {
             $date = new ilDateTime($user->$method(), IL_CAL_DATE);
             $birthday_input->setDate($date);
         }
         $birthday_input->setRequired((bool) $this->settings->get('require_' . $field_id));
         if (!$birthday_input->getRequired() || $date !== null) {
             $birthday_input->setDisabled((bool) $this->settings->get('usr_settings_disable_' . $field_id));
         }
         return $birthday_input;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCountryInput()

ilUserProfile::getCountryInput	(	string	$field_id,
		string	$method,
		string	$lang_var,
		?ilObjUser	$user
	)

private

Definition at line 466 of file class.ilUserProfile.php.

References ILIAS\Repository\lng(), ILIAS\Repository\settings(), and ilSelectInputGUI\setValue().

Referenced by addFieldToForm().

      : ilFormPropertyGUI {
         $country_input = new ilCountrySelectInputGUI($this->lng->txt($lang_var), 'usr_' . $field_id);
         if ($user) {
             $country_input->setValue($user->$method());
         }
         $country_input->setRequired((bool) $this->settings->get('require_' . $field_id));
         if (!$country_input->getRequired() || $country_input->getValue()) {
             $country_input->setDisabled((bool) $this->settings->get('usr_settings_disable_' . $field_id));
         }
         return $country_input;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEmailInput()

ilUserProfile::getEmailInput	(	string	$field_id,
		string	$method,
		string	$lang_var,
		?ilObjUser	$user
	)

private

Definition at line 579 of file class.ilUserProfile.php.

References ILIAS\Repository\lng(), ILIAS\Repository\settings(), and ilEMailInputGUI\setValue().

Referenced by addFieldToForm().

      : ilFormPropertyGUI {
         $email_input = new ilEMailInputGUI($this->lng->txt($lang_var), 'usr_' . $field_id);
         if ($user) {
             $email_input->setValue($user->$method());
         }
         $email_input->setRequired((bool) $this->settings->get('require_' . $field_id));
         if (!$email_input->getRequired() || $email_input->getValue()) {
             $email_input->setDisabled((bool) $this->settings->get('usr_settings_disable_' . $field_id));
         }
         if (self::MODE_REGISTRATION == $this->mode) {
             $email_input->setRetype(true);
         }
         return $email_input;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIgnorableRequiredSettings()

ilUserProfile::getIgnorableRequiredSettings ( )

Definition at line 746 of file class.ilUserProfile.php.

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

                                                   : array // Missing array type.
     {
         $ignorableSettings = [];
 
         foreach (array_keys($this->user_fields) as $field) {
             // !!!username and password must not be ignored!!!
             if ('username' == $field ||
                 'password' == $field) {
                 continue;
             }
 
             // Field is not required -> continue
             if (!$this->settings->get('require_' . $field)) {
                 continue;
             }
 
             if ($this->isEditableByUser($field)) {
                 $ignorableSettings[] = $field;
             }
         }
 
         return $ignorableSettings;
     }

Here is the call graph for this function:

◆ getImageInput()

ilUserProfile::getImageInput	(	array	$file_upload,
		?ilObjUser	$user
	)

private

Definition at line 502 of file class.ilUserProfile.php.

References ilObjUser\_getPersonalPicturePath(), ilObject\getId(), ILIAS\Repository\lng(), ilImageFileInputGUI\setAllowCapture(), and ILIAS\Repository\settings().

Referenced by addFieldToForm().

      : ilFormPropertyGUI {
         $image_input = new ilImageFileInputGUI($this->lng->txt('personal_picture'), 'userfile');
         $image_input->setAllowCapture(true);
         $image_input->setDisabled((bool) $this->settings->get('usr_settings_disable_upload'));
 
         if ($file_upload['name'] ?? false) {
             $image_input->setPending($file_upload['name']);
         } else {
             $picture_path = ilObjUser::_getPersonalPicturePath(
                 $user->getId(),
                 'small',
                 true,
                 true
             );
             if ($picture_path !== '') {
                 $image_input->setImage($picture_path);
                 $image_input->setAlt($this->lng->txt('personal_picture'));
             }
         }
         return $image_input;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLanguageInput()

ilUserProfile::getLanguageInput	(	string	$field_id,
		string	$method,
		string	$lang_var,
		?ilObjUser	$user
	)

private

Definition at line 617 of file class.ilUserProfile.php.

References ILIAS\Repository\lng(), ILIAS\Repository\settings(), and ilSelectInputGUI\setValue().

Referenced by addFieldToForm().

      : ilFormPropertyGUI {
         $options = [];
         $this->lng->loadLanguageModule('meta');
         foreach ($this->lng->getInstalledLanguages() as $lang_key) {
             $options[$lang_key] = $this->lng->txt('meta_l_' . $lang_key);
         }
 
         asort($options);
         $language_input = new ilSelectInputGUI($this->lng->txt($lang_var), 'usr_' . $field_id);
         if ($user !== null) {
             $language_input->setValue($user->$method());
         }
 
         $language_input->setOptions($options);
         $language_input->setRequired((bool) $this->settings->get('require_' . $field_id));
         if (!$language_input->getRequired() || $language_input->getValue()) {
             $language_input->setDisabled(
                 $this->settings->get('usr_settings_disable_' . $field_id) === '1'
                 || count($options) <= 1
             );
         }
         return $language_input;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLocalUserAdministrationFields()

ilUserProfile::getLocalUserAdministrationFields ( )

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

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

                                                       : array // Missing array type.
     {
         $fields = [];
         foreach ($this->getStandardFields() as $field => $info) {
             if ($this->settings->get('usr_settings_visib_lua_' . $field, '1')) {
                 $fields[$field] = $info;
             } elseif ($info['visib_lua_fix_value'] ?? false) {
                 $fields[$field] = $info;
             }
         }
         return $fields;
     }

Here is the call graph for this function:

◆ getLoginInput()

ilUserProfile::getLoginInput	(	array	$field_definition,
		?ilObjUser	$user
	)

private

Definition at line 447 of file class.ilUserProfile.php.

References ilObjUser\getLogin(), ILIAS\Repository\lng(), and ILIAS\Repository\settings().

Referenced by addFieldToForm().

      : ilFormPropertyGUI {
         $login_input = new ilNonEditableValueGUI($this->lng->txt('username'), 'ne_un');
 
         if ((int) $this->settings->get('allow_change_loginname') || $this->mode == self::MODE_REGISTRATION) {
             $login_input = new ilTextInputGUI($this->lng->txt('username'), 'username');
             $login_input->setMaxLength((int) $field_definition['maxlength']);
             $login_input->setSize(255);
             $login_input->setRequired(true);
         }
 
         if ($user !== null) {
             $login_input->setValue($user->getLogin());
         }
         return $login_input;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMultitextInput()

ilUserProfile::getMultitextInput	(	string	$field_id,
		array	$field_definition,
		string	$method,
		string	$lang_var,
		?ilObjUser	$user
	)

private

Definition at line 400 of file class.ilUserProfile.php.

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

Referenced by addFieldToForm().

      : ilFormPropertyGUI {
         $multi_text_input = new ilTextInputGUI($this->lng->txt($lang_var), 'usr_' . $field_id);
         $multi_text_input->setMulti(true);
         if ($user !== null) {
             $multi_text_input->setValue($user->$method());
         }
         $multi_text_input->setMaxLength($field_definition['maxlength']);
         $multi_text_input->setSize($field_definition['size']);
         $multi_text_input->setRequired((bool) $this->settings->get('require_' . $field_id));
         if (!$multi_text_input->getRequired() || $multi_text_input->getValue()) {
             $multi_text_input->setDisabled((bool) $this->settings->get('usr_settings_disable_' . $field_id));
         }
         if ($this->ajax_href) {
             // add field to ajax call
             $multi_text_input->setDataSource($this->ajax_href . '&f=' . $field_id);
         }
         return $multi_text_input;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNonEditableInput()

ilUserProfile::getNonEditableInput	(	string	$method,
		string	$lang_var,
		ilObjUser	$user
	)

private

Definition at line 646 of file class.ilUserProfile.php.

References ILIAS\Repository\lng().

Referenced by addFieldToForm().

      : ilFormPropertyGUI {
         $non_editable_input = new ilNonEditableValueGUI($this->lng->txt($lang_var));
         $non_editable_input->setValue($user->$method());
         return $non_editable_input;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPasswordInput()

ilUserProfile::getPasswordInput	(	string	$field_id,
		string	$lang_var,
		ilRegistrationSettings	$registration_settings
	)

private

Definition at line 599 of file class.ilUserProfile.php.

References ilSecuritySettingsChecker\getPasswordRequirementsInfo(), ILIAS\Repository\lng(), ilRegistrationSettings\passwordGenerationEnabled(), and ilPasswordInputGUI\setUseStripSlashes().

Referenced by addFieldToForm().

      : ilFormPropertyGUI {
         if ($registration_settings->passwordGenerationEnabled()) {
             $password_input = new ilNonEditableValueGUI($this->lng->txt($lang_var));
             $password_input->setValue($this->lng->txt('reg_passwd_via_mail'));
             return $password_input;
         }
 
         $password_input = new ilPasswordInputGUI($this->lng->txt($lang_var), 'usr_' . $field_id);
         $password_input->setUseStripSlashes(false);
         $password_input->setRequired(true);
         $password_input->setInfo(ilSecuritySettingsChecker::getPasswordRequirementsInfo());
         return $password_input;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRadioInput()

ilUserProfile::getRadioInput	(	string	$field_id,
		array	$field_definition,
		string	$method,
		string	$lang_var,
		?ilObjUser	$user
	)

private

Definition at line 425 of file class.ilUserProfile.php.

References ILIAS\Repository\lng(), ilRadioOption\setDisabled(), ILIAS\Repository\settings(), and ilRadioGroupInputGUI\setValue().

Referenced by addFieldToForm().

      : ilFormPropertyGUI {
         $radio_group = new ilRadioGroupInputGUI($this->lng->txt($lang_var), 'usr_' . $field_id);
         if ($user) {
             $radio_group->setValue($user->$method());
         }
         foreach ($field_definition['values'] as $k => $v) {
             $op = new ilRadioOption($this->lng->txt($v), $k);
             $radio_group->addOption($op);
         }
         $radio_group->setRequired((bool) $this->settings->get('require_' . $field_id));
         if (!$radio_group->getRequired() || $radio_group->getValue()) {
             $radio_group->setDisabled((bool) $this->settings->get('usr_settings_disable_' . $field_id));
         }
         return $radio_group;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRolesInput()

ilUserProfile::getRolesInput	(	string	$field_id,
		?ilRegistrationSettings	$registration_settings,
		?ilObjUser	$user
	)

private

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

References ilObjRole\_lookupRegisterAllowed(), ilObject\getId(), ilObjectFactory\getInstanceByObjId(), ILIAS\Repository\lng(), ilRegistrationSettings\roleSelectionEnabled(), ilSelectInputGUI\setOptions(), ILIAS\Repository\settings(), and userSettingVisible().

Referenced by addFieldToForm().

      : ?ilFormPropertyGUI {
         $role_names = '';
         if ($this->mode === self::MODE_DESKTOP
             && $this->userSettingVisible('roles')) {
             $global_roles = $this->rbac_review->getGlobalRoles();
             foreach ($global_roles as $role_id) {
                 if (in_array($role_id, $this->rbac_review->assignedRoles($user->getId()))) {
                     $role_obj = ilObjectFactory::getInstanceByObjId($role_id);
                     $role_names .= $role_obj->getTitle() . ', ';
                     unset($role_obj);
                 }
             }
             $roles_input = new ilNonEditableValueGUI($this->lng->txt('default_roles'), 'ne_dr');
             $roles_input->setValue(substr($role_names, 0, -2));
             return $roles_input;
         }
 
         if ($this->mode === self::MODE_REGISTRATION
             && $registration_settings->roleSelectionEnabled()) {
             $options = [];
             foreach (ilObjRole::_lookupRegisterAllowed() as $role) {
                 $options[$role['id']] = $role['title'];
             }
 
             if ($options === []) {
                 return null;
             }
 
             if (count($options) === 1) {
                 $roles_input = new ilHiddenInputGUI('usr_' . $field_id);
                 $keys = array_keys($options);
                 $roles_input->setValue(array_shift($keys));
                 return $roles_input;
             }
 
             $options_with_empty_value = ['' => $this->lng->txt('please_choose')] + $options;
             $roles_input = new ilSelectInputGUI($this->lng->txt('default_role'), 'usr_' . $field_id);
             $roles_input->setOptions($options_with_empty_value);
             $roles_input->setRequired(true);
             if (!$roles_input->getRequired()) {
                 $roles_input->setDisabled((bool) $this->settings->get('usr_settings_disable_' . $field_id));
             }
             return $roles_input;
         }
 
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStandardFields()

ilUserProfile::getStandardFields ( )

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

References Vendor\Package\$f.

Referenced by addStandardFieldsToForm(), and getLocalUserAdministrationFields().

                                        : array // Missing array type.
     {
         $fields = [];
         foreach ($this->user_fields as $f => $p) {
             // skip hidden groups
             if (in_array($p['group'], $this->skip_groups) ||
                 in_array($f, $this->skip_fields)) {
                 continue;
             }
             $fields[$f] = $p;
         }
         return $fields;
     }

Here is the caller graph for this function:

◆ getTextareaInput()

ilUserProfile::getTextareaInput	(	string	$field_id,
		array	$field_definition,
		string	$method,
		string	$lang_var,
		?ilObjUser	$user
	)

private

Definition at line 380 of file class.ilUserProfile.php.

References ILIAS\Repository\lng(), ILIAS\Repository\settings(), and ilTextAreaInputGUI\setValue().

Referenced by addFieldToForm().

      : ilFormPropertyGUI {
         $text_area = new ilTextAreaInputGUI($this->lng->txt($lang_var), 'usr_' . $field_id);
         if ($user !== null) {
             $text_area->setValue($user->$method() ?? '');
         }
         $text_area->setRows($field_definition['rows']);
         $text_area->setCols($field_definition['cols']);
         $text_area->setRequired((bool) $this->settings->get('require_' . $field_id));
         if (!$text_area->getRequired() || $text_area->getValue()) {
             $text_area->setDisabled((bool) $this->settings->get('usr_settings_disable_' . $field_id));
         }
         return $text_area;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTextInput()

ilUserProfile::getTextInput	(	string	$field_id,
		array	$field_definition,
		string	$method,
		string	$lang_var,
		?ilObjUser	$user
	)

private

Definition at line 358 of file class.ilUserProfile.php.

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

Referenced by addFieldToForm().

      : ilFormPropertyGUI {
         $text_input = new ilTextInputGUI($this->lng->txt($lang_var), 'usr_' . $field_id);
         $text_input->setValue('');
         if ($user !== null) {
             $text_input->setValue($user->$method() ?? '');
         }
         $text_input->setMaxLength($field_definition['maxlength']);
         $text_input->setSize($field_definition['size']);
         $text_input->setRequired((bool) $this->settings->get('require_' . $field_id));
         if (!$text_input->getRequired() || $text_input->getValue()) {
             $text_input->setDisabled((bool) $this->settings->get('usr_settings_disable_' . $field_id));
         }
 
         return $text_input;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleSectionChange()

ilUserProfile::handleSectionChange	(	ilPropertyFormGUI	$form,
		string	$current_group,
		string	$next_group,
		array	$custom_fields,
		bool	$custom_fields_done
	)

private

Definition at line 155 of file class.ilUserProfile.php.

References addCustomFieldsToForm(), ilPropertyFormGUI\addItem(), and ILIAS\Repository\lng().

Referenced by addStandardFieldsToForm().

      : array {
         if ($custom_fields !== [] && !$custom_fields_done
             && ($current_group === 'other' || $next_group === 'settings')) {
             // add 'other' subheader
             $form = $this->addCustomFieldsToForm(
                 $form,
                 $custom_fields,
                 $current_group
             );
             $custom_fields_done = true;
         }
 
         $section_header = new ilFormSectionHeaderGUI();
         $section_header->setTitle($this->lng->txt($next_group));
         $form->addItem($section_header);
         return [
             $form,
             $next_group,
             $custom_fields_done
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isEditableByUser()

ilUserProfile::isEditableByUser ( string $setting )

protected

Definition at line 741 of file class.ilUserProfile.php.

Referenced by getIgnorableRequiredSettings().

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

Here is the caller graph for this function:

◆ isProfileIncomplete()

ilUserProfile::isProfileIncomplete	(	ilObjUser	$user,
		bool	$include_udf = `true`,
		bool	$personal_data_only = `true`
	)

Definition at line 701 of file class.ilUserProfile.php.

References ilUserDefinedFields\_getInstance(), ilLoggerFactory\getLogger(), and ILIAS\Repository\settings().

      : bool {
         // standard fields
         foreach ($this->user_fields as $field => $definition) {
             // only if visible in personal data
             if ($personal_data_only && !$this->user_settings_config->isVisible($field)) {
                 continue;
             }
 
             if ($this->settings->get('require_' . $field) && $definition['method']
                 && empty($user->{$definition['method']}())) {
                 return true;
             }
         }
 
         // custom fields
         if (!$include_udf) {
             return false;
         }
 
         $user_defined_data = $user->getUserDefinedData();
         $user_defined_fields = ilUserDefinedFields::_getInstance();
         foreach ($user_defined_fields->getRequiredDefinitions() as $field => $definition) {
             // only if visible in personal data
             if ($personal_data_only && !$definition['visible']) {
                 continue;
             }
 
             if (!($user_defined_data['f_' . $field] ?? false)) {
                 ilLoggerFactory::getLogger('user')->info('Profile is incomplete due to missing required udf.');
                 return true;
             }
         }
 
         return false;
     }

Here is the call graph for this function:

◆ setAjaxCallback()

ilUserProfile::setAjaxCallback ( string $href )

Definition at line 672 of file class.ilUserProfile.php.

                                                  : void
     {
         $this->ajax_href = $href;
     }

◆ setMode()

ilUserProfile::setMode ( int $mode )

Definition at line 692 of file class.ilUserProfile.php.

References $mode.

                                       : bool
     {
         if (in_array($mode, [self::MODE_DESKTOP, self::MODE_REGISTRATION])) {
             $this->mode = $mode;
             return true;
         }
         return false;
     }

◆ skipField()

ilUserProfile::skipField ( string $field )

Definition at line 93 of file class.ilUserProfile.php.

                                             : void
     {
         $this->skip_fields[] = $field;
     }

◆ skipGroup()

ilUserProfile::skipGroup ( string $group )

Definition at line 88 of file class.ilUserProfile.php.

                                             : void
     {
         $this->skip_groups[] = $group;
     }

◆ userSettingVisible()

ilUserProfile::userSettingVisible ( string $setting )

Definition at line 677 of file class.ilUserProfile.php.

References ILIAS\Repository\settings().

Referenced by addFieldToForm(), addStandardFieldsToForm(), and getRolesInput().

                                                        : bool
     {
         if ($this->mode === self::MODE_DESKTOP) {
             return ($this->user_settings_config->isVisible($setting));
         }
 
         if (isset($this->user_fields[$setting]['visib_reg_hide'])
             && $this->user_fields[$setting]['visib_reg_hide'] === true) {
             return true;
         }
 
         return ($this->settings->get('usr_settings_visib_reg_' . $setting, '1')
             || $this->settings->get('require_' . $setting, '0'));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $ajax_href

string ilUserProfile::$ajax_href

protected

Definition at line 37 of file class.ilUserProfile.php.

◆ $lng

ilLanguage ilUserProfile::$lng

private

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

◆ $mode

int ilUserProfile::$mode = self::MODE_DESKTOP

private

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

Referenced by setMode().

◆ $rbac_review

ilRbacReview ilUserProfile::$rbac_review

private

Definition at line 34 of file class.ilUserProfile.php.

◆ $settings

ilSetting ilUserProfile::$settings

private

Definition at line 32 of file class.ilUserProfile.php.

◆ $skip_fields

array ilUserProfile::$skip_fields

protected

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

◆ $skip_groups

array ilUserProfile::$skip_groups

protected

Definition at line 39 of file class.ilUserProfile.php.

◆ $user_fields

array ilUserProfile::$user_fields

private

Definition at line 36 of file class.ilUserProfile.php.

◆ $user_settings_config

ilUserSettingsConfig ilUserProfile::$user_settings_config

protected

Definition at line 41 of file class.ilUserProfile.php.

◆ MODE_DESKTOP

const ilUserProfile::MODE_DESKTOP = 1

Definition at line 27 of file class.ilUserProfile.php.

◆ MODE_REGISTRATION

const ilUserProfile::MODE_REGISTRATION = 2

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

Referenced by ilAccountRegistrationGUI\initForm().

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

Services/User/classes/Profile/class.ilUserProfile.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ addCustomFieldsToForm()

◆ addFieldToForm()

◆ addRegistrationFieldsToFieldArray()

◆ addStandardFieldsToForm()

◆ getBirthdayInput()

◆ getCountryInput()

◆ getEmailInput()

◆ getIgnorableRequiredSettings()

◆ getImageInput()

◆ getLanguageInput()

◆ getLocalUserAdministrationFields()

◆ getLoginInput()

◆ getMultitextInput()

◆ getNonEditableInput()

◆ getPasswordInput()

◆ getRadioInput()

◆ getRolesInput()

◆ getStandardFields()

◆ getTextareaInput()

◆ getTextInput()

◆ handleSectionChange()

◆ isEditableByUser()

◆ isProfileIncomplete()

◆ setAjaxCallback()

◆ setMode()

◆ skipField()

◆ skipGroup()

◆ userSettingVisible()

Field Documentation

◆ $ajax_href

◆ $lng

◆ $mode

◆ $rbac_review

◆ $settings

◆ $skip_fields

◆ $skip_groups

◆ $user_fields

◆ $user_settings_config

◆ MODE_DESKTOP

◆ MODE_REGISTRATION