ilObjUserGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilObjUserGUI:

Collaboration diagram for ilObjUserGUI:

Public Member Functions
	__construct ( $a_data, int $a_id, bool $a_call_by_reference=false, bool $a_prepare_output=true, ILIAS\UI\Factory $uiFactory=null, ILIAS\UI\Renderer $uiRenderer=null)
	executeCommand ()
	cancelObject ()
	getAdminTabs ()
	setBackTarget (string $a_text, string $a_link)
	set back tab target More...
	__checkUserDefinedRequiredFields ()
	__showUserDefinedFields ()
	initCreate ()
	createObject ()
	Display user create form. More...
	saveObject ()
	save user data More...
	editObject ()
	Display user edit form. More...
	getValues ()
	Get values from user object and put them into form. More...
	initForm (string $a_mode)
	Init user form. More...
	uploadUserPictureObject ()
	upload user image (original method by ratana ty) More...
	removeUserPictureObject ()
	remove user image More...
	assignSaveObject ()
	assign users to role More...
	roleassignmentObject ()
	display role assignment panel More...
	applyFilterObject ()
	Apply filter. More...
	resetFilterObject ()
	Reset filter. More...
	__getDateSelect (string $a_type, string $a_varname, string $a_selected)
	__toUnix (array $a_time_arr)
	__unsetSessionVariables ()
	__buildFilterSelect ()
Public Member Functions inherited from ilObjectGUI
	__construct ($data, int $id=0, bool $call_by_reference=true, bool $prepare_output=true)
	getRefId ()
	setAdminMode (string $mode)
	getAdminMode ()
	getObject ()
	executeCommand ()
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	setCreationMode (bool $mode=true)
	if true, a creation screen is displayed the current [ref_id] don't belong to the current class! The mode is determined in ilRepositoryGUI More...
	getCreationMode ()
	prepareOutput (bool $show_sub_objects=true)
	getAdminTabs ()
	administration tabs show only permissions and trash folder More...
	getHTML ()
	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...
	cancelDeleteObject ()
	cancel deletion of object More...
	cancelObject ()
	cancel action and go back to previous page More...
	createObject ()
	create new object form More...
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	getDidacticTemplateVar (string $type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $obj, int $parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	addExternalEditFormCustom (ilPropertyFormGUI $form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...
	isVisible (int $ref_id, string $type)
	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...
	deleteObject (bool $error=false)
	Display deletion confirmation screen. More...
	setColumnSettings (ilColumnGUI $column_gui)
	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html Should be overwritten and redirect to settings screen. More...
	addToDeskObject ()
	removeFromDeskObject ()
Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Data Fields
ilCtrl	$ilCtrl
array	$gender
int	$user_ref_id
Data Fields inherited from ilObjectGUI
const	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION
const	ADMIN_MODE_NONE = ""
const	ADMIN_MODE_SETTINGS = "settings"
const	ADMIN_MODE_REPOSITORY = "repository"
const	UPLOAD_TYPE_LOCAL = 1
const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3

Protected Member Functions
	setTitleAndDescription ()
	getTabs ()
	loadValuesFromForm (string $a_mode='create')
	loadUserDefinedDataFromForm (?ilObjUser $user=null)
	isSettingChangeable (string $a_field)
	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	handleIgnoredRequiredFields ()
	Handles ignored required fields by changing the required flag of form elements. More...
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	assignObject ()
	setTitleAndDescription ()
	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...
	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	setTabs ()
	set admin tabs More...
	setAdminTabs ()
	set admin tabs More...
	setLocator ()
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator (bool $omit=true)
	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	initCreationForms (string $new_type)
	Init creation forms. More...
	getCreationFormsHTML (array $forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm (string $new_type)
	initDidacticTemplate (ilPropertyFormGUI $form)
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	initImportForm (string $new_type)
	importFileObject (int $parent_id=null)
	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...
	setFormAction (string $cmd, string $form_action)
	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...
	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...
	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...
	getTabs ()
	overwrite in derived GUI class of your object type More...
	redirectToRefId (int $ref_id, string $cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...
	fillCloneTemplate (?string $tpl_name, string $type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	showCustomIconsEditing ( $input_colspan=1, ilPropertyFormGUI $form=null, $as_section=true)
	show edit section of custom icons for container More...

Protected Attributes
bool	$update
array	$selectable_roles
int	$default_role
ilUserDefinedFields	$user_defined_fields
array	$back_target
ilPropertyFormGUI	$form_gui
ILIAS User StandardGUIRequest	$user_request
int	$usrf_ref_id
ILIAS UI Factory	$uiFactory
ILIAS UI Renderer	$uiRenderer
string	$requested_letter = ""
string	$requested_baseClass = ""
string	$requested_search = ""
Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service
ServerRequestInterface	$request
ilLocatorGUI	$locator
ilObjUser	$user
ilAccessHandler	$access
ilSetting	$settings
ilToolbarGUI	$toolbar
ilRbacAdmin	$rbac_admin
ilRbacSystem	$rbac_system
ilRbacReview	$rbac_review
ilObjectService	$object_service
ilObjectDefinition	$obj_definition
ilGlobalTemplateInterface	$tpl
ilTree	$tree
ilCtrl	$ctrl
ilErrorHandling	$error
ilLanguage	$lng
ilTabsGUI	$tabs_gui
ILIAS	$ilias
ArrayBasedRequestWrapper	$post_wrapper
RequestWrapper	$request_wrapper
Factory	$refinery
ilFavouritesManager	$favourites
ilObjectCustomIconFactory	$custom_icon_factory
ilObject	$object = null
bool	$creation_mode = false
	$data
int	$id
bool	$call_by_reference = false
bool	$prepare_output
int	$ref_id
int	$obj_id
int	$maxcount
array	$form_action = []
array	$return_location = []
array	$target_frame = []
string	$tmp_import_dir
string	$sub_objects = ""
bool	$omit_locator = false
string	$type = ""
string	$admin_mode = self::ADMIN_MODE_NONE
int	$requested_ref_id = 0
int	$requested_crtptrefid = 0
int	$requested_crtcb = 0
string	$requested_new_type = ""
string	$link_params
string	$html = ""

Private Member Functions
	checkUserWriteRight ()

Additional Inherited Members
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot (bool $raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode (int $ref_id, string $cmd="")
static	_gotoSharedWorkspaceNode (int $wsp_id)

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilObjUserGUI

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Sascha Hofmann sasch.nosp@m.ahof.nosp@m.mann@.nosp@m.gmx..nosp@m.de ilObjUserGUI: ilLearningProgressGUI, ilObjectOwnershipManagementGUI

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

Constructor & Destructor Documentation

__construct()

ilObjUserGUI::__construct	(		$a_data,
		int	$a_id,
		bool	$a_call_by_reference = false,
		bool	$a_prepare_output = true,
		ILIAS\UI\Factory	$uiFactory = null,
		ILIAS\UI\Renderer	$uiRenderer = null
	)

Definition at line 47 of file class.ilObjUserGUI.php.

References $DIC, $ilCtrl, ilObjectGUI\$lng, ilObjectGUI\$ref_id, $uiFactory, $uiRenderer, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), and ilLanguage\loadLanguageModule().

      {
        global $DIC;

        if (null === $uiFactory) {
            $uiFactory = $DIC->ui()->factory();
        }
        $this->uiFactory = $uiFactory;

        if (null === $uiRenderer) {
            $uiRenderer = $DIC->ui()->renderer();
        }
        $this->uiRenderer = $uiRenderer;

        $ilCtrl = $DIC['ilCtrl'];
        $lng = $DIC['lng'];

        $this->type = "usr";
        parent::__construct($a_data, $a_id, $a_call_by_reference, false);
        $this->usrf_ref_id = $this->ref_id;

        $this->ctrl = $ilCtrl;
        $this->ctrl->saveParameter($this, array('obj_id', 'letter'));
        $this->ctrl->setParameterByClass("ilobjuserfoldergui", "letter", $this->requested_letter);
        //$this->ctrl->setContext($this->object->getId(), 'usr');
        $lng->loadLanguageModule('user');

        // for gender selection. don't change this
        // maybe deprecated
        $this->gender = array(
            'n' => "salutation_n",
            'm' => "salutation_m",
            'f' => "salutation_f",
        );

        $this->user_request = new \ILIAS\User\StandardGUIRequest(
            $DIC->http(),
            $DIC->refinery()
        );

        $this->requested_letter = $this->user_request->getLetter();
        $this->requested_baseClass = $this->user_request->getBaseClass();
        $this->requested_search = $this->user_request->getSearch();
    }

Here is the call graph for this function:

Member Function Documentation

__buildFilterSelect()

ilObjUserGUI::__buildFilterSelect

(

)

Definition at line 1891 of file class.ilObjUserGUI.php.

References ilLegacyFormElementsUtil\formSelect(), ilSession\get(), and ILIAS\Repository\lng().

                                         : string
    {
        $action[0] = $this->lng->txt('assigned_roles');
        $action[1] = $this->lng->txt('all_roles');
        $action[2] = $this->lng->txt('all_global_roles');
        $action[3] = $this->lng->txt('all_local_roles');
        $action[4] = $this->lng->txt('internal_local_roles_only');
        $action[5] = $this->lng->txt('non_internal_local_roles_only');

        return ilLegacyFormElementsUtil::formSelect(
            ilSession::get("filtered_roles"),
            "filter",
            $action,
            false,
            true
        );
    }

Here is the call graph for this function:

__checkUserDefinedRequiredFields()

ilObjUserGUI::__checkUserDefinedRequiredFields

(

)

Definition at line 233 of file class.ilObjUserGUI.php.

References ilUserDefinedFields\_getInstance().

                                                      : bool
    {
        $this->user_defined_fields = ilUserDefinedFields::_getInstance();

        $udfs = $this->user_request->getUDFs();
        foreach ($this->user_defined_fields->getDefinitions() as $field_id => $definition) {
            if ($definition['required'] and !strlen($udfs[$field_id])) {
                return false;
            }
        }
        return true;
    }

Here is the call graph for this function:

__getDateSelect()

ilObjUserGUI::__getDateSelect	(	string	$a_type,
		string	$a_varname,
		string	$a_selected
	)

Definition at line 1828 of file class.ilObjUserGUI.php.

References $i, ilLegacyFormElementsUtil\formSelect(), and ILIAS\Repository\int().

     : string {
        $year = null;
        switch ($a_type) {
            case "minute":
                for ($i = 0; $i <= 60; $i++) {
                    $days[$i] = $i < 10 ? "0" . $i : $i;
                }
                return ilLegacyFormElementsUtil::formSelect($a_selected, $a_varname, $days, false, true);

            case "hour":
                for ($i = 0; $i < 24; $i++) {
                    $days[$i] = $i < 10 ? "0" . $i : $i;
                }
                return ilLegacyFormElementsUtil::formSelect($a_selected, $a_varname, $days, false, true);

            case "day":
                for ($i = 1; $i < 32; $i++) {
                    $days[$i] = $i < 10 ? "0" . $i : $i;
                }
                return ilLegacyFormElementsUtil::formSelect($a_selected, $a_varname, $days, false, true);

            case "month":
                for ($i = 1; $i < 13; $i++) {
                    $month[$i] = $i < 10 ? "0" . $i : $i;
                }
                return ilLegacyFormElementsUtil::formSelect($a_selected, $a_varname, $month, false, true);

            case "year":
                if ($a_selected < date('Y')) {
                    $start = $a_selected;
                } else {
                    $start = date('Y');
                }

                for ($i = $start; $i < ((int) date("Y") + 11); ++$i) {
                    $year[$i] = $i;
                }
                return ilLegacyFormElementsUtil::formSelect($a_selected, $a_varname, $year, false, true);
        }
        return "";
    }

Here is the call graph for this function:

__showUserDefinedFields()

ilObjUserGUI::__showUserDefinedFields

(

)

Definition at line 246 of file class.ilObjUserGUI.php.

References $name, ilUserDefinedFields\_getInstance(), ilLegacyFormElementsUtil\formSelect(), ilSession\get(), ILIAS\Repository\object(), ilLegacyFormElementsUtil\prepareFormOutput(), and UDF_TYPE_TEXT.

                                             : void
    {
        $user_defined_data = null;
        $this->user_defined_fields = ilUserDefinedFields::_getInstance();

        if ($this->object->getType() == 'usr') {
            $user_defined_data = $this->object->getUserDefinedData();
        }
        foreach ($this->user_defined_fields->getDefinitions() as $field_id => $definition) {
            $error_post_vars = ilSession::get("error_post_vars");
            $old = $error_post_vars["udf"][$field_id] ?? $user_defined_data[$field_id];

            if ($definition['field_type'] == UDF_TYPE_TEXT) {
                $this->tpl->setCurrentBlock("field_text");
                $this->tpl->setVariable("FIELD_NAME", 'udf[' . $definition['field_id'] . ']');
                $this->tpl->setVariable("FIELD_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($old));
            } else {
                $this->tpl->setCurrentBlock("field_select");
                $this->tpl->setVariable(
                    "SELECT_BOX",
                    ilLegacyFormElementsUtil::formSelect(
                        $old,
                        'udf[' . $definition['field_id'] . ']',
                        $this->user_defined_fields->fieldValuesToSelectArray(
                            $definition['field_values']
                        ),
                        false,
                        true
                    )
                );
            }
            $this->tpl->parseCurrentBlock();
            $this->tpl->setCurrentBlock("user_defined");

            if ($definition['required']) {
                $name = $definition['field_name'] . "<span class=\"asterisk\">*</span>";
            } else {
                $name = $definition['field_name'];
            }
            $this->tpl->setVariable("TXT_FIELD_NAME", $name);
            $this->tpl->parseCurrentBlock();
        }
    }

Here is the call graph for this function:

__toUnix()

ilObjUserGUI::__toUnix

(

array

$a_time_arr

)

Definition at line 1874 of file class.ilObjUserGUI.php.

                                               : int // Missing array type.
    {
        return mktime(
            $a_time_arr["hour"],
            $a_time_arr["minute"],
            $a_time_arr["second"],
            $a_time_arr["month"],
            $a_time_arr["day"],
            $a_time_arr["year"]
        );
    }

__unsetSessionVariables()

ilObjUserGUI::__unsetSessionVariables

(

)

Definition at line 1886 of file class.ilObjUserGUI.php.

References ilSession\clear().

                                             : void
    {
        ilSession::clear("filtered_roles");
    }

Here is the call graph for this function:

addAdminLocatorItems()

ilObjUserGUI::addAdminLocatorItems ( bool  $do_not_add_object = false )

protected

should be overwritten to add object specific items (repository items are preloaded)

Definition at line 1913 of file class.ilObjUserGUI.php.

References $DIC, $GLOBALS, ilObjectGUI\$ilias, $ilUser, ilFrameTargetInfo\_getFrame(), ilMail\_getInstallationSignature(), ilObjUser\_lookupId(), ilObject\_lookupObjId(), ilObject\_lookupType(), ANONYMOUS_USER_ID, ilPersonalProfileGUI\CHANGE_EMAIL_CMD, ilCtrl\clearParametersByClass(), ILIAS\Repository\ctrl(), exit, ILIAS\Repository\lng(), ILIAS\Repository\object(), ilCtrl\redirectByClass(), ROLE_FOLDER_ID, ilCtrl\setParameterByClass(), ilCtrl\setTargetScript(), ilUtil\stripSlashes(), SYSTEM_FOLDER_ID, and USER_FOLDER_ID.

                                                                            : void
    {
        global $DIC;

        $ilLocator = $DIC['ilLocator'];

        $ilLocator->clearItems();

        if ($this->admin_mode == "settings") {    // system settings
            $this->ctrl->setParameterByClass(
                "ilobjsystemfoldergui",
                "ref_id",
                SYSTEM_FOLDER_ID
            );
            $ilLocator->addItem(
                $this->lng->txt("administration"),
                $this->ctrl->getLinkTargetByClass(array("iladministrationgui", "ilobjsystemfoldergui"), ""),
                ilFrameTargetInfo::_getFrame("MainContent")
            );

            if ($this->requested_ref_id == USER_FOLDER_ID) {
                $ilLocator->addItem(
                    $this->lng->txt("obj_" . ilObject::_lookupType(
                        ilObject::_lookupObjId($this->requested_ref_id)
                    )),
                    $this->ctrl->getLinkTargetByClass("ilobjuserfoldergui", "view")
                );
            } elseif ($this->requested_ref_id == ROLE_FOLDER_ID) {
                $ilLocator->addItem(
                    $this->lng->txt("obj_" . ilObject::_lookupType(
                        ilObject::_lookupObjId($this->requested_ref_id)
                    )),
                    $this->ctrl->getLinkTargetByClass("ilobjrolefoldergui", "view")
                );
            }

            if ($this->obj_id > 0) {
                $ilLocator->addItem(
                    $this->object->getTitle(),
                    $this->ctrl->getLinkTarget($this, "view")
                );
            }
        }
    }

Here is the call graph for this function:

applyFilterObject()

ilObjUserGUI::applyFilterObject

(

)

Apply filter.

Definition at line 1809 of file class.ilObjUserGUI.php.

References roleassignmentObject().

                                       : void
    {
        $table_gui = new ilRoleAssignmentTableGUI($this, "roleassignment");
        $table_gui->writeFilterToSession();        // writes filter to session
        $table_gui->resetOffset();                // sets record offest to 0 (first page)
        $this->roleassignmentObject();
    }

Here is the call graph for this function:

assignSaveObject()

ilObjUserGUI::assignSaveObject

(

)

assign users to role

Definition at line 1685 of file class.ilObjUserGUI.php.

References $DIC, ILIAS\Repository\ctrl(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ILIAS\Repository\object(), SYSTEM_ROLE_ID, and SYSTEM_USER_ID.

                                      : void
    {
        global $DIC;

        $rbacsystem = $DIC['rbacsystem'];
        $rbacadmin = $DIC['rbacadmin'];
        $rbacreview = $DIC['rbacreview'];

        if (!$rbacsystem->checkAccess("edit_roleassignment", $this->usrf_ref_id)) {
            $this->ilias->raiseError(
                $this->lng->txt("msg_no_perm_assign_role_to_user"),
                $this->ilias->error_obj->MESSAGE
            );
        }

        $selected_roles = $this->user_request->getRoleIds();
        $posted_roles = $this->user_request->getPostedRoleIds();

        // prevent unassignment of system role from system user
        if ($this->object->getId() == SYSTEM_USER_ID and in_array(SYSTEM_ROLE_ID, $posted_roles)) {
            $selected_roles[] = SYSTEM_ROLE_ID;
        }

        $global_roles_all = $rbacreview->getGlobalRoles();
        $assigned_roles_all = $rbacreview->assignedRoles($this->object->getId());
        $assigned_roles = array_intersect($assigned_roles_all, $posted_roles);
        $assigned_global_roles_all = array_intersect($assigned_roles_all, $global_roles_all);
        $assigned_global_roles = array_intersect($assigned_global_roles_all, $posted_roles);

        $user_not_allowed_to_change_admin_role_assginements =
            !in_array(SYSTEM_ROLE_ID, $rbacreview->assignedRoles($this->user->getId()));

        if ($user_not_allowed_to_change_admin_role_assginements
            && in_array(SYSTEM_ROLE_ID, $assigned_roles_all)) {
            $selected_roles[] = SYSTEM_ROLE_ID;
        }

        $posted_global_roles = array_intersect($selected_roles, $global_roles_all);

        if (empty($selected_roles) && count($assigned_roles_all) === count($assigned_roles)
             || empty($posted_global_roles) && count($assigned_global_roles_all) === count($assigned_global_roles)) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('msg_min_one_role') . '<br/>' . $this->lng->txt('action_aborted'),
                true
            );
            $this->ctrl->redirect($this, 'roleassignment');
        }

        foreach (array_diff($assigned_roles, $selected_roles) as $role) {
            if ($this->object->getId() === (int) SYSTEM_USER_ID && $role === SYSTEM_ROLE_ID
                || $user_not_allowed_to_change_admin_role_assginements && $role === SYSTEM_ROLE_ID) {
                continue;
            }
            $rbacadmin->deassignUser($role, $this->object->getId());
        }

        foreach (array_diff($selected_roles, $assigned_roles) as $role) {
            if ($this->object->getId() === (int) SYSTEM_USER_ID && $role === SYSTEM_ROLE_ID
                || $user_not_allowed_to_change_admin_role_assginements && $role === SYSTEM_ROLE_ID) {
                continue;
            }
            $rbacadmin->assignUser($role, $this->object->getId(), false);
        }

        // update object data entry (to update last modification date)
        $this->object->update();

        $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_roleassignment_changed"), true);

        if (strtolower($this->requested_baseClass) == 'iladministrationgui') {
            $this->ctrl->redirect($this, 'roleassignment');
        } else {
            $this->ctrl->redirectByClass('ilobjcategorygui', 'listUsers');
        }
    }

Here is the call graph for this function:

cancelObject()

ilObjUserGUI::cancelObject

(

)

Definition at line 144 of file class.ilObjUserGUI.php.

References ilSession\clear(), and ILIAS\Repository\ctrl().

                                  : void
    {
        ilSession::clear("saved_post");

        if (strtolower($this->requested_baseClass) == 'iladministrationgui') {
            $this->ctrl->redirectByClass("ilobjuserfoldergui", "view");
        } else {
            $this->ctrl->redirectByClass('ilobjcategorygui', 'listUsers');
        }
    }

Here is the call graph for this function:

checkUserWriteRight()

ilObjUserGUI::checkUserWriteRight ( )

private

Definition at line 2161 of file class.ilObjUserGUI.php.

References ILIAS\Repository\access(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ilObjUserFolder\ORG_OP_EDIT_USER_ACCOUNTS, and USER_FOLDER_ID.

Referenced by editObject(), and loadUserDefinedDataFromForm().

                                          : void
    {
        if ($this->usrf_ref_id == USER_FOLDER_ID
            && (
                !$this->rbac_system->checkAccess('visible,read', $this->usrf_ref_id)
                || !$this->rbac_system->checkAccess('write', $this->usrf_ref_id)
                    && (
                        !$this->access->checkPositionAccess(\ilObjUserFolder::ORG_OP_EDIT_USER_ACCOUNTS, $this->usrf_ref_id)
                        || $this->access->checkPositionAccess(\ilObjUserFolder::ORG_OP_EDIT_USER_ACCOUNTS, $this->usrf_ref_id)
                            && !in_array(
                                $this->object->getId(),
                                $this->access->filterUserIdsByPositionOfCurrentUser(
                                    \ilObjUserFolder::ORG_OP_EDIT_USER_ACCOUNTS,
                                    USER_FOLDER_ID,
                                    [$this->object->getId()]
                                )
                            )
                    )
            )
        ) {
            $this->ilias->raiseError($this->lng->txt('msg_no_perm_modify_user'), $this->ilias->error_obj->MESSAGE);
        }

        // if called from local administration $this->usrf_ref_id is category id
        // Todo: this has to be fixed. Do not mix user folder id and category id
        if ($this->usrf_ref_id != USER_FOLDER_ID
            && !$this->rbac_system->checkAccess('cat_administrate_users', $this->object->getTimeLimitOwner())) {
            $this->ilias->raiseError($this->lng->txt('msg_no_perm_modify_user'), $this->ilias->error_obj->MESSAGE);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createObject()

ilObjUserGUI::createObject

(

)

Display user create form.

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

References $DIC, ilObjectGUI\$tpl, initCreate(), initForm(), ILIAS\Repository\lng(), and ilGlobalTemplateInterface\setContent().

                                  : void
    {
        global $DIC;

        $tpl = $DIC['tpl'];
        $rbacsystem = $DIC['rbacsystem'];

        if (!$rbacsystem->checkAccess('create_usr', $this->usrf_ref_id)
            && !$rbacsystem->checkAccess('cat_administrate_users', $this->usrf_ref_id)) {
            $this->ilias->raiseError($this->lng->txt("permission_denied"), $this->ilias->error_obj->MESSAGE);
        }

        $this->initCreate();
        $this->initForm("create");
        $tpl->setContent($this->form_gui->getHTML());
    }

Here is the call graph for this function:

editObject()

ilObjUserGUI::editObject

(

)

Display user edit form.

Definition at line 543 of file class.ilObjUserGUI.php.

References checkUserWriteRight(), getValues(), initForm(), and USER_FOLDER_ID.

Referenced by removeUserPictureObject().

                                : void
    {
        $this->checkUserWriteRight();

        if ($this->usrf_ref_id != USER_FOLDER_ID) {
            $this->tabs_gui->clearTargets();
        }

        // get form
        $this->initForm("edit");
        $this->getValues();
        $this->showAcceptedTermsOfService();
        $this->tpl->setContent($this->form_gui->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilObjUserGUI::executeCommand

(

)

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

References ILIAS\Repository\ctrl(), ilLearningProgressBaseGUI\LP_CONTEXT_USER_FOLDER, ILIAS\Repository\object(), ilObjectGUI\prepareOutput(), and USER_FOLDER_ID.

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

        $this->prepareOutput();

        switch ($next_class) {
            case "illearningprogressgui":
                $new_gui = new ilLearningProgressGUI(
                    ilLearningProgressBaseGUI::LP_CONTEXT_USER_FOLDER,
                    USER_FOLDER_ID,
                    $this->object->getId()
                );
                $this->ctrl->forwardCommand($new_gui);
                break;

            case "ilobjectownershipmanagementgui":
                $gui = new ilObjectOwnershipManagementGUI($this->object->getId());
                $this->ctrl->forwardCommand($gui);
                break;

            default:
                if ($cmd == "" || $cmd == "view") {
                    $cmd = "edit";
                }
                $cmd .= "Object";
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

getAdminTabs()

ilObjUserGUI::getAdminTabs

(

)

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

References getTabs().

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

Here is the call graph for this function:

getTabs()

ilObjUserGUI::getTabs ( )

protected

Definition at line 160 of file class.ilObjUserGUI.php.

References $DIC, ilObjUserTracking\_enabledLearningProgress(), ilObjUserTracking\_enabledUserRelatedData(), ILIAS\Repository\ctrl(), ilSession\get(), and ILIAS\Repository\lng().

Referenced by getAdminTabs().

                                : void
    {
        global $DIC;

        $rbacsystem = $DIC['rbacsystem'];
        $ilHelp = $DIC['ilHelp'];

        $this->tabs_gui->clearTargets();

        $ilHelp->setScreenIdComponent("usr");

        if ($this->requested_search) {
            $this->tabs_gui->setBackTarget(
                $this->lng->txt("search_results"),
                ilSession::get("usr_search_link")
            );

            $this->tabs_gui->addTarget(
                "properties",
                $this->ctrl->getLinkTarget($this, "edit"),
                array("edit", "", "view"),
                get_class($this),
                "",
                true
            );
        } else {
            $this->tabs_gui->addTarget(
                "properties",
                $this->ctrl->getLinkTarget($this, "edit"),
                array("edit", "", "view"),
                get_class($this)
            );
        }

        $this->tabs_gui->addTarget(
            "role_assignment",
            $this->ctrl->getLinkTarget($this, "roleassignment"),
            array("roleassignment"),
            get_class($this)
        );

        // learning progress
        if ($rbacsystem->checkAccess('read', $this->ref_id) and
            ilObjUserTracking::_enabledLearningProgress() and
            ilObjUserTracking::_enabledUserRelatedData()) {
            $this->tabs_gui->addTarget(
                'learning_progress',
                $this->ctrl->getLinkTargetByClass('illearningprogressgui', ''),
                '',
                array('illplistofobjectsgui', 'illplistofsettingsgui', 'illearningprogressgui', 'illplistofprogressgui')
            );
        }

        $this->tabs_gui->addTarget(
            'user_ownership',
            $this->ctrl->getLinkTargetByClass('ilobjectownershipmanagementgui', ''),
            '',
            'ilobjectownershipmanagementgui'
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getValues()

ilObjUserGUI::getValues

(

)

Get values from user object and put them into form.

Definition at line 905 of file class.ilObjUserGUI.php.

References ilObjectGUI\$data, ilUserDefinedFields\_getInstance(), ilObjUser\_lookupLogin(), ilDatePresentation\formatDate(), IL_CAL_DATE, IL_CAL_DATETIME, IL_CAL_UNIX, ILIAS\Repository\int(), and ILIAS\Repository\object().

Referenced by editObject().

                               : void
    {
        $data = array();

        // login data
        $data["auth_mode"] = $this->object->getAuthMode();
        $data["login"] = $this->object->getLogin();
        //$data["passwd"] = "********";
        //$data["passwd2"] = "********";
        $data["ext_account"] = $this->object->getExternalAccount();

        // system information
        $data["create_date"] = ilDatePresentation::formatDate(new ilDateTime(
            $this->object->getCreateDate(),
            IL_CAL_DATETIME
        ));
        $data["owner"] = ilObjUser::_lookupLogin($this->object->getOwner());
        $data["approve_date"] = ($this->object->getApproveDate() != "")
            ? ilDatePresentation::formatDate(new ilDateTime($this->object->getApproveDate(), IL_CAL_DATETIME))
            : null;
        $data["agree_date"] = ($this->object->getAgreeDate() != "")
            ? ilDatePresentation::formatDate(new ilDateTime($this->object->getAgreeDate(), IL_CAL_DATETIME))
            : null;
        $data["last_login"] = ($this->object->getLastLogin() != "")
            ? ilDatePresentation::formatDate(new ilDateTime($this->object->getLastLogin(), IL_CAL_DATETIME))
            : null;
        $data["active"] = $this->object->getActive();
        $data["time_limit_unlimited"] = $this->object->getTimeLimitUnlimited() ? '1' : '0';

        $data["time_limit_from"] = $this->object->getTimeLimitFrom()
            ? new ilDateTime($this->object->getTimeLimitFrom(), IL_CAL_UNIX)
            : null;
        $data["time_limit_until"] = $this->object->getTimeLimitUntil()
            ? new ilDateTime($this->object->getTimeLimitUntil(), IL_CAL_UNIX)
            : null;

        // personal data
        $data["gender"] = $this->object->getGender();
        $data["firstname"] = $this->object->getFirstname();
        $data["lastname"] = $this->object->getLastname();
        $data["title"] = $this->object->getUTitle();
        $data['birthday'] = $this->object->getBirthday()
            ? new ilDate($this->object->getBirthday(), IL_CAL_DATE)
            : null;
        $data["institution"] = $this->object->getInstitution();
        $data["department"] = $this->object->getDepartment();
        $data["street"] = $this->object->getStreet();
        $data["city"] = $this->object->getCity();
        $data["zipcode"] = $this->object->getZipcode();
        $data["country"] = $this->object->getCountry();
        $data["sel_country"] = $this->object->getSelectedCountry();
        $data["phone_office"] = $this->object->getPhoneOffice();
        $data["phone_home"] = $this->object->getPhoneHome();
        $data["phone_mobile"] = $this->object->getPhoneMobile();
        $data["fax"] = $this->object->getFax();
        $data["email"] = $this->object->getEmail();
        $data["second_email"] = $this->object->getSecondEmail();
        $data["hobby"] = $this->object->getHobby();
        $data["referral_comment"] = $this->object->getComment();

        // interests
        $data["interests_general"] = $this->object->getGeneralInterests();
        $data["interests_help_offered"] = $this->object->getOfferingHelp();
        $data["interests_help_looking"] = $this->object->getLookingForHelp();

        // other data
        $data["matriculation"] = $this->object->getMatriculation();
        $data["client_ip"] = $this->object->getClientIP();

        // user defined fields
        $this->user_defined_fields = ilUserDefinedFields::_getInstance();
        $user_defined_data = $this->object->getUserDefinedData();
        foreach ($this->user_defined_fields->getDefinitions() as $field_id => $definition) {
            $data["udf_" . $field_id] = $user_defined_data["f_" . $field_id] ?? "";
        }

        // settings
        $data["language"] = $this->object->getLanguage();
        $data["skin_style"] = $this->object->skin . ":" . $this->object->prefs["style"];
        $data["hits_per_page"] = $this->object->prefs["hits_per_page"] ?? "";
        $data["hide_own_online_status"] = $this->object->prefs["hide_own_online_status"] ?? "";
        $data['bs_allow_to_contact_me'] = ($this->object->prefs['bs_allow_to_contact_me'] ?? "") == 'y';
        $data['chat_osc_accept_msg'] = ($this->object->prefs['chat_osc_accept_msg'] ?? "") == 'y';
        $data['chat_broadcast_typing'] = ($this->object->prefs['chat_broadcast_typing'] ?? "") == 'y';
        $data["session_reminder_enabled"] = (int) ($this->object->prefs["session_reminder_enabled"] ?? 0);

        $data["send_mail"] = (($this->object->prefs['send_info_mails'] ?? "") == 'y');

        $this->form_gui->setValuesByArray($data);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

handleIgnoredRequiredFields()

ilObjUserGUI::handleIgnoredRequiredFields ( )

protected

Handles ignored required fields by changing the required flag of form elements.

Returns

bool A flag whether the user profile is maybe incomplete after saving the form data

Definition at line 2089 of file class.ilObjUserGUI.php.

References ilObjectGUI\$object, ilObjectGUI\$user, ilUserDefinedFields\_getInstance(), ilUserDefinedFields\getDefinitions(), ilUserProfile\getIgnorableRequiredSettings(), ILIAS\Repository\lng(), and ilNonEditableValueGUI\setValue().

Referenced by loadUserDefinedDataFromForm(), and saveObject().

                                                    : bool
    {
        $profile_maybe_incomplete = false;

        foreach (ilUserProfile::getIgnorableRequiredSettings() as $fieldName) {
            $elm = $this->form_gui->getItemByPostVar($fieldName);

            if (!$elm) {
                continue;
            }

            if ($elm->getRequired()) {
                $profile_maybe_incomplete = true;

                // Flag as optional
                $elm->setRequired(false);
            }
        }

        $user_defined_fields = ilUserDefinedFields::_getInstance();
        foreach ($user_defined_fields->getDefinitions() as $definition) {
            $elm = $this->form_gui->getItemByPostVar('udf_' . $definition['field_id']);

            if (!$elm) {
                continue;
            }
            if ($elm->getRequired() && $definition['required']) {
                $profile_maybe_incomplete = true;

                // Flag as optional
                $elm->setRequired(false);
            }
        }

        return $profile_maybe_incomplete;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initCreate()

ilObjUserGUI::initCreate

(

)

Definition at line 290 of file class.ilObjUserGUI.php.

References $DIC, $ilUser, ILIAS\LTI\ToolProvider\$key, $keys, ilObjRole\_getAssignUsersStatus(), ANONYMOUS_ROLE_ID, ILIAS\Repository\lng(), ILIAS\Repository\object(), ROLE_FOLDER_ID, SYSTEM_ROLE_ID, and USER_FOLDER_ID.

Referenced by createObject(), and saveObject().

                                : void
    {
        global $DIC;

        $rbacreview = $DIC['rbacreview'];
        $ilUser = $DIC['ilUser'];

        if ($this->usrf_ref_id != USER_FOLDER_ID) {
            $this->tabs_gui->clearTargets();
        }

        // role selection
        $obj_list = $rbacreview->getRoleListByObject(ROLE_FOLDER_ID);
        $rol = array();
        foreach ($obj_list as $obj_data) {
            // allow only 'assign_users' marked roles if called from category
            if ($this->object->getRefId() != USER_FOLDER_ID and !in_array(
                SYSTEM_ROLE_ID,
                $rbacreview->assignedRoles($ilUser->getId())
            )) {
                if (!ilObjRole::_getAssignUsersStatus($obj_data['obj_id'])) {
                    continue;
                }
            }
            // exclude anonymous role from list
            if ($obj_data["obj_id"] != ANONYMOUS_ROLE_ID) {
                // do not allow to assign users to administrator role if current user does not has SYSTEM_ROLE_ID
                if ($obj_data["obj_id"] != SYSTEM_ROLE_ID or in_array(
                    SYSTEM_ROLE_ID,
                    $rbacreview->assignedRoles($ilUser->getId())
                )) {
                    $rol[$obj_data["obj_id"]] = $obj_data["title"];
                }
            }
        }

        // raise error if there is no global role user can be assigned to
        if (!count($rol)) {
            $this->ilias->raiseError(
                $this->lng->txt("msg_no_roles_users_can_be_assigned_to"),
                $this->ilias->error_obj->MESSAGE
            );
        }

        $keys = array_keys($rol);

        // set pre defined user role to default
        if (in_array(4, $keys)) {
            $this->default_role = 4;
        } else {
            if (count($keys) > 1 and in_array(2, $keys)) {
                // remove admin role as preselectable role
                foreach ($keys as $key => $val) {
                    if ($val == 2) {
                        unset($keys[$key]);
                        break;
                    }
                }
            }

            $this->default_role = array_shift($keys);
        }
        $this->selectable_roles = $rol;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initForm()

ilObjUserGUI::initForm

(

string

$a_mode

)

Init user form.

Definition at line 999 of file class.ilObjUserGUI.php.

References $_SERVER, Vendor\Package\$a, $DIC, Vendor\Package\$e, ilObjectGUI\$id, $ilSetting, $ilUser, $lang, ilObjectGUI\$lng, $name, XapiProxy\$req, ilObjectGUI\$settings, ilAuthUtils\_getActiveAuthModes(), ilAuthUtils\_getAuthModeName(), ilUserDefinedFields\_getInstance(), ilObjUser\_getLastHistoryDataByUserId(), ilObjUser\_getPersonalPicturePath(), ilAuthUtils\_isExternalAccountEnabled(), ilSystemStyleSettings\_lookupActivatedStyle(), ilDatePresentation\formatDate(), ilAuthUtils\getAuthModeTranslation(), ilUserDefinedFields\getChangeableLocalUserAdministrationDefinitions(), ilUserDefinedFields\getDefinitions(), ilCtrl\getFormAction(), ilCustomUserFieldsHelper\getInstance(), ilSecuritySettingsChecker\getPasswordRequirementsInfo(), IL_CAL_UNIX, ILIAS\Repository\int(), isSettingChangeable(), ILIAS\Repository\lng(), ilLanguage\loadLanguageModule(), ILIAS\Repository\object(), ilCheckboxInputGUI\setChecked(), ilImageFileInputGUI\setImage(), ilFormPropertyGUI\setInfo(), ilSelectInputGUI\setOptions(), ilFormPropertyGUI\setRequired(), ilTextAreaInputGUI\setRows(), ilPasswordInputGUI\setUseStripSlashes(), ilCheckboxInputGUI\setValue(), ilRadioGroupInputGUI\setValue(), ilNonEditableValueGUI\setValue(), SYSTEM_ROLE_ID, SYSTEM_USER_ID, ilLanguage\txt(), ILIAS\Repository\user(), USER_FOLDER_ID, and ilUtil\yn2tf().

Referenced by createObject(), editObject(), loadUserDefinedDataFromForm(), and saveObject().

                                            : void
    {
        global $DIC;

        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];
        $ilSetting = $DIC['ilSetting'];
        $ilClientIniFile = $DIC['ilClientIniFile'];
        $ilUser = $DIC['ilUser'];

        $settings = $ilSetting->getAll();

        $this->form_gui = new ilPropertyFormGUI();
        $this->form_gui->setFormAction($ilCtrl->getFormAction($this));
        if ($a_mode == "create") {
            $this->form_gui->setTitle($lng->txt("usr_new"));
        } else {
            $this->form_gui->setTitle($lng->txt("usr_edit"));
        }

        // login data
        $sec_l = new ilFormSectionHeaderGUI();
        $sec_l->setTitle($lng->txt("login_data"));
        $this->form_gui->addItem($sec_l);

        // authentication mode
        $active_auth_modes = ilAuthUtils::_getActiveAuthModes();
        $am = new ilSelectInputGUI($lng->txt("auth_mode"), "auth_mode");
        $option = array();
        foreach ($active_auth_modes as $auth_name => $auth_key) {
            if ($auth_name == 'default') {
                $name = $this->lng->txt('auth_' . $auth_name) . " (" . $this->lng->txt('auth_' . ilAuthUtils::_getAuthModeName($auth_key)) . ")";
            } else {
                // begin-patch ldap_multiple
                #$name = $this->lng->txt('auth_'.$auth_name);
                $name = ilAuthUtils::getAuthModeTranslation($auth_key, $auth_name);
                // end-patch ldap_multiple
            }
            $option[$auth_name] = $name;
        }
        $am->setOptions($option);
        $this->form_gui->addItem($am);

        if ($a_mode == "edit") {
            $id = new ilNonEditableValueGUI($lng->txt("usr_id"), "id");
            $id->setValue($this->object->getId());
            $this->form_gui->addItem($id);
        }

        // login
        $lo = new ilUserLoginInputGUI($lng->txt("login"), "login");
        $lo->setRequired(true);
        if ($a_mode == "edit") {
            $lo->setCurrentUserId($this->object->getId());
            try {
                $last_history_entry = ilObjUser::_getLastHistoryDataByUserId($this->object->getId());
                $lo->setInfo(
                    sprintf(
                        $this->lng->txt('usr_loginname_history_info'),
                        ilDatePresentation::formatDate(new ilDateTime($last_history_entry[1], IL_CAL_UNIX)),
                        $last_history_entry[0]
                    )
                );
            } catch (ilUserException $e) {
            }
        }

        $this->form_gui->addItem($lo);

        if ($this->user->getId() === (int) SYSTEM_USER_ID
            || !in_array(SYSTEM_ROLE_ID, $this->rbac_review->assignedRoles($this->object->getId()))
            || in_array(SYSTEM_ROLE_ID, $this->rbac_review->assignedRoles($this->user->getId()))) {

            // passwords
            // @todo: do not show passwords, if there is not a single auth, that
            // allows password setting
            $pw = new ilPasswordInputGUI($lng->txt("passwd"), "passwd");
            $pw->setUseStripSlashes(false);
            $pw->setSize(32);
            $pw->setMaxLength(80); // #17221
            $pw->setValidateAuthPost("auth_mode");
            if ($a_mode == "create") {
                $pw->setRequiredOnAuth(true);
            }
            $pw->setInfo(ilSecuritySettingsChecker::getPasswordRequirementsInfo());
            $this->form_gui->addItem($pw);
            // @todo: invisible/hidden passwords
        }

        // external account
        if (ilAuthUtils::_isExternalAccountEnabled()) {
            $ext = new ilTextInputGUI($lng->txt("user_ext_account"), "ext_account");
            $ext->setSize(40);
            $ext->setMaxLength(250);
            $ext->setInfo($lng->txt("user_ext_account_desc"));
            $this->form_gui->addItem($ext);
        }

        // login data
        $sec_si = new ilFormSectionHeaderGUI();
        $sec_si->setTitle($this->lng->txt("system_information"));
        $this->form_gui->addItem($sec_si);

        // create date, approve date, agreement date, last login
        if ($a_mode == "edit") {
            $sia = array("create_date", "approve_date", "agree_date", "last_login", "owner");
            foreach ($sia as $a) {
                $siai = new ilNonEditableValueGUI($lng->txt($a), $a);
                $this->form_gui->addItem($siai);
            }
        }

        // active
        $ac = new ilCheckboxInputGUI($lng->txt("active"), "active");
        $ac->setChecked(true);
        $this->form_gui->addItem($ac);

        // access       @todo: get fields right (names change)
        $lng->loadLanguageModule('crs');

        // access
        $radg = new ilRadioGroupInputGUI($lng->txt("time_limit"), "time_limit_unlimited");
        $radg->setValue(1);
        $radg->setRequired(true);
        $op1 = new ilRadioOption($lng->txt("user_access_unlimited"), '1');
        $radg->addOption($op1);
        $op2 = new ilRadioOption($lng->txt("user_access_limited"), '0');
        $radg->addOption($op2);

        // access.from
        $acfrom = new ilDateTimeInputGUI($this->lng->txt("crs_from"), "time_limit_from");
        $acfrom->setRequired(true);
        $acfrom->setShowTime(true);
        $acfrom->setMinuteStepSize(1);
        $op2->addSubItem($acfrom);

        // access.to
        $acto = new ilDateTimeInputGUI($this->lng->txt("crs_to"), "time_limit_until");
        $acto->setRequired(true);
        $acto->setShowTime(true);
        $acto->setMinuteStepSize(1);
        $op2->addSubItem($acto);

        //              $this->form_gui->addItem($ac);
        $this->form_gui->addItem($radg);

        // personal data
        if (
            $this->isSettingChangeable('gender') or
            $this->isSettingChangeable('firstname') or
            $this->isSettingChangeable('lastname') or
            $this->isSettingChangeable('title') or
            $this->isSettingChangeable('personal_image') or
            $this->isSettingChangeable('birhtday')
        ) {
            $sec_pd = new ilFormSectionHeaderGUI();
            $sec_pd->setTitle($this->lng->txt("personal_data"));
            $this->form_gui->addItem($sec_pd);
        }

        // gender
        if ($this->isSettingChangeable('gender')) {
            $gndr = new ilRadioGroupInputGUI($lng->txt("salutation"), "gender");
            $gndr->setRequired(isset($settings["require_gender"]) && $settings["require_gender"]);
            $neutral = new ilRadioOption($lng->txt("salutation_n"), "n");
            $gndr->addOption($neutral);
            $female = new ilRadioOption($lng->txt("salutation_f"), "f");
            $gndr->addOption($female);
            $male = new ilRadioOption($lng->txt("salutation_m"), "m");
            $gndr->addOption($male);
            $this->form_gui->addItem($gndr);
        }

        // firstname, lastname, title
        $fields = [
            "firstname" => true,
            "lastname" => true,
            "title" => isset($settings["require_title"]) && $settings["require_title"]
        ];
        foreach ($fields as $field => $req) {
            $max_len = $field === 'title' ? 32 : 128;
            if ($this->isSettingChangeable($field)) {
                // #18795
                $caption = ($field == "title")
                    ? "person_title"
                    : $field;
                $inp = new ilTextInputGUI($lng->txt($caption), $field);
                $inp->setSize(32);
                $inp->setMaxLength($max_len);
                $inp->setRequired($req);
                $this->form_gui->addItem($inp);
            }
        }

        // personal image
        if ($this->isSettingChangeable('upload')) {
            $pi = new ilImageFileInputGUI($lng->txt("personal_picture"), "userfile");
            if ($a_mode == "edit" || $a_mode == "upload") {
                $pi->setImage(ilObjUser::_getPersonalPicturePath(
                    $this->object->getId(),
                    "small",
                    true,
                    true
                ));
            }
            $this->form_gui->addItem($pi);
        }

        if ($this->isSettingChangeable('birthday')) {
            $birthday = new ilBirthdayInputGUI($lng->txt('birthday'), 'birthday');
            $birthday->setRequired(isset($settings["require_birthday"]) && $settings["require_birthday"]);
            $this->form_gui->addItem($birthday);
        }

        // institution, department, street, city, zip code, country, phone office
        // phone home, phone mobile, fax, e-mail
        $fields = array(
            array("institution", 40, 80),
            array("department", 40, 80),
            array("street", 40, 40),
            array("city", 40, 40),
            array("zipcode", 10, 10),
            array("country", 40, 40),
            array("sel_country"),
            array("phone_office", 30, 30),
            array("phone_home", 30, 30),
            array("phone_mobile", 30, 30),
            array("fax", 30, 30)
        );

        $counter = 0;
        foreach ($fields as $field) {
            if (!$counter++ and $this->isSettingChangeable($field[0])) {
                // contact data
                $sec_cd = new ilFormSectionHeaderGUI();
                $sec_cd->setTitle($this->lng->txt("contact_data"));
                $this->form_gui->addItem($sec_cd);

                // org units
                if ($a_mode == "edit") {
                    $orgus = new ilNonEditableValueGUI($lng->txt('objs_orgu'), 'org_units');
                    $orgus->setValue($this->object->getOrgUnitsRepresentation());
                    $this->form_gui->addItem($orgus);
                }
            }
            if ($this->isSettingChangeable($field[0])) {
                if ($field[0] != "sel_country") {
                    $inp = new ilTextInputGUI($lng->txt($field[0]), $field[0]);
                    $inp->setSize($field[1]);
                    $inp->setMaxLength($field[2]);
                    $inp->setRequired(isset($settings["require_" . $field[0]]) &&
                        $settings["require_" . $field[0]]);
                    $this->form_gui->addItem($inp);
                } else {
                    // country selection
                    $cs = new ilCountrySelectInputGUI($lng->txt($field[0]), $field[0]);
                    $cs->setRequired(isset($settings["require_" . $field[0]]) &&
                        $settings["require_" . $field[0]]);
                    $this->form_gui->addItem($cs);
                }
            }
        }

        // email
        if ($this->isSettingChangeable('email')) {
            $em = new ilEMailInputGUI($lng->txt("email"), "email");
            $em->setRequired(isset($settings["require_email"]) &&
                $settings["require_email"]);
            $em->setMaxLength(128);
            $this->form_gui->addItem($em);
        }

        // second email
        if ($this->isSettingChangeable('second_email')) {
            $em = new ilEMailInputGUI($lng->txt("second_email"), "second_email");

            $this->form_gui->addItem($em);
        }

        // interests/hobbies
        if ($this->isSettingChangeable('hobby')) {
            $hob = new ilTextAreaInputGUI($lng->txt("hobby"), "hobby");
            $hob->setRows(3);
            $hob->setCols(40);
            $hob->setRequired(isset($settings["require_hobby"]) &&
                $settings["require_hobby"]);
            $this->form_gui->addItem($hob);
        }

        // referral comment
        if ($this->isSettingChangeable('referral_comment')) {
            $rc = new ilTextAreaInputGUI($lng->txt("referral_comment"), "referral_comment");
            $rc->setRows(3);
            $rc->setCols(40);
            $rc->setRequired(isset($settings["require_referral_comment"]) &&
                $settings["require_referral_comment"]);
            $this->form_gui->addItem($rc);
        }

        // interests

        $sh = new ilFormSectionHeaderGUI();
        $sh->setTitle($lng->txt("interests"));
        $this->form_gui->addItem($sh);

        $multi_fields = array("interests_general", "interests_help_offered", "interests_help_looking");
        foreach ($multi_fields as $multi_field) {
            if ($this->isSettingChangeable($multi_field)) {
                // see ilUserProfile
                $ti = new ilTextInputGUI($lng->txt($multi_field), $multi_field);
                $ti->setMulti(true);
                $ti->setMaxLength(40);
                $ti->setSize(40);
                $ti->setRequired(isset($settings["require_" . $multi_field]) &&
                    $settings["require_" . $multi_field]);
                $this->form_gui->addItem($ti);
            }
        }

        // other information
        if ($this->isSettingChangeable('user_profile_other')) {
            $sec_oi = new ilFormSectionHeaderGUI();
            $sec_oi->setTitle($this->lng->txt("user_profile_other"));
            $this->form_gui->addItem($sec_oi);
        }

        // matriculation number
        if ($this->isSettingChangeable('matriculation')) {
            $mr = new ilTextInputGUI($lng->txt("matriculation"), "matriculation");
            $mr->setSize(40);
            $mr->setMaxLength(40);
            $mr->setRequired(isset($settings["require_matriculation"]) &&
                $settings["require_matriculation"]);
            $this->form_gui->addItem($mr);
        }

        // client IP
        $ip = new ilTextInputGUI($lng->txt("client_ip"), "client_ip");
        $ip->setSize(40);
        $ip->setMaxLength(255);
        $ip->setInfo($this->lng->txt("current_ip") . " " . $_SERVER["REMOTE_ADDR"] . " <br />" .
            '<span class="warning">' . $this->lng->txt("current_ip_alert") . "</span>");
        $this->form_gui->addItem($ip);

        // additional user defined fields
        $user_defined_fields = ilUserDefinedFields::_getInstance();

        if ($this->usrf_ref_id == USER_FOLDER_ID) {
            $all_defs = $user_defined_fields->getDefinitions();
        } else {
            $all_defs = $user_defined_fields->getChangeableLocalUserAdministrationDefinitions();
        }

        foreach ($all_defs as $definition) {
            $f_property = ilCustomUserFieldsHelper::getInstance()->getFormPropertyForDefinition($definition, true);
            if ($f_property instanceof ilFormPropertyGUI) {
                $this->form_gui->addItem($f_property);
            }
        }

        // settings
        if (
            $a_mode == 'create' or
            $this->isSettingChangeable('language') or
            $this->isSettingChangeable('skin_style') or
            $this->isSettingChangeable('hits_per_page') or
            $this->isSettingChangeable('hide_own_online_status') or
            $this->isSettingChangeable('bs_allow_to_contact_me') or
            $this->isSettingChangeable('chat_osc_accept_msg') or
            $this->isSettingChangeable('chat_broadcast_typing')
        ) {
            $sec_st = new ilFormSectionHeaderGUI();
            $sec_st->setTitle($this->lng->txt("settings"));
            $this->form_gui->addItem($sec_st);
        }

        // role
        if ($a_mode == "create") {
            $role = new ilSelectInputGUI(
                $lng->txt("default_role"),
                'default_role'
            );
            $role->setRequired(true);
            $role->setValue($this->default_role);
            $role->setOptions($this->selectable_roles);
            $this->form_gui->addItem($role);
        }

        // language
        if ($this->isSettingChangeable('language')) {
            $languages = $this->lng->getInstalledLanguages();
            $this->lng->loadLanguageModule('meta');
            $options = [];
            foreach ($languages as $l) {
                $options[$l] = $lng->txt("meta_l_" . $l);
            }
            $lang = new ilSelectInputGUI(
                $this->lng->txt('language'),
                'language'
            );
            $lang->setOptions($options);
            $lang->setValue($ilSetting->get("language"));
            if (count($options) <= 1) {
                $lang->setDisabled(true);
            }
            $this->form_gui->addItem($lang);
        }

        // skin/style
        if ($this->isSettingChangeable('skin_style')) {
            $sk = new ilSelectInputGUI(
                $lng->txt("skin_style"),
                'skin_style'
            );

            $skins = ilStyleDefinition::getAllSkins();

            $options = array();
            if (is_array($skins)) {
                $sk = new ilSelectInputGUI($this->lng->txt("skin_style"), "skin_style");

                $options = array();
                foreach ($skins as $skin) {
                    foreach ($skin->getStyles() as $style) {
                        if (!ilSystemStyleSettings::_lookupActivatedStyle($skin->getId(), $style->getId())) {
                            continue;
                        }

                        $options[$skin->getId() . ":" . $style->getId()] = $skin->getName() . " / " . $style->getName();
                    }
                }
            }
            $sk->setOptions($options);
            $sk->setValue($ilClientIniFile->readVariable("layout", "skin") .
                ":" . $ilClientIniFile->readVariable("layout", "style"));

            $this->form_gui->addItem($sk);
        }

        // hits per page
        if ($this->isSettingChangeable('hits_per_page')) {
            $hpp = new ilSelectInputGUI(
                $lng->txt("hits_per_page"),
                'hits_per_page'
            );
            $options = array(10 => 10,
                             15 => 15,
                             20 => 20,
                             30 => 30,
                             40 => 40,
                             50 => 50,
                             100 => 100,
                             9999 => $this->lng->txt("no_limit")
            );
            $hpp->setOptions($options);
            $hpp->setValue($ilSetting->get("hits_per_page"));
            $this->form_gui->addItem($hpp);
        }

        // hide online status
        if ($this->isSettingChangeable('hide_own_online_status')) {
            $lng->loadLanguageModule("awrn");

            $default = ($ilSetting->get('hide_own_online_status') == "n")
                ? $this->lng->txt("user_awrn_show")
                : $this->lng->txt("user_awrn_hide");

            $options = array(
                "" => $this->lng->txt("user_awrn_default") . " (" . $default . ")",
                "n" => $this->lng->txt("user_awrn_show"),
                "y" => $this->lng->txt("user_awrn_hide")
            );
            $os = new ilSelectInputGUI($lng->txt("awrn_user_show"), "hide_own_online_status");
            $os->setOptions($options);
            $os->setDisabled((bool) $ilSetting->get("usr_settings_disable_hide_own_online_status"));
            $os->setInfo($lng->txt("awrn_hide_from_awareness_info"));
            $this->form_gui->addItem($os);

            //$os = new ilCheckboxInputGUI($lng->txt("awrn_hide_from_awareness"), "hide_own_online_status");
            //$this->form_gui->addItem($os);
        }

        // allow to contact me
        if ($this->isSettingChangeable('bs_allow_to_contact_me')) {
            $lng->loadLanguageModule('buddysystem');
            $os = new ilCheckboxInputGUI($lng->txt('buddy_allow_to_contact_me'), 'bs_allow_to_contact_me');
            if ($a_mode == 'create') {
                $os->setChecked(ilUtil::yn2tf($ilSetting->get('bs_allow_to_contact_me', 'n')));
            }
            $this->form_gui->addItem($os);
        }
        if ($this->isSettingChangeable('chat_osc_accept_msg')) {
            $lng->loadLanguageModule('chatroom');
            $chat_osc_acm = new ilCheckboxInputGUI($lng->txt('chat_osc_accept_msg'), 'chat_osc_accept_msg');
            if ($a_mode == 'create') {
                $chat_osc_acm->setChecked(ilUtil::yn2tf($ilSetting->get('chat_osc_accept_msg', 'n')));
            }
            $this->form_gui->addItem($chat_osc_acm);
        }

        if ((int) $ilSetting->get('session_reminder_enabled')) {
            $cb = new ilCheckboxInputGUI($this->lng->txt('session_reminder'), 'session_reminder_enabled');
            $cb->setValue(1);
            $this->form_gui->addItem($cb);
        }

        // Options
        if ($this->isSettingChangeable('send_mail')) {
            $sec_op = new ilFormSectionHeaderGUI();
            $sec_op->setTitle($this->lng->txt("options"));
            $this->form_gui->addItem($sec_op);
        }

        // send email
        $se = new ilCheckboxInputGUI($lng->txt('inform_user_mail'), 'send_mail');
        $se->setInfo($lng->txt('inform_user_mail_info'));
        $se->setValue('y');
        $se->setChecked(($ilUser->getPref('send_info_mails') == 'y'));
        $this->form_gui->addItem($se);

        // ignore required fields
        $irf = new ilCheckboxInputGUI($lng->txt('ignore_required_fields'), 'ignore_rf');
        $irf->setInfo($lng->txt('ignore_required_fields_info'));
        $irf->setValue(1);
        $this->form_gui->addItem($irf);

        // @todo: handle all required fields

        // command buttons
        if ($a_mode == "create" || $a_mode == "save") {
            $this->form_gui->addCommandButton("save", $lng->txt("save"));
        }
        if ($a_mode == "edit" || $a_mode == "update") {
            $this->form_gui->addCommandButton("update", $lng->txt("save"));
        }
        $this->form_gui->addCommandButton("cancel", $lng->txt("cancel"));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isSettingChangeable()

ilObjUserGUI::isSettingChangeable ( string  $a_field )

protected

Definition at line 1537 of file class.ilObjUserGUI.php.

References $DIC, $ilSetting, ilObjectGUI\$settings, and USER_FOLDER_ID.

Referenced by initForm(), loadUserDefinedDataFromForm(), loadValuesFromForm(), and saveObject().

                                                           : bool
    {
        global $DIC;

        $ilSetting = $DIC['ilSetting'];
        static $settings = null;

        if ($this->usrf_ref_id == USER_FOLDER_ID) {
            return true;
        }

        if ($settings == null) {
            $settings = $ilSetting->getAll();
        }
        return (bool) ($settings['usr_settings_changeable_lua_' . $a_field] ?? false);
    }

Here is the caller graph for this function:

loadUserDefinedDataFromForm()

ilObjUserGUI::loadUserDefinedDataFromForm ( ?ilObjUser  $user = null )

protected

Definition at line 727 of file class.ilObjUserGUI.php.

References $DIC, Vendor\Package\$e, Vendor\Package\$f, $ilSetting, ilObjectGUI\$object, ilObjectGUI\$user, ilAuthUtils\_allowPasswordModificationByAuthMode(), ilAuthUtils\_getAuthMode(), ilUserDefinedFields\_getInstance(), checkUserWriteRight(), ILIAS\Repository\ctrl(), ilUserDefinedFields\getChangeableLocalUserAdministrationDefinitions(), ilUserDefinedFields\getDefinitions(), handleIgnoredRequiredFields(), initForm(), ILIAS\Repository\int(), ilUserProfile\isProfileIncomplete(), isSettingChangeable(), ILIAS\Repository\lng(), loadValuesFromForm(), ILIAS\Repository\object(), ilObjUser\PASSWD_PLAIN, ilObjUser\setUserDefinedData(), SYSTEM_ROLE_ID, SYSTEM_USER_ID, ilObject\update(), ilObjectGUI\updateObject(), uploadUserPictureObject(), ILIAS\Repository\user(), and USER_FOLDER_ID.

Referenced by saveObject().

                                                                           : void
    {
        if (!$user) {
            $user = $this->object;
        }

        $user_defined_fields = ilUserDefinedFields::_getInstance();
        if ($this->usrf_ref_id == USER_FOLDER_ID) {
            $all_defs = $user_defined_fields->getDefinitions();
        } else {
            $all_defs = $user_defined_fields->getChangeableLocalUserAdministrationDefinitions();
        }
        $udf = [];
        foreach ($all_defs as $definition) {
            $f = "udf_" . $definition['field_id'];
            $item = $this->form_gui->getItemByPostVar($f);
            if ($item && !$item->getDisabled()) {
                $udf[$definition['field_id']] = $this->form_gui->getInput($f);
            }
        }
        $user->setUserDefinedData($udf);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

loadValuesFromForm()

ilObjUserGUI::loadValuesFromForm ( string  $a_mode = 'create' )

protected

Definition at line 558 of file class.ilObjUserGUI.php.

References $DIC, $ilUser, ilObjectGUI\$object, ilObjectGUI\$user, ilObjUser\getActive(), IL_CAL_DATE, IL_CAL_UNIX, ILIAS\Repository\int(), isSettingChangeable(), ilObjUser\setActive(), ilObjUser\setAuthMode(), ilObjUser\setBirthday(), ilObjUser\setCity(), ilObjUser\setClientIP(), ilObjUser\setComment(), ilObjUser\setCountry(), ilObjUser\setDepartment(), ilObjUser\setEmail(), ilObjUser\setExternalAccount(), ilObjUser\setFax(), ilObjUser\setFirstname(), ilObjUser\setFullname(), ilObjUser\setGender(), ilObjUser\setGeneralInterests(), ilObjUser\setHobby(), ilObjUser\setInstitution(), ilObjUser\setLastname(), ilObjUser\setLatitude(), ilObjUser\setLocationZoom(), ilObjUser\setLogin(), ilObjUser\setLongitude(), ilObjUser\setLookingForHelp(), ilObjUser\setMatriculation(), ilObjUser\setOfferingHelp(), ilObjUser\setPhoneHome(), ilObjUser\setPhoneMobile(), ilObjUser\setPhoneOffice(), ilObjUser\setSecondEmail(), ilObjUser\setSelectedCountry(), ilObjUser\setStreet(), ilObjUser\setTimeLimitFrom(), ilObjUser\setTimeLimitOwner(), ilObjUser\setTimeLimitUnlimited(), ilObjUser\setTimeLimitUntil(), ilObjUser\setUTitle(), and ilObjUser\setZipcode().

Referenced by loadUserDefinedDataFromForm(), and saveObject().

                                                                    : ilObjUser
    {
        global $DIC;

        $user = null;
        $ilUser = $DIC['ilUser'];

        switch ($a_mode) {
            case 'create':
                $user = new ilObjUser();
                break;

            case 'update':
                $user = $this->object;
                break;
        }

        $from = $this->form_gui->getItemByPostVar('time_limit_from')->getDate();
        $user->setTimeLimitFrom($from
            ? $from->get(IL_CAL_UNIX)
            : null);

        $until = $this->form_gui->getItemByPostVar('time_limit_until')->getDate();
        $user->setTimeLimitUntil($until
            ? $until->get(IL_CAL_UNIX)
            : null);

        $user->setTimeLimitUnlimited($this->form_gui->getInput('time_limit_unlimited'));

        if ($a_mode == 'create') {
            $user->setTimeLimitOwner($this->usrf_ref_id);
        }

        // Birthday
        if ($this->isSettingChangeable('birthday')) {
            $bd = $this->form_gui->getItemByPostVar('birthday');
            $bd = $bd->getDate();
            $user->setBirthday($bd
                ? $bd->get(IL_CAL_DATE)
                : null);
        }

        // Login
        $user->setLogin($this->form_gui->getInput('login'));

        // Gender
        if ($this->isSettingChangeable('gender')) {
            $user->setGender($this->form_gui->getInput('gender'));
        }

        // Title
        if ($this->isSettingChangeable('title')) {
            $user->setUTitle($this->form_gui->getInput('title'));
        }

        // Firstname
        if ($this->isSettingChangeable('firstname')) {
            $user->setFirstname($this->form_gui->getInput('firstname'));
        }
        // Lastname
        if ($this->isSettingChangeable('lastname')) {
            $user->setLastname($this->form_gui->getInput('lastname'));
        }
        $user->setFullname();

        // Institution
        if ($this->isSettingChangeable('institution')) {
            $user->setInstitution($this->form_gui->getInput('institution'));
        }

        // Department
        if ($this->isSettingChangeable('department')) {
            $user->setDepartment($this->form_gui->getInput('department'));
        }
        // Street
        if ($this->isSettingChangeable('street')) {
            $user->setStreet($this->form_gui->getInput('street'));
        }
        // City
        if ($this->isSettingChangeable('city')) {
            $user->setCity($this->form_gui->getInput('city'));
        }
        // Zipcode
        if ($this->isSettingChangeable('zipcode')) {
            $user->setZipcode($this->form_gui->getInput('zipcode'));
        }
        // Country
        if ($this->isSettingChangeable('country')) {
            $user->setCountry($this->form_gui->getInput('country'));
        }
        // Selected Country
        if ($this->isSettingChangeable('sel_country')) {
            $user->setSelectedCountry($this->form_gui->getInput('sel_country'));
        }
        // Phone Office
        if ($this->isSettingChangeable('phone_office')) {
            $user->setPhoneOffice($this->form_gui->getInput('phone_office'));
        }
        // Phone Home
        if ($this->isSettingChangeable('phone_home')) {
            $user->setPhoneHome($this->form_gui->getInput('phone_home'));
        }
        // Phone Mobile
        if ($this->isSettingChangeable('phone_mobile')) {
            $user->setPhoneMobile($this->form_gui->getInput('phone_mobile'));
        }
        // Fax
        if ($this->isSettingChangeable('fax')) {
            $user->setFax($this->form_gui->getInput('fax'));
        }
        // Matriculation
        if ($this->isSettingChangeable('matriculation')) {
            $user->setMatriculation($this->form_gui->getInput('matriculation'));
        }
        // Email
        if ($this->isSettingChangeable('email')) {
            $user->setEmail($this->form_gui->getInput('email'));
        }
        // Second Email
        if ($this->isSettingChangeable('second_email')) {
            $user->setSecondEmail($this->form_gui->getInput('second_email'));
        }
        // Hobby
        if ($this->isSettingChangeable('hobby')) {
            $user->setHobby($this->form_gui->getInput('hobby'));
        }
        // Referral Comment
        if ($this->isSettingChangeable('referral_comment')) {
            $user->setComment($this->form_gui->getInput('referral_comment'));
        }

        $general_interests = is_array($this->form_gui->getInput('interests_general'))
            ? $this->form_gui->getInput('interests_general')
            : [];
        $user->setGeneralInterests($general_interests);

        $offering_help = is_array($this->form_gui->getInput('interests_help_offered'))
            ? $this->form_gui->getInput('interests_help_offered')
            : [];
        $user->setOfferingHelp($offering_help);

        $looking_for_help = is_array($this->form_gui->getInput('interests_help_looking'))
            ? $this->form_gui->getInput('interests_help_looking')
            : [];
        $user->setLookingForHelp($looking_for_help);

        // ClientIP
        $user->setClientIP($this->form_gui->getInput('client_ip'));

        // Google maps
        $user->setLatitude($this->form_gui->getInput('latitude'));
        $user->setLongitude($this->form_gui->getInput('longitude'));
        $zoom = (int) $this->form_gui->getInput('loc_zoom');
        if ($zoom == 0) {
            $zoom = null;
        }
        $user->setLocationZoom($zoom);

        // External account
        $user->setAuthMode($this->form_gui->getInput('auth_mode'));
        $user->setExternalAccount($this->form_gui->getInput('ext_account'));

        if ((int) $user->getActive() != (int) $this->form_gui->getInput('active')) {
            $user->setActive($this->form_gui->getInput('active'), $ilUser->getId());
        }

        return $user;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

removeUserPictureObject()

ilObjUserGUI::removeUserPictureObject

(

)

remove user image

Definition at line 1648 of file class.ilObjUserGUI.php.

References editObject(), ilFileUtils\getWebspaceDir(), and ILIAS\Repository\lng().

                                             : void
    {
        $webspace_dir = ilFileUtils::getWebspaceDir();
        $image_dir = $webspace_dir . "/usr_images";
        $file = $image_dir . "/usr_" . $this->object->getId() . "." . "jpg";
        $thumb_file = $image_dir . "/usr_" . $this->object->getId() . "_small.jpg";
        $xthumb_file = $image_dir . "/usr_" . $this->object->getId() . "_xsmall.jpg";
        $xxthumb_file = $image_dir . "/usr_" . $this->object->getId() . "_xxsmall.jpg";
        $upload_file = $image_dir . "/upload_" . $this->object->getId();

        // remove user pref file name
        $this->object->setPref("profile_image", "");
        $this->object->update();
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("user_image_removed"));

        if (is_file($file)) {
            unlink($file);
        }
        if (is_file($thumb_file)) {
            unlink($thumb_file);
        }
        if (is_file($xthumb_file)) {
            unlink($xthumb_file);
        }
        if (is_file($xxthumb_file)) {
            unlink($xxthumb_file);
        }
        if (is_file($upload_file)) {
            unlink($upload_file);
        }

        $this->editObject();
    }

Here is the call graph for this function:

resetFilterObject()

ilObjUserGUI::resetFilterObject

(

)

Reset filter.

Definition at line 1820 of file class.ilObjUserGUI.php.

References roleassignmentObject().

                                       : void
    {
        $table_gui = new ilRoleAssignmentTableGUI($this, "roleassignment");
        $table_gui->resetOffset();                // sets record offest to 0 (first page)
        $table_gui->resetFilter();                // clears filter
        $this->roleassignmentObject();
    }

Here is the call graph for this function:

roleassignmentObject()

ilObjUserGUI::roleassignmentObject

(

)

display role assignment panel

Definition at line 1765 of file class.ilObjUserGUI.php.

References ilObjectGUI\$access, $DIC, ANONYMOUS_USER_ID, ilSession\get(), ILIAS\Repository\int(), ilOrgUnitPositionAccessHandler\isCurrentUserBasedOnPositionsAllowedTo(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilSession\set().

Referenced by applyFilterObject(), and resetFilterObject().

                                          : void
    {
        global $DIC;

        $rbacsystem = $DIC['rbacsystem'];
        $ilTabs = $DIC['ilTabs'];
        $access = $DIC->access();

        $ilTabs->activateTab("role_assignment");

        if ($this->object->getId() === (int) ANONYMOUS_USER_ID
            || !$rbacsystem->checkAccess("edit_roleassignment", $this->usrf_ref_id)
                && !$access->isCurrentUserBasedOnPositionsAllowedTo("read_users", array($this->object->getId()))
        ) {
            $this->ilias->raiseError(
                $this->lng->txt("msg_no_perm_assign_role_to_user"),
                $this->ilias->error_obj->MESSAGE
            );
        }

        $filtered_roles = ilSession::get("filtered_roles");
        $req_filtered_roles = $this->user_request->getFilteredRoles();
        ilSession::set(
            "filtered_roles",
            ($req_filtered_roles > 0) ? $req_filtered_roles : $filtered_roles
        );

        $filtered_roles = ilSession::get("filtered_roles");
        if ($filtered_roles > 5) {
            ilSession::set("filtered_roles", 0);
        }

        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.usr_role_assignment.html', 'Services/User');

        // init table
        $tab = new ilRoleAssignmentTableGUI($this, "roleassignment");

        $tab->parse($this->object->getId());
        $this->tpl->setVariable("ROLES_TABLE", $tab->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveObject()

ilObjUserGUI::saveObject

(

)

save user data

Definition at line 378 of file class.ilObjUserGUI.php.

References $DIC, $ilSetting, $ilUser, ilObjectGUI\$tpl, ilAuthUtils\_isExternalAccountEnabled(), ILIAS\Repository\ctrl(), handleIgnoredRequiredFields(), initCreate(), initForm(), ILIAS\Repository\int(), ilUserProfile\isProfileIncomplete(), isSettingChangeable(), ILIAS\Repository\lng(), loadUserDefinedDataFromForm(), loadValuesFromForm(), ilObjUser\PASSWD_PLAIN, ilGlobalTemplateInterface\setContent(), SYSTEM_ROLE_ID, SYSTEM_USER_ID, uploadUserPictureObject(), and ILIAS\Repository\user().

                                : void
    {
        global $DIC;

        $ilAccess = $DIC['ilAccess'];
        $ilSetting = $DIC['ilSetting'];
        $tpl = $DIC['tpl'];
        $ilUser = $DIC['ilUser'];
        $rbacadmin = $DIC['rbacadmin'];
        $rbacsystem = $DIC['rbacsystem'];

        // User folder
        if (!$rbacsystem->checkAccess('create_usr', $this->usrf_ref_id)
            && !$ilAccess->checkAccess('cat_administrate_users', "", $this->usrf_ref_id)) {
            $this->ilias->raiseError($this->lng->txt("permission_denied"), $this->ilias->error_obj->MESSAGE);
        }

        $this->initCreate();
        $this->initForm("create");

        // Manipulate form so ignore required fields are no more required. This has to be done before ilPropertyFormGUI::checkInput() is called.
        $profileMaybeIncomplete = false;
        if ($this->form_gui->getInput('ignore_rf', false)) {
            $profileMaybeIncomplete = $this->handleIgnoredRequiredFields();
        }

        if ($this->form_gui->checkInput()) {
            // @todo: external account; time limit check and savings

            // checks passed. save user
            $userObj = $this->loadValuesFromForm();
            if ($this->user->getId() === (int) SYSTEM_USER_ID
                || !in_array(SYSTEM_ROLE_ID, $this->rbac_review->assignedRoles($this->object->getId()))
                || in_array(SYSTEM_ROLE_ID, $this->rbac_review->assignedRoles($this->user->getId()))) {
                $userObj->setPasswd($this->form_gui->getInput('passwd'), ilObjUser::PASSWD_PLAIN);
            }
            $userObj->setTitle($userObj->getFullname());
            $userObj->setDescription($userObj->getEmail());

            $this->loadUserDefinedDataFromForm($userObj);

            $userObj->create();

            if (ilAuthUtils::_isExternalAccountEnabled()) {
                $userObj->setExternalAccount($this->form_gui->getInput("ext_account"));
            }

            // set a timestamp for last_password_change
            // this ts is needed by ilSecuritySettings
            $userObj->setLastPasswordChangeTS(time());

            //insert user data in table user_data
            $userObj->saveAsNew();

            // setup user preferences
            if ($this->isSettingChangeable('language')) {
                $userObj->setLanguage($this->form_gui->getInput("language"));
            }

            if ($this->isSettingChangeable('skin_style')) {
                //set user skin and style
                $sknst = explode(":", $this->form_gui->getInput("skin_style"));

                if ($userObj->getPref("style") != $sknst[1] ||
                    $userObj->getPref("skin") != $sknst[0]) {
                    $userObj->setPref("skin", $sknst[0]);
                    $userObj->setPref("style", $sknst[1]);
                }
            }
            if ($this->isSettingChangeable('hits_per_page')) {
                $userObj->setPref("hits_per_page", $this->form_gui->getInput("hits_per_page"));
            }
            if ($this->isSettingChangeable('hide_own_online_status')) {
                $userObj->setPref(
                    "hide_own_online_status",
                    $this->form_gui->getInput("hide_own_online_status")
                );
            }
            if ($this->isSettingChangeable('bs_allow_to_contact_me')) {
                $userObj->setPref(
                    'bs_allow_to_contact_me',
                    $this->form_gui->getInput("bs_allow_to_contact_me") ? 'y' : 'n'
                );
            }
            if ($this->isSettingChangeable('chat_osc_accept_msg')) {
                $userObj->setPref(
                    'chat_osc_accept_msg',
                    $this->form_gui->getInput("chat_osc_accept_msg") ? 'y' : 'n'
                );
            }
            if ($this->isSettingChangeable('chat_broadcast_typing')) {
                $userObj->setPref(
                    'chat_broadcast_typing',
                    $this->form_gui->getInput("chat_broadcast_typing") ? 'y' : 'n'
                );
            }
            if ((int) $ilSetting->get('session_reminder_enabled')) {
                $userObj->setPref(
                    'session_reminder_enabled',
                    (int) $this->form_gui->getInput("session_reminder_enabled")
                );
            }
            $userObj->writePrefs();

            //set role entries
            $rbacadmin->assignUser(
                $this->form_gui->getInput("default_role"),
                $userObj->getId(),
                true
            );

            $msg = $this->lng->txt("user_added");

            $ilUser->setPref(
                'send_info_mails',
                ($this->form_gui->getInput("send_mail") == 'y') ? 'y' : 'n'
            );
            $ilUser->writePrefs();

            $this->object = $userObj;

            if ($this->isSettingChangeable('upload')) {
                $this->uploadUserPictureObject();
            }

            if ($profileMaybeIncomplete) {
                if (ilUserProfile::isProfileIncomplete($this->object)) {
                    $this->object->setProfileIncomplete(true);
                    $this->object->update();
                }
            }

            // send new account mail
            if ($this->form_gui->getInput("send_mail") == 'y') {
                $acc_mail = new ilAccountMail();
                $acc_mail->useLangVariablesAsFallback(true);
                $acc_mail->setAttachConfiguredFiles(true);
                $acc_mail->setUserPassword($this->form_gui->getInput("passwd"));
                $acc_mail->setUser($userObj);

                if ($acc_mail->send()) {
                    $msg .= '<br />' . $this->lng->txt('mail_sent');
                    $this->tpl->setOnScreenMessage('success', $msg, true);
                } else {
                    $msg .= '<br />' . $this->lng->txt('mail_not_sent');
                    $this->tpl->setOnScreenMessage('info', $msg, true);
                }
            } else {
                $this->tpl->setOnScreenMessage('success', $msg, true);
            }

            if (strtolower($this->requested_baseClass) == 'iladministrationgui') {
                $this->ctrl->redirectByClass("ilobjuserfoldergui", "view");
            } else {
                $this->ctrl->redirectByClass('ilobjcategorygui', 'listUsers');
            }
        } else {
            $this->form_gui->setValuesByPost();
            $tpl->setContent($this->form_gui->getHTML());
        }
    }

Here is the call graph for this function:

setBackTarget()

ilObjUserGUI::setBackTarget	(	string	$a_text,
		string	$a_link
	)

set back tab target

Definition at line 224 of file class.ilObjUserGUI.php.

     : void {
        $this->back_target = array("text" => $a_text,
                                   "link" => $a_link
        );
    }

setTitleAndDescription()

ilObjUserGUI::setTitleAndDescription ( )

protected

Definition at line 130 of file class.ilObjUserGUI.php.

References ilUtil\getImagePath(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

                                               : void
    {
        if (strtolower(get_class($this->object)) == 'ilobjuser') {
            $this->tpl->setTitle('[' . $this->object->getLogin() . '] ' . $this->object->getTitle());
            $this->tpl->setDescription($this->object->getLongDescription());
            $this->tpl->setTitleIcon(
                ilUtil::getImagePath("icon_" . $this->object->getType() . ".svg"),
                $this->lng->txt("obj_" . $this->object->getType())
            );
        } else {
            parent::setTitleAndDescription();
        }
    }

Here is the call graph for this function:

uploadUserPictureObject()

ilObjUserGUI::uploadUserPictureObject

(

)

upload user image (original method by ratana ty)

Definition at line 1558 of file class.ilObjUserGUI.php.

References $DIC, ILIAS\Repository\ctrl(), ilShellUtil\escapeShellArg(), ilShellUtil\execConvert(), ilFileUtils\getWebspaceDir(), ilShellUtil\isConvertVersionAtLeast(), ILIAS\Repository\lng(), ilFileUtils\moveUploadedFile(), and USER_FOLDER_ID.

Referenced by loadUserDefinedDataFromForm(), and saveObject().

                                             : void
    {
        global $DIC;

        $rbacsystem = $DIC['rbacsystem'];

        // User folder
        if ($this->usrf_ref_id == USER_FOLDER_ID and
            !$rbacsystem->checkAccess('visible,read', $this->usrf_ref_id)) {
            $this->ilias->raiseError($this->lng->txt("msg_no_perm_modify_user"), $this->ilias->error_obj->MESSAGE);
        }
        // if called from local administration $this->usrf_ref_id is category id
        // Todo: this has to be fixed. Do not mix user folder id and category id
        if ($this->usrf_ref_id != USER_FOLDER_ID) {
            // check if user is assigned to category
            if (!$rbacsystem->checkAccess('cat_administrate_users', $this->object->getTimeLimitOwner())) {
                $this->ilias->raiseError($this->lng->txt("msg_no_perm_modify_user"), $this->ilias->error_obj->MESSAGE);
            }
        }

        $userfile_input = $this->form_gui->getItemByPostVar("userfile");

        if ($_FILES["userfile"]["tmp_name"] == "") {
            if ($userfile_input->getDeletionFlag()) {
                $this->object->removeUserPicture();
            }
            return;
        }
        if ($_FILES["userfile"]["size"] == 0) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("msg_no_file"));
        } else {
            $webspace_dir = ilFileUtils::getWebspaceDir();
            $image_dir = $webspace_dir . "/usr_images";
            $store_file = "usr_" . $this->object->getId() . "." . "jpg";

            // store filename
            $this->object->setPref("profile_image", $store_file);
            $this->object->update();

            // move uploaded file
            $pi = pathinfo($_FILES["userfile"]["name"]);
            $uploaded_file = $image_dir . "/upload_" . $this->object->getId() . "." . $pi["extension"];
            if (!ilFileUtils::moveUploadedFile(
                $_FILES["userfile"]["tmp_name"],
                $_FILES["userfile"]["name"],
                $uploaded_file,
                false
            )) {
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt("upload_error", true));
                $this->ctrl->redirect($this, "showProfile");
            }
            chmod($uploaded_file, 0770);

            // take quality 100 to avoid jpeg artefacts when uploading jpeg files
            // taking only frame [0] to avoid problems with animated gifs
            $show_file = "$image_dir/usr_" . $this->object->getId() . ".jpg";
            $thumb_file = "$image_dir/usr_" . $this->object->getId() . "_small.jpg";
            $xthumb_file = "$image_dir/usr_" . $this->object->getId() . "_xsmall.jpg";
            $xxthumb_file = "$image_dir/usr_" . $this->object->getId() . "_xxsmall.jpg";
            $uploaded_file = ilShellUtil::escapeShellArg($uploaded_file);
            $show_file = ilShellUtil::escapeShellArg($show_file);
            $thumb_file = ilShellUtil::escapeShellArg($thumb_file);
            $xthumb_file = ilShellUtil::escapeShellArg($xthumb_file);
            $xxthumb_file = ilShellUtil::escapeShellArg($xxthumb_file);

            if (ilShellUtil::isConvertVersionAtLeast("6.3.8-3")) {
                ilShellUtil::execConvert(
                    $uploaded_file . "[0] -geometry 200x200^ -gravity center -extent 200x200 -quality 100 JPEG:" . $show_file
                );
                ilShellUtil::execConvert(
                    $uploaded_file . "[0] -geometry 100x100^ -gravity center -extent 100x100 -quality 100 JPEG:" . $thumb_file
                );
                ilShellUtil::execConvert(
                    $uploaded_file . "[0] -geometry 75x75^ -gravity center -extent 75x75 -quality 100 JPEG:" . $xthumb_file
                );
                ilShellUtil::execConvert(
                    $uploaded_file . "[0] -geometry 30x30^ -gravity center -extent 30x30 -quality 100 JPEG:" . $xxthumb_file
                );
            } else {
                ilShellUtil::execConvert($uploaded_file . "[0] -geometry 200x200 -quality 100 JPEG:" . $show_file);
                ilShellUtil::execConvert($uploaded_file . "[0] -geometry 100x100 -quality 100 JPEG:" . $thumb_file);
                ilShellUtil::execConvert($uploaded_file . "[0] -geometry 75x75 -quality 100 JPEG:" . $xthumb_file);
                ilShellUtil::execConvert($uploaded_file . "[0] -geometry 30x30 -quality 100 JPEG:" . $xxthumb_file);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$back_target

array ilObjUserGUI::$back_target

protected

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

$default_role

int ilObjUserGUI::$default_role

protected

Definition at line 29 of file class.ilObjUserGUI.php.

$form_gui

ilPropertyFormGUI ilObjUserGUI::$form_gui

protected

Definition at line 35 of file class.ilObjUserGUI.php.

$gender

array ilObjUserGUI::$gender

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

$ilCtrl

ilCtrl ilObjUserGUI::$ilCtrl

Definition at line 40 of file class.ilObjUserGUI.php.

Referenced by __construct().

$requested_baseClass

string ilObjUserGUI::$requested_baseClass = ""

protected

Definition at line 44 of file class.ilObjUserGUI.php.

$requested_letter

string ilObjUserGUI::$requested_letter = ""

protected

Definition at line 43 of file class.ilObjUserGUI.php.

$requested_search

string ilObjUserGUI::$requested_search = ""

protected

Definition at line 45 of file class.ilObjUserGUI.php.

$selectable_roles

array ilObjUserGUI::$selectable_roles

protected

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

$uiFactory

ILIAS UI Factory ilObjUserGUI::$uiFactory

protected

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

Referenced by __construct().

$uiRenderer

ILIAS UI Renderer ilObjUserGUI::$uiRenderer

protected

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

Referenced by __construct().

$update

bool ilObjUserGUI::$update

protected

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

$user_defined_fields

ilUserDefinedFields ilObjUserGUI::$user_defined_fields

protected

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

$user_ref_id

int ilObjUserGUI::$user_ref_id

Definition at line 42 of file class.ilObjUserGUI.php.

$user_request

ILIAS User StandardGUIRequest ilObjUserGUI::$user_request

protected

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

$usrf_ref_id

int ilObjUserGUI::$usrf_ref_id

protected

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

---

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

• Services/User/classes/class.ilObjUserGUI.php