ilUserProfile Class Reference

Class ilUserProfile. More...

Collaboration diagram for ilUserProfile:

Public Member Functions
	__construct ()
	getStandardFields ()
	Get standard user fields array. More...
	getLocalUserAdministrationFields ()
	Get visible fields in local user administration. More...
	skipGroup (string $a_group)
	Skip a group. More...
	skipField (string $a_field)
	Skip a field. More...
	addStandardFieldsToForm (ilPropertyFormGUI $a_form, ?ilObjUser $a_user=null, array $custom_fields=null)
	Add standard fields to form. More...
	setAjaxCallback (string $a_href)

Static Public Member Functions
static	userSettingVisible (string $a_setting)
	Checks whether user setting is visible. More...
static	setMode (int $mode)
static	isProfileIncomplete (ilObjUser $a_user, bool $a_include_udf=true, bool $a_personal_data_only=true)
	Check if all required personal data fields are set. More...
static	getIgnorableRequiredSettings ()
	Returns an array of all ignorable profiel fields. More...

Data Fields
const	MODE_DESKTOP = 1
const	MODE_REGISTRATION = 2

Static Protected Member Functions
static	isEditableByUser (string $setting)
	Returns whether a profile setting is editable by an user in the profile gui. More...

Protected Attributes
string	$ajax_href
array	$skip_fields
array	$skip_groups
ilUserSettingsConfig	$user_settings_config

Static Private Attributes
static int	$mode = self::MODE_DESKTOP
static array	$user_field

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.

Constructor & Destructor Documentation

__construct()

ilUserProfile::__construct

(

)

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

    {
        global $DIC;
 
        $lng = $DIC->language();
 
        $this->skip_groups = array();
        $this->skip_fields = array();
 
        // for hide me from awareness tool text
        // not nicest workaround, but better than using common block
        $lng->loadLanguageModule("awrn");
        $lng->loadLanguageModule("buddysystem");
 
        $this->user_settings_config = new ilUserSettingsConfig();
    }

References $DIC, and $lng.

Member Function Documentation

addStandardFieldsToForm()

ilUserProfile::addStandardFieldsToForm	(	ilPropertyFormGUI	$a_form,
		?ilObjUser	$a_user = null,
		array	$custom_fields = null
	)

Add standard fields to form.

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

     : void {
        global $DIC;
 
        $ilSetting = $DIC['ilSetting'];
        $lng = $DIC['lng'];
        $rbacreview = $DIC['rbacreview'];
 
        $registration_settings = null;
 
        // custom registration settings
        if (self::$mode == self::MODE_REGISTRATION) {
            $registration_settings = new ilRegistrationSettings();
 
            self::$user_field["username"]["group"] = "login_data";
            self::$user_field["password"]["group"] = "login_data";
            self::$user_field["language"]["default"] = $lng->lang_key;
 
            // different position for role
            $roles = self::$user_field["roles"];
            unset(self::$user_field["roles"]);
            self::$user_field["roles"] = $roles;
            self::$user_field["roles"]["group"] = "settings";
        }
 
        $fields = $this->getStandardFields();
        $current_group = "";
        $custom_fields_done = false;
        foreach ($fields as $f => $p) {
            // next group? -> diplay subheader
            if (($p["group"] != $current_group) &&
                self::userSettingVisible($f)) {
                if (is_array($custom_fields) && $custom_fields !== [] && !$custom_fields_done) {
                    // should be appended to "other" or at least before "settings"
                    if ($current_group == "other" || $p["group"] == "settings") {
                        // add "other" subheader
                        if ($current_group != "other") {
                            $sh = new ilFormSectionHeaderGUI();
                            $sh->setTitle($lng->txt("other"));
                            $a_form->addItem($sh);
                        }
                        foreach ($custom_fields as $custom_field) {
                            $a_form->addItem($custom_field);
                        }
                        $custom_fields_done = true;
                    }
                }
 
                $sh = new ilFormSectionHeaderGUI();
                $sh->setTitle($lng->txt($p["group"]));
                $a_form->addItem($sh);
                $current_group = $p["group"];
            }
 
            $m = $p["method"] ?? "";
 
            $lv = (isset($p["lang_var"]) && $p["lang_var"] != "")
                ? $p["lang_var"]
                : $f;
 
            switch ($p["input"]) {
                case "login":
                    if ((int) $ilSetting->get('allow_change_loginname') || self::$mode == self::MODE_REGISTRATION) {
                        $val = new ilTextInputGUI($lng->txt('username'), 'username');
                        if ($a_user) {
                            $val->setValue($a_user->getLogin());
                        }
                        $val->setMaxLength((int) $p['maxlength']);
                        $val->setSize(255);
                        $val->setRequired(true);
                    } else {
                        // user account name
                        $val = new ilNonEditableValueGUI($lng->txt("username"), 'ne_un');
                        if ($a_user) {
                            $val->setValue($a_user->getLogin());
                        }
                    }
                    $a_form->addItem($val);
                    break;
 
                case "text":
                    if (self::userSettingVisible($f)) {
                        $ti = new ilTextInputGUI($lng->txt($lv), "usr_" . $f);
                        $value = '';
                        if ($a_user) {
                            $value = $a_user->$m() ?? '';
                        }
                        $ti->setValue($value);
                        $ti->setMaxLength($p["maxlength"]);
                        $ti->setSize($p["size"]);
                        $ti->setRequired((bool) $ilSetting->get("require_" . $f));
                        if (!$ti->getRequired() || $ti->getValue()) {
                            $ti->setDisabled((bool) $ilSetting->get("usr_settings_disable_" . $f));
                        }
                        $a_form->addItem($ti);
                    }
                    break;
 
                case "sel_country":
                    if (self::userSettingVisible($f)) {
                        $ci = new ilCountrySelectInputGUI($lng->txt($lv), "usr_" . $f);
                        if ($a_user) {
                            $ci->setValue($a_user->$m());
                        }
                        $ci->setRequired((bool) $ilSetting->get("require_" . $f));
                        if (!$ci->getRequired() || $ci->getValue()) {
                            $ci->setDisabled((bool) $ilSetting->get("usr_settings_disable_" . $f));
                        }
                        $a_form->addItem($ci);
                    }
                    break;
 
                case "birthday":
                    if (self::userSettingVisible($f)) {
                        $bi = new ilBirthdayInputGUI($lng->txt($lv), "usr_" . $f);
                        $date = null;
                        if ($a_user && strlen($a_user->$m())) {
                            $date = new ilDateTime($a_user->$m(), IL_CAL_DATE);
                            $bi->setDate($date);
                        }
                        $bi->setRequired((bool) $ilSetting->get("require_" . $f));
                        if (!$bi->getRequired() || $date) {
                            $bi->setDisabled((bool) $ilSetting->get("usr_settings_disable_" . $f));
                        }
                        $a_form->addItem($bi);
                    }
                    break;
 
                case "radio":
                    if (self::userSettingVisible($f)) {
                        $rg = new ilRadioGroupInputGUI($lng->txt($lv), "usr_" . $f);
                        if ($a_user) {
                            $rg->setValue($a_user->$m());
                        }
                        foreach ($p["values"] as $k => $v) {
                            $op = new ilRadioOption($lng->txt($v), $k);
                            $rg->addOption($op);
                        }
                        $rg->setRequired((bool) $ilSetting->get("require_" . $f));
                        if (!$rg->getRequired() || $rg->getValue()) {
                            $rg->setDisabled((bool) $ilSetting->get("usr_settings_disable_" . $f));
                        }
                        $a_form->addItem($rg);
                    }
                    break;
 
                case "picture":
                    if (self::userSettingVisible("upload") && $a_user) {
                        $ii = new ilImageFileInputGUI($lng->txt("personal_picture"), "userfile");
                        $ii->setAllowCapture(true);
                        $ii->setDisabled((bool) $ilSetting->get("usr_settings_disable_upload"));
 
                        $upload = $a_form->getFileUpload("userfile");
                        if ($upload["name"] ?? false) {
                            $ii->setPending($upload["name"]);
                        } else {
                            $im = ilObjUser::_getPersonalPicturePath(
                                $a_user->getId(),
                                "small",
                                true,
                                true
                            );
                            if ($im != "") {
                                $ii->setImage($im);
                                $ii->setAlt($lng->txt("personal_picture"));
                            }
                        }
 
                        $a_form->addItem($ii);
                    }
                    break;
 
                case "roles":
                    $role_names = "";
                    if (self::$mode == self::MODE_DESKTOP) {
                        if (self::userSettingVisible("roles")) {
                            $global_roles = $rbacreview->getGlobalRoles();
                            foreach ($global_roles as $role_id) {
                                if (in_array($role_id, $rbacreview->assignedRoles($a_user->getId()))) {
                                    $roleObj = ilObjectFactory::getInstanceByObjId($role_id);
                                    $role_names .= $roleObj->getTitle() . ", ";
                                    unset($roleObj);
                                }
                            }
                            $dr = new ilNonEditableValueGUI($lng->txt("default_roles"), "ne_dr");
                            $dr->setValue(substr($role_names, 0, -2));
                            $a_form->addItem($dr);
                        }
                    } elseif (self::$mode == self::MODE_REGISTRATION) {
                        if ($registration_settings->roleSelectionEnabled()) {
                            $options = array();
                            foreach (ilObjRole::_lookupRegisterAllowed() as $role) {
                                $options[$role["id"]] = $role["title"];
                            }
                            // registration form validation will take care of missing field / value
                            if ($options) {
                                if (count($options) > 1) {
                                    $ta = new ilSelectInputGUI($lng->txt('default_role'), "usr_" . $f);
                                    $ta->setOptions($options);
                                    $ta->setRequired((bool) $ilSetting->get("require_" . $f));
                                    if (!$ta->getRequired()) {
                                        $ta->setDisabled((bool) $ilSetting->get("usr_settings_disable_" . $f));
                                    }
                                }
                                // no need for select if only 1 option
                                else {
                                    $ta = new ilHiddenInputGUI("usr_" . $f);
                                    $keys = array_keys($options);
                                    $ta->setValue(array_shift($keys));
                                }
                                $a_form->addItem($ta);
                            }
                        }
                    }
                    break;
 
                case "second_email":
                case "email":
                    if (self::userSettingVisible($f)) {
                        $em = new ilEMailInputGUI($lng->txt($lv), "usr_" . $f);
                        if ($a_user) {
                            $em->setValue($a_user->$m());
                        }
                        $em->setRequired((bool) $ilSetting->get("require_" . $f));
                        if (!$em->getRequired() || $em->getValue()) {
                            $em->setDisabled((bool) $ilSetting->get("usr_settings_disable_" . $f));
                        }
                        if (self::MODE_REGISTRATION == self::$mode) {
                            $em->setRetype(true);
                        }
                        $em->setMaxLength((int) $p['maxlength']);
                        $a_form->addItem($em);
                    }
                    break;
                case "textarea":
                    if (self::userSettingVisible($f)) {
                        $ta = new ilTextAreaInputGUI($lng->txt($lv), "usr_" . $f);
                        if ($a_user) {
                            $ta->setValue($a_user->$m() ?? '');
                        }
                        $ta->setRows($p["rows"]);
                        $ta->setCols($p["cols"]);
                        $ta->setRequired((bool) $ilSetting->get("require_" . $f));
                        if (!$ta->getRequired() || $ta->getValue()) {
                            $ta->setDisabled((bool) $ilSetting->get("usr_settings_disable_" . $f));
                        }
                        $a_form->addItem($ta);
                    }
                    break;
 
                case "password":
                    if (self::$mode == self::MODE_REGISTRATION) {
                        if (!$registration_settings->passwordGenerationEnabled()) {
                            $ta = new ilPasswordInputGUI($lng->txt($lv), "usr_" . $f);
                            $ta->setUseStripSlashes(false);
                            $ta->setRequired(true);
                            $ta->setInfo(ilSecuritySettingsChecker::getPasswordRequirementsInfo());
                            // $ta->setDisabled($ilSetting->get("usr_settings_disable_".$f));
                        } else {
                            $ta = new ilNonEditableValueGUI($lng->txt($lv));
                            $ta->setValue($lng->txt("reg_passwd_via_mail"));
                        }
                        $a_form->addItem($ta);
                    }
                    break;
 
                case "language":
                    if (self::userSettingVisible($f)) {
                        $ta = new ilSelectInputGUI($lng->txt($lv), "usr_" . $f);
                        if ($a_user) {
                            $ta->setValue($a_user->$m());
                        }
                        $options = array();
                        $lng->loadLanguageModule("meta");
                        foreach ($lng->getInstalledLanguages() as $lang_key) {
                            $options[$lang_key] = $lng->txt("meta_l_" . $lang_key);
                        }
                        asort($options); // #9728
                        $ta->setOptions($options);
                        $ta->setRequired((bool) $ilSetting->get("require_" . $f));
                        if (!$ta->getRequired() || $ta->getValue()) {
                            $ta->setDisabled(
                                $ilSetting->get("usr_settings_disable_" . $f) === '1'
                                || count($options) <= 1
                            );
                        }
                        $a_form->addItem($ta);
                    }
                    break;
 
                case "multitext":
                    if (self::userSettingVisible($f)) {
                        $ti = new ilTextInputGUI($lng->txt($lv), "usr_" . $f);
                        $ti->setMulti(true);
                        if ($a_user) {
                            $ti->setValue($a_user->$m());
                        }
                        $ti->setMaxLength($p["maxlength"]);
                        $ti->setSize($p["size"]);
                        $ti->setRequired((bool) $ilSetting->get("require_" . $f));
                        if (!$ti->getRequired() || $ti->getValue()) {
                            $ti->setDisabled((bool) $ilSetting->get("usr_settings_disable_" . $f));
                        }
                        if ($this->ajax_href) {
                            // add field to ajax call
                            $ti->setDataSource($this->ajax_href . "&f=" . $f);
                        }
                        $a_form->addItem($ti);
                    }
                    break;
                case "noneditable":
                    if (self::$mode == self::MODE_DESKTOP && self::userSettingVisible($f)) {
                        $ne = new ilNonEditableValueGUI($lng->txt($lv));
                        $ne->setValue($a_user->$m());
                        $a_form->addItem($ne);
                    }
                    break;
            }
        }
 
        // append custom fields as "other"
        if (is_array($custom_fields) && $custom_fields !== [] && !$custom_fields_done) {
            // add "other" subheader
            if ($current_group != "other") {
                $sh = new ilFormSectionHeaderGUI();
                $sh->setTitle($lng->txt("other"));
                $a_form->addItem($sh);
            }
            foreach ($custom_fields as $custom_field) {
                $a_form->addItem($custom_field);
            }
        }
    }

References $lng.

getIgnorableRequiredSettings()

static ilUserProfile::getIgnorableRequiredSettings ( )

static

Returns an array of all ignorable profiel fields.

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

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

References $DIC, and $ilSetting.

Referenced by ilObjUserGUI\handleIgnoredRequiredFields().

Here is the caller graph for this function:

getLocalUserAdministrationFields()

ilUserProfile::getLocalUserAdministrationFields

(

)

Get visible fields in local user administration.

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

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

References $DIC, $ilSetting, and getStandardFields().

Here is the call graph for this function:

getStandardFields()

ilUserProfile::getStandardFields

(

)

Get standard user fields array.

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

                                       : array // Missing array type.
    {
        $fields = array();
        foreach (self::$user_field 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;
    }

References Vendor\Package\$f.

Referenced by getLocalUserAdministrationFields().

Here is the caller graph for this function:

isEditableByUser()

static ilUserProfile::isEditableByUser ( string  $setting )

staticprotected

Returns whether a profile setting is editable by an user in the profile gui.

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

                                                               : bool
    {
        $user_settings_config = new ilUserSettingsConfig();
        return $user_settings_config->isVisibleAndChangeable($setting);
    }

References ilUserSettingsConfig\isVisibleAndChangeable().

Here is the call graph for this function:

isProfileIncomplete()

static ilUserProfile::isProfileIncomplete ( ilObjUser  $a_user, bool  $a_include_udf = true, bool  $a_personal_data_only = true  )

static

Check if all required personal data fields are set.

Parameters

ilObjUser	$a_user
bool	$a_include_udf	check custom fields, too
bool	$a_personal_data_only	only check fields which are visible in personal data

Returns

bool

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

     : bool {
        global $DIC;
 
        $ilSetting = $DIC['ilSetting'];
 
        $user_settings_config = new ilUserSettingsConfig();
 
        // standard fields
        foreach (self::$user_field as $field => $definition) {
            // only if visible in personal data
            if ($a_personal_data_only && !$user_settings_config->isVisible($field)) {
                continue;
            }
 
            if ($ilSetting->get("require_" . $field) && $definition["method"]) {
                $value = $a_user->{$definition["method"]}();
                if ($value == "") {
                    return true;
                }
            }
        }
 
        // custom fields
        if ($a_include_udf) {
            $user_defined_data = $a_user->getUserDefinedData();
 
            $user_defined_fields = ilUserDefinedFields::_getInstance();
            foreach ($user_defined_fields->getRequiredDefinitions() as $field => $definition) {
                // only if visible in personal data
                if ($a_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;
    }

Referenced by ilUserImportParser\checkProfileIncomplete(), ilAuthFrontend\handleAuthenticationSuccess(), and ilObjUserGUI\saveObject().

Here is the caller graph for this function:

setAjaxCallback()

ilUserProfile::setAjaxCallback

(

string

$a_href

)

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

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

setMode()

static ilUserProfile::setMode ( int  $mode )

static

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

                                             : bool
    {
        if (in_array($mode, array(self::MODE_DESKTOP, self::MODE_REGISTRATION))) {
            self::$mode = $mode;
            return true;
        }
        return false;
    }

Referenced by ilAccountRegistrationGUI\initForm().

Here is the caller graph for this function:

skipField()

ilUserProfile::skipField

(

string

$a_field

)

Skip a field.

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

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

skipGroup()

ilUserProfile::skipGroup

(

string

$a_group

)

Skip a group.

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

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

userSettingVisible()

static ilUserProfile::userSettingVisible ( string  $a_setting )

static

Checks whether user setting is visible.

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

                                                                : bool
    {
        global $DIC;
 
        $ilSetting = $DIC['ilSetting'];
 
 
        $user_settings_config = new ilUserSettingsConfig();
 
        if (self::$mode == self::MODE_DESKTOP) {
            return ($user_settings_config->isVisible($a_setting));
        } else {
            if (isset(self::$user_field[$a_setting]["visib_reg_hide"]) && self::$user_field[$a_setting]["visib_reg_hide"] === true) {
                return true;
            }
            return ($ilSetting->get("usr_settings_visib_reg_" . $a_setting, "1") || $ilSetting->get("require_" . $a_setting, "0"));
        }
    }

References $DIC, $ilSetting, and ilUserSettingsConfig\isVisible().

Referenced by ilUserDataSet\importRecord().

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 396 of file class.ilUserProfile.php.

$mode

int ilUserProfile::$mode = self::MODE_DESKTOP

staticprivate

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

$skip_fields

array ilUserProfile::$skip_fields

protected

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

$skip_groups

array ilUserProfile::$skip_groups

protected

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

$user_field

array ilUserProfile::$user_field

staticprivate

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

$user_settings_config

ilUserSettingsConfig ilUserProfile::$user_settings_config

protected

Definition at line 400 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/class.ilUserProfile.php