ilObjUserGUI Class Reference

Class ilObjUserGUI. More...

Inheritance diagram for ilObjUserGUI:

Collaboration diagram for ilObjUserGUI:

Public Member Functions
	executeCommand ()
	cancelObject ()
	cancel action and go back to previous page More...
	getAdminTabs ()
	administration tabs show only permissions and trash folder More...
	createObject ()
	Display user create form. More...
	saveObject ()
	save user data More...
	updateObject ()
	updates object entry in object_data More...
	editObject ()
	removeUserPictureObject ()
	assignSaveObject ()
	roleassignmentObject ()
	applyFilterObject ()
	resetFilterObject ()
	__getDateSelect (string $a_type, string $a_varname, string $a_selected)
	__toUnix (array $a_time_arr)
	__unsetSessionVariables ()
	__buildFilterSelect ()
	__sendProfileMail ()
Public Member Functions inherited from ilObjectGUI
	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] does belong to the parent 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...
	cancelObject ()
	cancel action and go back to previous page More...
	createObject ()
	create new object form More...
	editAvailabilityPeriodObject ()
	saveAvailabilityPeriodObject ()
	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)
	addToDeskObject ()
	removeFromDeskObject ()
Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Protected Member Functions
	setTitleAndDescription ()
	getTabs ()
	@abstract overwrite in derived GUI class of your object type More...
	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	assignObject ()
	setTitleAndDescription ()
	createActionDispatcherGUI ()
	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...
	getCreationFormsHTML (StandardForm|ilPropertyFormGUI|array $form)
	getTitleForCreationFormPage ()
	getCreationFormTitle ()
	initCreateForm (string $new_type)
	didacticTemplatesToForm ()
	initDidacticTemplate (ilPropertyFormGUI $form)
	retrieveAdditionalDidacticTemplateOptions ()
	addAdoptContentLinkToToolbar ()
	addImportButtonToToolbar ()
	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)
	parseDidacticTemplateVar (string $var, string $type)
	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...
	routeImportCmdObject ()
	importFile (string $file_to_import, string $path_to_uploaded_file_in_temp_dir)
	deleteUploadedImportFile (string $path_to_uploaded_file_in_temp_dir)
	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 ()
	@abstract 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...
	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...
	getCreatableObjectTypes ()
	buildAddNewItemElements (array $subtypes, string $create_target_class=ilRepositoryGUI::class, ?int $redirect_target_ref_id=null,)
	buildGroup (string $create_target_class, array $obj_types_in_group, string $title, array $subtypes)

Private Member Functions
	initCreate ()
	initForm (bool $do_require, ?\ilObjUser $user)
	Init user form. More...
	buildSectionHeader (string $title_lang_var)
	buildNonEditableInput (string $identifier, string $value)
	buildAuthModeInput (?\ilObjUser $user)
	buildLoginInput (?\ilObjUser $user)
	buildPasswordInput (?\ilObjUser $user)
	buildExternalAccountInput (?\ilObjUser $user)
	buildTimeLimitInput (?\ilObjUser $user)
	buildTimeLimitDateInputs (?\ilObjUser $user)
	buildStatisticalInputs (?\ilObjUser $user)
	addSystemInformationSectionToForm (?\ilObjUser $user)
	addValuesFromSystemInformationToUserSection (\ilObjUser $user, bool $user_creation)
	addStatisticalInformationToForm (?\ilObjUser $user)
	addOptionsSectionToForm ()
	moveFileToStorage ()
	handleIgnoredRequiredFields ()
	Handles ignored required fields by changing the required flag of form elements. More...
	checkUserWritePermission ()
	renderForm ()
	checkAccessToRolesTab ()
	retrieveAllowIncompleteProfileFromPost ()
	redirectDependingOnParent ()
	isAccessRangeInputValid ()

Private Attributes
ilPropertyFormGUI	$form_gui
UserGUIRequest	$user_request
ilHelpGUI	$help
ilTabsGUI	$tabs
RepositoryGUIs	$repository_guis
ilMailMimeSenderFactory	$mail_sender_factory
FileUpload	$uploads
ResourceStorageServices	$irss
ResourceStakeholder	$stakeholder
UserSettingsImplementation	$user_settings
Profile	$user_profile
string	$requested_letter = ''
string	$requested_baseClass = ''
string	$requested_search = ''
array	$selectable_roles
int	$default_role
string	$default_layout_and_style
int	$usrf_ref_id
Context	$context
Conductor	$legal_documents

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)
Data Fields inherited from ilObjectGUI
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
const	SUPPORTED_IMPORT_MIME_TYPES = [MimeType::APPLICATION__ZIP, MimeType::APPLICATION__X_ZIP_COMPRESSED]
Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service
GlobalHttpState	$http
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
Refinery	$refinery
ilFavouritesManager	$favourites
CustomIconFactory	$custom_icon_factory
UIFactory	$ui_factory
UIRenderer	$ui_renderer
Filesystem	$temp_file_system
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 = ""

Detailed Description

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 @ilCtrl_Calls ilObjUserGUI: ilLearningProgressGUI, ilObjectOwnershipManagementGUI

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

Member Function Documentation

__buildFilterSelect()

ilObjUserGUI::__buildFilterSelect

(

)

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

                                         : 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
        );
    }

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

Here is the call graph for this function:

__getDateSelect()

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

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

     : 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 '';
    }

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

Here is the call graph for this function:

__sendProfileMail()

ilObjUserGUI::__sendProfileMail

(

)

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

                                       : string
    {
        if ($this->user_request->getSendMail() != 'y') {
            return '';
        }
        if (!strlen($this->object->getEmail())) {
            return '';
        }
 
        $usr_lang = new ilLanguage($this->object->getLanguage());
        $usr_lang->loadLanguageModule('crs');
        $usr_lang->loadLanguageModule('registration');
 
        $mmail = new ilMimeMail();
        $mmail->From($this->mail_sender_factory->system());
 
        $mailOptions = new ilMailOptions($this->object->getId());
        $mmail->To($mailOptions->getExternalEmailAddresses());
 
        $subject = $usr_lang->txt('profile_changed');
        $body = $usr_lang->txt('reg_mail_body_salutation')
            . ' ' . $this->object->getFullname() . ",\n\n";
 
        $date = $this->object->getApproveDate();
 
        if ($date !== null && (time() - strtotime($date)) < 10) {
            $body .= $usr_lang->txt('reg_mail_body_approve') . "\n\n";
        } else {
            $body .= $usr_lang->txt('reg_mail_body_profile_changed') . "\n\n";
        }
 
        // Append login info only if password has been changed
        if ($this->user_request->getPassword() != '') {
            $body .= $usr_lang->txt('reg_mail_body_text2') . "\n" .
                ILIAS_HTTP_PATH . '/login.php?client_id=' . CLIENT_ID . "\n" .
                $usr_lang->txt('login') . ': ' . $this->object->getLogin() . "\n" .
                $usr_lang->txt('passwd') . ': ' . $this->user_request->getPassword() . "\n\n";
        }
        $body .= $usr_lang->txt('reg_mail_body_text3') . "\n";
        $body .= $this->object->getProfileAsString($usr_lang);
        $body .= ilMail::_getInstallationSignature();
 
 
        $mmail->Subject($subject, true);
        $mmail->Body($body);
        $mmail->Send();
 
        return '<br/>' . $this->lng->txt('mail_sent');
    }

References ilMail\_getInstallationSignature(), CLIENT_ID, ILIAS\Repository\lng(), and ILIAS\Repository\object().

Referenced by updateObject().

Here is the call graph for this function:

Here is the caller graph for this function:

__toUnix()

ilObjUserGUI::__toUnix

(

array

$a_time_arr

)

Definition at line 1093 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 1105 of file class.ilObjUserGUI.php.

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

References ilSession\clear().

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)

Reimplemented from ilObjectGUI.

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

                                                                            : void
    {
        $this->locator->clearItems();
 
        if ($this->admin_mode == 'settings') {    // system settings
            $this->ctrl->setParameterByClass(
                'ilobjsystemfoldergui',
                'ref_id',
                SYSTEM_FOLDER_ID
            );
            $this->locator->addItem(
                $this->lng->txt('administration'),
                $this->ctrl->getLinkTargetByClass(['iladministrationgui', 'ilobjsystemfoldergui'], ''),
                ilFrameTargetInfo::_getFrame('MainContent')
            );
 
            if ($this->requested_ref_id == USER_FOLDER_ID) {
                $this->locator->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) {
                $this->locator->addItem(
                    $this->lng->txt('obj_' . ilObject::_lookupType(
                        ilObject::_lookupObjId($this->requested_ref_id)
                    )),
                    $this->ctrl->getLinkTargetByClass('ilobjrolefoldergui', 'view')
                );
            }
 
            if ($this->obj_id > 0) {
                $this->locator->addItem(
                    $this->object->getTitle(),
                    $this->ctrl->getLinkTarget($this, 'view')
                );
            }
        }
    }

References ilFrameTargetInfo\_getFrame(), ilObject\_lookupObjId(), ilObject\_lookupType(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\locator(), ILIAS\Repository\object(), ROLE_FOLDER_ID, SYSTEM_FOLDER_ID, and USER_FOLDER_ID.

Here is the call graph for this function:

addOptionsSectionToForm()

ilObjUserGUI::addOptionsSectionToForm ( )

private

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

                                              : void
    {
        $this->form_gui->addItem(
            $this->buildSectionHeader('user_admin_options')
        );
 
        $se = new ilCheckboxInputGUI($this->lng->txt('inform_user_mail'), 'send_mail');
        $se->setInfo($this->lng->txt('inform_user_mail_info'));
        $se->setValue('y');
        $se->setChecked(($this->user->getPref('send_info_mails') == 'y'));
        $this->form_gui->addItem($se);
 
        $irf = new ilCheckboxInputGUI($this->lng->txt('ignore_required_fields'), 'ignore_rf');
        $irf->setInfo($this->lng->txt('ignore_required_fields_info'));
        $irf->setValue('1');
        $this->form_gui->addItem($irf);
    }

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

Here is the call graph for this function:

addStatisticalInformationToForm()

ilObjUserGUI::addStatisticalInformationToForm ( ?\ilObjUser  $user )

private

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

     : void {
        if ($user === null) {
            return;
        }
 
        foreach ($this->buildStatisticalInputs($user) as $input) {
            $this->form_gui->addItem($input);
        }
 
        foreach ($this->legal_documents->userManagementFields($this->object) as $identifier => $value) {
            if (is_string($value)) {
                $value = $this->buildNonEditableInput($identifier, $value);
            }
            $this->form_gui->addItem($value);
        }
    }

addSystemInformationSectionToForm()

ilObjUserGUI::addSystemInformationSectionToForm ( ?\ilObjUser  $user )

private

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

     : void {
        $this->form_gui->addItem(
            $this->buildSectionHeader('system_information')
        );
 
        $this->addStatisticalInformationToForm($user);
 
        $ac = new ilCheckboxInputGUI($this->lng->txt('active'), 'active');
        $ac->setChecked(
            $user === null
                ? true
                : $user->getActive()
        );
        $this->form_gui->addItem($ac);
 
        $this->form_gui->addItem($this->buildTimeLimitInput($user));
    }

addValuesFromSystemInformationToUserSection()

ilObjUserGUI::addValuesFromSystemInformationToUserSection ( \ilObjUser  $user, bool  $user_creation  )

private

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

     : \ilObjUser {
        $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') === '1');
 
        if ($user_creation) {
            $user->setTimeLimitOwner($this->usrf_ref_id);
        }
 
        $active_from_input = $this->form_gui->getInput('active') === '1';
        if ($user->getActive() !== $active_from_input) {
            $user->setActive($active_from_input, $this->user->getId());
        }
 
        return $user;
    }

References ilObjUser\setTimeLimitOwner().

Referenced by saveObject(), and updateObject().

Here is the call graph for this function:

Here is the caller graph for this function:

applyFilterObject()

ilObjUserGUI::applyFilterObject

(

)

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

                                       : void
    {
        $table_gui = new ilRoleAssignmentTableGUI($this, 'roleassignment');
        $table_gui->writeFilterToSession();
        $table_gui->resetOffset();
        $this->roleassignmentObject();
    }

assignSaveObject()

ilObjUserGUI::assignSaveObject

(

)

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

                                      : void
    {
        if (!$this->rbac_system->checkAccess('edit_roleassignment', $this->usrf_ref_id)) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('msg_no_perm_assign_role_to_user')
            );
            $this->redirectDependingOnParent();
        }
 
        $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 && in_array(SYSTEM_ROLE_ID, $posted_roles)) {
            $selected_roles[] = SYSTEM_ROLE_ID;
        }
 
        $global_roles_all = $this->rbac_review->getGlobalRoles();
        $assigned_roles_all = $this->rbac_review->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, $this->rbac_review->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('action_aborted')}: {$this->lng->txt('msg_min_one_role')}",
                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;
            }
            $this->rbac_admin->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;
            }
            $this->rbac_admin->assignUser($role, $this->object->getId(), false);
        }
 
        $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');
        }
    }

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

Here is the call graph for this function:

buildAuthModeInput()

ilObjUserGUI::buildAuthModeInput ( ?\ilObjUser  $user )

private

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

     : ilSelectInputGUI {
        $input = new ilSelectInputGUI($this->lng->txt('auth_mode'), 'auth_mode');
        $option = [];
        foreach (ilAuthUtils::_getActiveAuthModes() as $auth_name => $auth_key) {
            if ($auth_name == 'default') {
                $name = $this->lng->txt('auth_' . $auth_name)
                    . ' (' . $this->lng->txt('auth_' . ilAuthUtils::_getAuthModeName((string) $auth_key)) . ')';
            } else {
                $name = ilAuthUtils::getAuthModeTranslation((string) $auth_key, $auth_name);
            }
            $option[$auth_name] = $name;
        }
        $input->setOptions($option);
        if ($user === null) {
            return $input;
        }
 
        $input->setValue($this->object->getAuthMode());
        return $input;
    }

References ilAuthUtils\_getAuthModeName(), ilAuthUtils\getAuthModeTranslation(), and ILIAS\Repository\lng().

Here is the call graph for this function:

buildExternalAccountInput()

ilObjUserGUI::buildExternalAccountInput ( ?\ilObjUser  $user )

private

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

     : ilTextInputGUI {
        $input = new ilTextInputGUI($this->lng->txt('user_ext_account'), 'ext_account');
        $input->setSize(40);
        $input->setMaxLength(250);
        $input->setInfo($this->lng->txt('user_ext_account_desc'));
        if ($user === null) {
            return $input;
        }
        $input->setValue($user->getExternalAccount());
        return $input;
    }

buildLoginInput()

ilObjUserGUI::buildLoginInput ( ?\ilObjUser  $user )

private

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

     : ilUserLoginInputGUI {
        $field = $this->user_profile->getFieldByIdentifier('username');
        $input = $field->getLegacyInput(
            $this->lng,
            $this->context,
            $user
        );
        $input->setDisabled(!$this->context->isFieldChangeable($field, $user));
        $input->setRequired($this->context->isFieldChangeable($field, $user));
        return $input;
    }

buildNonEditableInput()

ilObjUserGUI::buildNonEditableInput ( string  $identifier, string  $value  )

private

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

     : ilNonEditableValueGUI {
        $input = new ilNonEditableValueGUI($this->lng->txt($identifier), $identifier);
        $input->setValue($value);
        return $input;
    }

buildPasswordInput()

ilObjUserGUI::buildPasswordInput ( ?\ilObjUser  $user )

private

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

     : ilPasswordInputGUI {
        $input = new ilPasswordInputGUI($this->lng->txt('passwd'), 'passwd');
        $input->setUseStripSlashes(false);
        $input->setSize(32);
        $input->setMaxLength(80);
        $input->setValidateAuthPost('auth_mode');
        if ($user === null) {
            $input->setRequiredOnAuth(true);
        }
        if ($this->user->getId() !== (int) SYSTEM_USER_ID
            && in_array(SYSTEM_ROLE_ID, $this->rbac_review->assignedRoles($this->user->getId()))
            && !in_array(SYSTEM_ROLE_ID, $this->rbac_review->assignedRoles($this->user->getId()))) {
            $input->setDisabled(true);
        }
        $input->setInfo(ilSecuritySettingsChecker::getPasswordRequirementsInfo());
        return $input;
    }

buildSectionHeader()

ilObjUserGUI::buildSectionHeader ( string  $title_lang_var )

private

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

                                                               : ilFormSectionHeaderGUI
    {
        $section = new ilFormSectionHeaderGUI();
        $section->setTitle($this->lng->txt($title_lang_var));
        return $section;
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

buildStatisticalInputs()

ilObjUserGUI::buildStatisticalInputs ( ?\ilObjUser  $user )

private

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

     : Generator {
        yield $this->buildNonEditableInput(
            'create_date',
            ilDatePresentation::formatDate(new ilDateTime(
                $user->getCreateDate(),
                IL_CAL_DATETIME
            ))
        );
 
        yield $this->buildNonEditableInput(
            'approve_date',
            ilDatePresentation::formatDate(new ilDateTime(
                $user->getApproveDate(),
                IL_CAL_DATETIME
            ))
        );
 
        yield $this->buildNonEditableInput(
            'last_login',
            ilDatePresentation::formatDate(new ilDateTime(
                $user->getLastLogin(),
                IL_CAL_DATETIME
            ))
        );
 
        yield $this->buildNonEditableInput('owner', $user->getOwnerName());
    }

buildTimeLimitDateInputs()

ilObjUserGUI::buildTimeLimitDateInputs ( ?\ilObjUser  $user )

private

Returns

array<\ilDateTimeInputGUI>

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

     : Generator {
        $from = new ilDateTimeInputGUI($this->lng->txt('crs_from'), 'time_limit_from');
        $from->setRequired(true);
        $from->setShowTime(true);
        $from->setMinuteStepSize(1);
        $from->setDate(
            new ilDateTime($user?->getTimeLimitFrom(), IL_CAL_UNIX)
        );
        yield $from;
 
        $to = new ilDateTimeInputGUI($this->lng->txt('crs_to'), 'time_limit_until');
        $to->setRequired(true);
        $to->setShowTime(true);
        $to->setMinuteStepSize(1);
        $to->setDate(
            new ilDateTime($user?->getTimeLimitUntil(), IL_CAL_UNIX)
        );
        yield $to;
    }

buildTimeLimitInput()

ilObjUserGUI::buildTimeLimitInput ( ?\ilObjUser  $user )

private

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

      {
        $radg = new ilRadioGroupInputGUI($this->lng->txt('time_limit'), 'time_limit_unlimited');
        $radg->setRequired(true);
        $op1 = new ilRadioOption($this->lng->txt('user_access_unlimited'), '1');
        $radg->addOption($op1);
        $op2 = new ilRadioOption($this->lng->txt('user_access_limited'), '0');
        foreach ($this->buildTimeLimitDateInputs($user) as $input) {
            $op2->addSubItem($input);
        }
        $radg->addOption($op2);
        $radg->setValue(
            $user?->getTimeLimitUnlimited() ?? true ? '1' : '0'
        );
 
        return $radg;
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

cancelObject()

ilObjUserGUI::cancelObject

(

)

cancel action and go back to previous page

Reimplemented from ilObjectGUI.

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

                                  : void
    {
        ilSession::clear('saved_post');
 
        if (strtolower($this->requested_baseClass) == 'iladministrationgui') {
            $this->ctrl->redirectByClass('ilobjuserfoldergui', 'view');
        } else {
            $this->ctrl->redirectByClass('ilobjcategorygui', 'listUsers');
        }
    }

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

Here is the call graph for this function:

checkAccessToRolesTab()

ilObjUserGUI::checkAccessToRolesTab ( )

private

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

                                            : bool
    {
        return $this->object->getId() !== (int) ANONYMOUS_USER_ID
            && (
                $this->rbac_system->checkAccess('edit_roleassignment', $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()]
                        )
                    )
            );
    }

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

Referenced by getTabs().

Here is the call graph for this function:

Here is the caller graph for this function:

checkUserWritePermission()

ilObjUserGUI::checkUserWritePermission ( )

private

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

                                               : void
    {
        if ($this->context === Context::UserAdministration
            && !(
                $this->rbac_system->checkAccess(\ilObjUserFolder::PERM_READ_ALL_AND_WRITE, $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->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('msg_no_perm_modify_user'),
                true
            );
            $this->ctrl->redirectByClass(ilObjUserFolderGUI::class);
        }
 
        // 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->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('msg_no_perm_modify_user')
            );
            $this->redirectToRefId($this->usrf_ref_id);
        }
    }

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

Referenced by editObject(), and updateObject().

Here is the call graph for this function:

Here is the caller graph for this function:

createObject()

ilObjUserGUI::createObject

(

)

Display user create form.

Reimplemented from ilObjectGUI.

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

                                  : void
    {
        if (!$this->rbac_system->checkAccess('create_usr', $this->usrf_ref_id)
            && !$this->rbac_system->checkAccess('cat_administrate_users', $this->usrf_ref_id)) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('permission_denied')
            );
            $this->redirectDependingOnParent();
        }
 
        $this->initCreate();
        $this->initForm(true, null);
        $this->renderForm();
    }

References initCreate(), initForm(), ILIAS\Repository\lng(), redirectDependingOnParent(), and renderForm().

Here is the call graph for this function:

editObject()

ilObjUserGUI::editObject

(

)

Reimplemented from ilObjectGUI.

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

                                : void
    {
        $this->checkUserWritePermission();
 
        if ($this->usrf_ref_id != USER_FOLDER_ID) {
            $this->tabs_gui->clearTargets();
        }
 
        // get form
        $this->initForm(true, $this->object);
        $this->renderForm();
    }

References checkUserWritePermission(), initForm(), renderForm(), and USER_FOLDER_ID.

Here is the call graph for this function:

executeCommand()

ilObjUserGUI::executeCommand

(

)

Reimplemented from ilObjectGUI.

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

                                    : 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 strtolower(ilObjectOwnershipManagementGUI::class):
                $this->ctrl->forwardCommand(
                    $this->repository_guis->ownershipManagementGUI(
                        $this->object->getId()
                    )
                );
                break;
 
            default:
                if ($cmd == '' || $cmd == 'view') {
                    $cmd = 'edit';
                }
                $cmd .= 'Object';
                $this->$cmd();
                break;
        }
    }

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

Here is the call graph for this function:

getAdminTabs()

ilObjUserGUI::getAdminTabs

(

)

administration tabs show only permissions and trash folder

Reimplemented from ilObjectGUI.

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

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

References getTabs().

Here is the call graph for this function:

getTabs()

ilObjUserGUI::getTabs ( )

protected

@abstract overwrite in derived GUI class of your object type

Reimplemented from ilObjectGUI.

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

                                : void
    {
        $this->tabs_gui->clearTargets();
 
        $this->help->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'),
                ['edit', '', 'view'],
                get_class($this),
                '',
                true
            );
        } else {
            $this->tabs_gui->addTarget(
                'properties',
                $this->ctrl->getLinkTarget($this, 'edit'),
                ['edit', '', 'view'],
                get_class($this)
            );
        }
 
        if ($this->checkAccessToRolesTab()) {
            $this->tabs_gui->addTarget(
                'role_assignment',
                $this->ctrl->getLinkTarget($this, 'roleassignment'),
                ['roleassignment'],
                get_class($this)
            );
        }
 
        if ((
            $this->context === Context::LocalUserAdministration
                && $this->rbac_system->checkAccess('read', $this->ref_id)
            || $this->context === Context::UserAdministration
                && $this->rbac_system->checkAccess(\ilObjUserFolder::PERM_READ_ALL, $this->ref_id)
        ) && ilObjUserTracking::_enabledLearningProgress()
            && ilObjUserTracking::_enabledUserRelatedData()) {
            $this->tabs_gui->addTarget(
                'learning_progress',
                $this->ctrl->getLinkTargetByClass('illearningprogressgui', ''),
                '',
                ['illplistofobjectsgui', 'illplistofsettingsgui', 'illearningprogressgui', 'illplistofprogressgui']
            );
        }
 
        $this->tabs_gui->addTarget(
            'user_ownership',
            $this->ctrl->getLinkTargetByClass('ilobjectownershipmanagementgui', ''),
            '',
            'ilobjectownershipmanagementgui'
        );
    }

References ilObjUserTracking\_enabledLearningProgress(), ilObjUserTracking\_enabledUserRelatedData(), checkAccessToRolesTab(), ILIAS\Repository\ctrl(), ilSession\get(), ILIAS\Repository\help(), ILIAS\Repository\lng(), and ilObjUserFolder\PERM_READ_ALL.

Referenced by getAdminTabs().

Here is the call graph for this function:

Here is the caller graph for this function:

handleIgnoredRequiredFields()

ilObjUserGUI::handleIgnoredRequiredFields ( )

private

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 1298 of file class.ilObjUserGUI.php.

                                                  : bool
    {
        $profile_maybe_incomplete = false;
 
        foreach ($this->user_profile->getIgnorableRequiredFields() as $fieldName) {
            $elm = $this->form_gui->getItemByPostVar($fieldName);
 
            if (!$elm) {
                continue;
            }
 
            if ($elm->getRequired()) {
                $profile_maybe_incomplete = true;
 
                // Flag as optional
                $elm->setRequired(false);
            }
        }
 
        foreach ($this->user_profile->getAllUserDefinedFields() as $field) {
            $elm = $this->form_gui->getItemByPostVar('udf_' . $field->getIdentifier());
 
            if (!$elm) {
                continue;
            }
 
            if ($elm->getRequired() && $field->isRequired()) {
                $profile_maybe_incomplete = true;
 
                // Flag as optional
                $elm->setRequired(false);
            }
        }
 
        return $profile_maybe_incomplete;
    }

initCreate()

ilObjUserGUI::initCreate ( )

private

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

                                 : void
    {
        if ($this->usrf_ref_id !== USER_FOLDER_ID) {
            $this->tabs_gui->clearTargets();
        }
 
        // role selection
        $obj_list = $this->rbac_review->getRoleListByObject(ROLE_FOLDER_ID);
        $rol = [];
        foreach ($obj_list as $obj_data) {
            // allow only 'assign_users' marked roles if called from category
            if ($this->object->getRefId() !== USER_FOLDER_ID && !in_array(
                SYSTEM_ROLE_ID,
                $this->rbac_review->assignedRoles($this->user->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 || in_array(
                    SYSTEM_ROLE_ID,
                    $this->rbac_review->assignedRoles($this->user->getId())
                )) {
                    $rol[$obj_data['obj_id']] = $obj_data['title'];
                }
            }
        }
 
        if ($rol === null) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('msg_no_roles_users_can_be_assigned_to')
            );
            $this->redirectDependingOnParent();
        }
 
        $keys = array_keys($rol);
 
        // set pre defined user role to default
        if (in_array(4, $keys)) {
            $this->default_role = 4;
        } elseif (count($keys) > 1 && 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;
    }

References ilObjRole\_getAssignUsersStatus(), ANONYMOUS_ROLE_ID, ILIAS\Repository\lng(), ILIAS\Repository\object(), redirectDependingOnParent(), ROLE_FOLDER_ID, SYSTEM_ROLE_ID, and USER_FOLDER_ID.

Referenced by createObject(), and saveObject().

Here is the call graph for this function:

Here is the caller graph for this function:

initForm()

ilObjUserGUI::initForm ( bool  $do_require, ?\ilObjUser  $user  )

private

Init user form.

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

     : void {
        $this->form_gui = new ilPropertyFormGUI();
        $this->form_gui->setFormAction(
            $this->ctrl->getFormActionByClass(self::class)
        );
 
        $this->form_gui->setTitle($this->lng->txt('usr_new'));
        if ($user !== null) {
            $this->form_gui->setTitle($this->lng->txt('usr_edit'));
        }
 
        $this->form_gui->addItem(
            $this->buildSectionHeader('login_data')
        );
 
        $this->form_gui->addItem(
            $this->buildAuthModeInput($user)
        );
 
        if ($user !== null) {
            $id = $this->buildNonEditableInput('usr_id', (string) $user->getId());
            $this->form_gui->addItem($id);
        }
 
        $this->form_gui->addItem(
            $this->buildLoginInput($user)
        );
 
        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()))) {
            $this->form_gui->addItem(
                $this->buildPasswordInput($user)
            );
        }
 
        if (ilAuthUtils::_isExternalAccountEnabled()) {
            $this->form_gui->addItem(
                $this->buildExternalAccountInput($user)
            );
        }
 
        $this->addSystemInformationSectionToForm($user);
 
        $this->form_gui = $this->user_profile->addFieldsToForm(
            $this->form_gui,
            $this->context,
            $do_require,
            $user,
            [Alias::class]
        );
 
        $this->form_gui->addItem(
            $this->buildSectionHeader('settings')
        );
 
        $this->form_gui = $this->user_settings->addSectionsToLegacyForm(
            $this->form_gui,
            [AvailablePages::MainSettings, AvailablePages::PrivacySettings],
            $this->context,
            $user
        );
 
        $this->addOptionsSectionToForm();
 
        if ($user === null) {
            $this->form_gui->addCommandButton('save', $this->lng->txt('save'));
        } else {
            $this->form_gui->addCommandButton('update', $this->lng->txt('save'));
        }
        $this->form_gui->addCommandButton('cancel', $this->lng->txt('cancel'));
    }

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

Here is the caller graph for this function:

isAccessRangeInputValid()

ilObjUserGUI::isAccessRangeInputValid ( )

private

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

                                              : bool
    {
        if ($this->form_gui->getInput('time_limit_unlimited') === '1') {
            return true;
        }
        $timefrom = $this->form_gui->getItemByPostVar('time_limit_from');
        $timeuntil = $this->form_gui->getItemByPostVar('time_limit_until');
        if ($timeuntil->getDate()->get(IL_CAL_UNIX) <= $timefrom->getDate()->get(IL_CAL_UNIX)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('form_input_not_valid'));
            $timeuntil->setAlert($this->lng->txt('time_limit_not_valid'));
            return false;
        }
        return true;
    }

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

Here is the call graph for this function:

moveFileToStorage()

ilObjUserGUI::moveFileToStorage ( )

private

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

                                        : ?ResourceIdentification
    {
        $uploads = $this->uploads->getResults();
        $upload_tmp_name = $_FILES['userfile']['tmp_name'];
        $avatar_upload_result = $uploads[$upload_tmp_name] ?? null;
 
        $existing_rid = $this->object->getAvatarRid();
        $revision_title = 'Avatar for user ' . $this->object->getLogin();
        $this->stakeholder->setOwner($this->object->getId()); // The Resource is owned by the user we are editing
 
        if ($avatar_upload_result === null && file_exists($upload_tmp_name)) {
            $stream = Streams::ofResource(
                fopen($upload_tmp_name, 'r')
            );
 
            if ($existing_rid === null) {
                return $this->irss->manage()->stream($stream, $this->stakeholder, $revision_title);
            }
 
            $this->irss->manage()->appendNewRevisionFromStream(
                $existing_rid,
                $stream,
                $this->stakeholder,
                $revision_title
            );
            return $existing_rid;
        }
 
        if ($avatar_upload_result === null) {
            return null;
        }
 
        if ($existing_rid === null) {
            return $this->irss->manage()->upload(
                $avatar_upload_result,
                $this->stakeholder,
                $revision_title
            );
        }
 
        $this->irss->manage()->replaceWithUpload(
            $existing_rid,
            $avatar_upload_result,
            $this->stakeholder,
            $revision_title
        );
        return $existing_rid;
    }

References ILIAS\FileUpload\FileUpload\getResults(), and ILIAS\Repository\object().

Here is the call graph for this function:

redirectDependingOnParent()

ilObjUserGUI::redirectDependingOnParent ( )

private

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

                                                : void
    {
        if ($this->usrf_ref_id === USER_FOLDER_ID) {
            $this->ctrl->redirectByClass(ilObjUserFolderAccess::class);
        }
 
        $this->redirectToRefId($this->usrf_ref_id);
    }

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

Referenced by createObject(), and initCreate().

Here is the call graph for this function:

Here is the caller graph for this function:

removeUserPictureObject()

ilObjUserGUI::removeUserPictureObject

(

)

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

                                             : 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();
    }

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

Here is the call graph for this function:

renderForm()

ilObjUserGUI::renderForm ( )

private

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

                                 : void
    {
        $this->tpl->setContent($this->legal_documents->userManagementModals() . $this->form_gui->getHTML());
    }

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

Here is the caller graph for this function:

resetFilterObject()

ilObjUserGUI::resetFilterObject

(

)

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

                                       : void
    {
        $table_gui = new ilRoleAssignmentTableGUI($this, 'roleassignment');
        $table_gui->resetOffset();
        $table_gui->resetFilter();
        $this->roleassignmentObject();
    }

retrieveAllowIncompleteProfileFromPost()

ilObjUserGUI::retrieveAllowIncompleteProfileFromPost ( )

private

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

                                                             : bool
    {
        return $this->post_wrapper->retrieve(
            'ignore_rf',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->bool(),
                $this->refinery->always(false)
            ])
        );
    }

References ILIAS\Repository\refinery().

Referenced by saveObject(), and updateObject().

Here is the call graph for this function:

Here is the caller graph for this function:

roleassignmentObject()

ilObjUserGUI::roleassignmentObject

(

)

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

                                          : void
    {
        $this->tabs->activateTab('role_assignment');
 
        if (!$this->checkAccessToRolesTab()) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('msg_no_perm_view_roles_of_user'),
                true
            );
            $this->ctrl->redirectByClass(self::class, 'edit');
        }
 
        $req_filtered_roles = $this->user_request->getFilteredRoles();
        ilSession::set(
            'filtered_roles',
            ($req_filtered_roles > 0) ? $req_filtered_roles : ilSession::get('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', 'components/ILIAS/User');
 
        // init table
        $tab = new ilRoleAssignmentTableGUI($this, 'roleassignment');
 
        $tab->parse($this->object->getId());
        $this->tpl->setVariable('ROLES_TABLE', $tab->getHTML());
    }

References ILIAS\Repository\ctrl(), ilSession\get(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ilSession\set(), and ILIAS\Repository\tabs().

Here is the call graph for this function:

saveObject()

ilObjUserGUI::saveObject

(

)

save user data

Reimplemented from ilObjectGUI.

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

                                : void
    {
        if (!$this->rbac_system->checkAccess('create_usr', $this->usrf_ref_id)
            && !$this->access->checkAccess('cat_administrate_users', '', $this->usrf_ref_id)) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('msg_no_perm_modify_user')
            );
            $this->redirectToRefId($this->usrf_ref_id);
        }
 
        $this->initCreate();
        $profile_maybe_incomplete = $this->retrieveAllowIncompleteProfileFromPost();
        $this->initForm(!$profile_maybe_incomplete, null);
 
        if (!$this->form_gui->checkInput()) {
            $this->form_gui->setValuesByPost();
            $this->renderForm();
            return;
        }
 
        $new_user = new ilObjUser();
        $new_user->create();
        $new_user->saveAsNew();
 
        $user_object = $this->user_profile->addFormValuesToUser(
            $this->form_gui,
            $this->context,
            $new_user
        );
 
        $user_object->setLogin($this->form_gui->getInput('username'));
        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()))) {
            $user_object->setPasswd($this->form_gui->getInput('passwd'), ilObjUser::PASSWD_PLAIN);
        }
        if (ilAuthUtils::_isExternalAccountEnabled()) {
            $user_object->setExternalAccount($this->form_gui->getInput('ext_account'));
        }
        $user_object->setLastPasswordChangeTS(time());
 
        $user_object->setTitle($user_object->getFullname());
        $user_object->setDescription($user_object->getEmail());
        $user_object->update();
 
        $this->object = $this->user_settings->saveForm(
            $this->form_gui,
            [AvailablePages::MainSettings, AvailablePages::PrivacySettings],
            $this->context,
            $this->addValuesFromSystemInformationToUserSection($user_object, true)
        );
 
        //set role entries
        $this->rbac_admin->assignUser(
            (int) $this->form_gui->getInput('default_role'),
            $user_object->getId(),
            true
        );
 
        $msg = $this->lng->txt('user_added');
 
        $this->user->writePref(
            'send_info_mails',
            $this->form_gui->getInput('send_mail') === 'y' ? 'y' : 'n'
        );
 
        if ($profile_maybe_incomplete
            && $this->user_profile->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->setUserPassword($this->form_gui->getInput('passwd'));
            $acc_mail->setUser($user_object);
 
            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) === strtolower(ilAdministrationGUI::class)) {
            $this->ctrl->redirectByClass('ilobjuserfoldergui', 'view');
            return;
        }
 
        $this->ctrl->redirectByClass('ilobjcategorygui', 'listUsers');
    }

References $new_user, ilAuthUtils\_isExternalAccountEnabled(), addValuesFromSystemInformationToUserSection(), ILIAS\Repository\ctrl(), initCreate(), initForm(), ILIAS\Repository\lng(), ilObjUser\PASSWD_PLAIN, ilObjectGUI\redirectToRefId(), renderForm(), retrieveAllowIncompleteProfileFromPost(), SYSTEM_ROLE_ID, SYSTEM_USER_ID, and ILIAS\Repository\user().

Here is the call graph for this function:

setTitleAndDescription()

ilObjUserGUI::setTitleAndDescription ( )

protected

Reimplemented from ilObjectGUI.

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

                                               : 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('standard/icon_' . $this->object->getType() . '.svg'),
                $this->lng->txt('obj_' . $this->object->getType())
            );
        } else {
            parent::setTitleAndDescription();
        }
    }

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

Here is the call graph for this function:

updateObject()

ilObjUserGUI::updateObject

(

)

updates object entry in object_data

Reimplemented from ilObjectGUI.

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

                                  : void
    {
        $this->checkUserWritePermission();
 
        $profile_maybe_incomplete = $this->retrieveAllowIncompleteProfileFromPost();
        $this->initForm(!$profile_maybe_incomplete, $this->object);
 
        if (!$this->form_gui->checkInput()
            || !$this->isAccessRangeInputValid()) {
            $this->form_gui->setValuesByPost();
            $this->tabs_gui->activateTab('properties');
            $this->renderForm();
            return;
        }
 
        try {
            $this->object->updateLogin($this->form_gui->getInput('username'), $this->context);
        } catch (ilUserException $e) {
            $this->tpl->setOnScreenMessage('failure', $e->getMessage());
            $this->form_gui->setValuesByPost();
            $this->renderForm();
            return;
        }
 
        $this->object->setAuthMode($this->form_gui->getInput('auth_mode'));
 
        $this->object = $this->user_profile->addFormValuesToUser(
            $this->form_gui,
            $this->context,
            $this->object
        );
 
        $passwd = $this->form_gui->getInput('passwd');
        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())))
            && !empty($passwd)) {
            $this->object->setPasswd($passwd, ilObjUser::PASSWD_PLAIN);
        }
        if (ilAuthUtils::_isExternalAccountEnabled()) {
            $this->object->setExternalAccount($this->form_gui->getInput('ext_account'));
        }
 
        $this->object->setTitle($this->object->getFullname());
        $this->object->setDescription($this->object->getEmail());
 
        $this->object = $this->user_settings->saveForm(
            $this->form_gui,
            [AvailablePages::MainSettings, AvailablePages::PrivacySettings],
            $this->context,
            $this->addValuesFromSystemInformationToUserSection($this->object, false)
        );
 
        $this->object->setLastPasswordChangeTS(time());
        $this->object->setProfileIncomplete(false);
 
        // If the current user is editing its own user account,
        // we update his preferences.
        if ($this->user->getId() === $this->object->getId()) {
            $this->user = $this->object;
        }
        $this->user->writePref(
            'send_info_mails',
            ($this->form_gui->getInput('send_mail') === 'y') ? 'y' : 'n'
        );
 
        $mail_message = $this->__sendProfileMail();
        $msg = $this->lng->txt('saved_successfully') . $mail_message;
 
        if ($profile_maybe_incomplete
            && $this->user_profile->isProfileIncomplete($this->object)) {
            $this->object->setProfileIncomplete(true);
            $this->object->update();
        }
 
        // feedback
        $this->tpl->setOnScreenMessage('success', $msg, true);
 
        if (strtolower($this->requested_baseClass) === strtolower(ilAdministrationGUI::class)) {
            $this->ctrl->redirectByClass('ilobjuserfoldergui', 'view');
            return;
        }
 
        $this->ctrl->redirectByClass('ilobjcategorygui', 'listUsers');
    }

References Vendor\Package\$e, ilObjectGUI\$object, __sendProfileMail(), ilAuthUtils\_isExternalAccountEnabled(), addValuesFromSystemInformationToUserSection(), checkUserWritePermission(), ILIAS\Repository\ctrl(), initForm(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ilObjUser\PASSWD_PLAIN, renderForm(), retrieveAllowIncompleteProfileFromPost(), SYSTEM_ROLE_ID, SYSTEM_USER_ID, and ILIAS\Repository\user().

Here is the call graph for this function:

Field Documentation

$context

Context ilObjUserGUI::$context

private

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

$default_layout_and_style

string ilObjUserGUI::$default_layout_and_style

private

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

$default_role

int ilObjUserGUI::$default_role

private

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

$form_gui

ilPropertyFormGUI ilObjUserGUI::$form_gui

private

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

$help

ilHelpGUI ilObjUserGUI::$help

private

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

$irss

ResourceStorageServices ilObjUserGUI::$irss

private

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

$legal_documents

Conductor ilObjUserGUI::$legal_documents

private

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

$mail_sender_factory

ilMailMimeSenderFactory ilObjUserGUI::$mail_sender_factory

private

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

$repository_guis

RepositoryGUIs ilObjUserGUI::$repository_guis

private

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

$requested_baseClass

string ilObjUserGUI::$requested_baseClass = ''

private

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

$requested_letter

string ilObjUserGUI::$requested_letter = ''

private

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

$requested_search

string ilObjUserGUI::$requested_search = ''

private

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

$selectable_roles

array ilObjUserGUI::$selectable_roles

private

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

$stakeholder

ResourceStakeholder ilObjUserGUI::$stakeholder

private

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

$tabs

ilTabsGUI ilObjUserGUI::$tabs

private

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

$uploads

FileUpload ilObjUserGUI::$uploads

private

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

$user_profile

Profile ilObjUserGUI::$user_profile

private

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

$user_request

UserGUIRequest ilObjUserGUI::$user_request

private

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

$user_settings

UserSettingsImplementation ilObjUserGUI::$user_settings

private

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

$usrf_ref_id

int ilObjUserGUI::$usrf_ref_id

private

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

---

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

• components/ILIAS/User/classes/class.ilObjUserGUI.php