ilCustomUserFieldsGUI Class Reference

Class ilCustomUserFieldsGUI. More...

Collaboration diagram for ilCustomUserFieldsGUI:

Public Member Functions
	__construct (int $ref_id, int $requested_field_id)
	executeCommand ()
	listUserDefinedFields ()
	addField (?ilPropertyFormGUI $a_form=null)
	getAccessOptions ()
	Get all access options, order is kept in forms. More...
	create ()
	edit (?ilPropertyFormGUI $a_form=null)
	update ()
	askDeleteField ()
	deleteField ()
	updateFields (string $action='')
	Update custom fields properties (from table gui) More...

Static Public Member Functions
static	getAccessPermissions ()

Protected Member Functions
	getPermissions ()
	initFieldDefinition ()
	initForm (string $a_mode='create')
	validateForm (ilPropertyFormGUI $form, ilUserDefinedFields $user_field_definitions, array &$access, ?array $a_field_permissions=null)

Private Attributes
UserGUIRequest	$request
ilCtrlInterface	$ctrl
Language	$lng
UIFactory	$ui_factory
ilGlobalTemplateInterface	$main_tpl
ilToolbarGUI	$toolbar
int	$ref_id = 0
bool	$confirm_change = false
int	$field_id = 0
array	$field_definition = []
ilClaimingPermissionHelper	$permissions

Detailed Description

Class ilCustomUserFieldsGUI.

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om ilCustomUserFieldsGUI:

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

Constructor & Destructor Documentation

__construct()

ilCustomUserFieldsGUI::__construct	(	int	$ref_id,
		int	$requested_field_id
	)

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

References $DIC, $ref_id, ilUserDefinedFields\_getInstance(), ILIAS\Repository\ctrl(), ilClaimingPermissionHelper\getInstance(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

      {
        global $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->ctrl = $DIC['ilCtrl'];
        $this->lng = $DIC['lng'];
        $this->ui_factory = $DIC['ui.factory'];
        $this->toolbar = $DIC['ilToolbar'];

        $this->lng->loadLanguageModule('user');
        $this->lng->loadLanguageModule('administration');

        $this->ref_id = $ref_id;

        $this->field_id = $requested_field_id;
        $this->ctrl->saveParameter($this, 'field_id', $this->field_id);

        if ($this->field_id) {
            $user_field_definitions = ilUserDefinedFields::_getInstance();
            $this->field_definition = $user_field_definitions->getDefinition($this->field_id);
        }

        $this->permissions = ilUDFPermissionHelper::getInstance(
            $DIC->user()->getId(),
            $ref_id
        );
        $this->request = new UserGUIRequest(
            $DIC->http(),
            $DIC->refinery()
        );
    }

Here is the call graph for this function:

Member Function Documentation

addField()

ilCustomUserFieldsGUI::addField

(

?ilPropertyFormGUI

$a_form = null

)

Definition at line 124 of file class.ilCustomUserFieldsGUI.php.

References initForm().

Referenced by create().

                                                               : void
    {
        if (!$a_form) {
            $a_form = $this->initForm('create');
        }

        $this->main_tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

askDeleteField()

ilCustomUserFieldsGUI::askDeleteField

(

)

Definition at line 629 of file class.ilCustomUserFieldsGUI.php.

References $id, ilUserDefinedFields\_getInstance(), ILIAS\Repository\ctrl(), listUserDefinedFields(), and ILIAS\Repository\lng().

                                    : bool
    {
        $fields = $this->request->getFields();
        if (count($fields) == 0) {
            $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
            $this->listUserDefinedFields();
            return false;
        }

        $confirmation_gui = new ilConfirmationGUI();
        $confirmation_gui->setFormAction($this->ctrl->getFormAction($this));
        $confirmation_gui->setHeaderText($this->lng->txt('udf_delete_sure'));
        $confirmation_gui->setCancel($this->lng->txt('cancel'), 'listUserDefinedFields');
        $confirmation_gui->setConfirm($this->lng->txt('delete'), 'deleteField');

        $user_field_definitions = ilUserDefinedFields::_getInstance();
        foreach ($fields as $id) {
            $definition = $user_field_definitions->getDefinition($id);
            $confirmation_gui->addItem('fields[]', (string) $id, $definition['field_name']);
        }

        $this->main_tpl->setContent($confirmation_gui->getHTML());

        return true;
    }

Here is the call graph for this function:

create()

ilCustomUserFieldsGUI::create

(

)

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

References XapiProxy\$plugin, ilUserDefinedFields\_getInstance(), ilMemberAgreement\_reset(), addField(), ILIAS\Repository\ctrl(), ilCustomUserFieldsHelper\getInstance(), initForm(), ILIAS\Repository\lng(), and validateForm().

                            : void
    {
        $user_field_definitions = ilUserDefinedFields::_getInstance();
        $user_field_definitions->setFieldType(
            $this->request->getFieldType()
        );

        $access = [];
        $form = $this->initForm('create');
        if ($this->validateForm($form, $user_field_definitions, $access)) {
            $user_field_definitions->setFieldName($form->getInput('name'));
            $user_field_definitions->enableVisible($access['visible']);
            $user_field_definitions->enableVisibleRegistration((bool) $access['visib_reg']);
            $user_field_definitions->enableVisibleLocalUserAdministration($access['visib_lua']);
            $user_field_definitions->enableCourseExport($access['course_export']);
            $user_field_definitions->enableGroupExport($access['group_export']);
            $user_field_definitions->enablePrgExport($access['prg_export']);
            $user_field_definitions->enableChangeable($access['changeable']);
            $user_field_definitions->enableChangeableLocalUserAdministration($access['changeable_lua']);
            $user_field_definitions->enableRequired($access['required']);
            $user_field_definitions->enableExport($access['export']);
            $user_field_definitions->enableSearchable($access['searchable']);
            $user_field_definitions->enableCertificate($access['certificate']);
            $new_id = $user_field_definitions->add();

            if ($user_field_definitions->isPluginType()) {
                $plugin = ilCustomUserFieldsHelper::getInstance()->getPluginForType($user_field_definitions->getFieldType());
                if ($plugin instanceof ilUDFDefinitionPlugin) {
                    $plugin->updateDefinitionFromForm($form, $new_id);
                }
            }
            if ($access['course_export']) {
                ilMemberAgreement::_reset();
            }

            $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('udf_added_field'), true);
            $this->ctrl->redirect($this);
        }

        $form->setValuesByPost();
        $this->addField($form);
    }

Here is the call graph for this function:

deleteField()

ilCustomUserFieldsGUI::deleteField

(

)

Definition at line 655 of file class.ilCustomUserFieldsGUI.php.

References $id, ilUserDefinedFields\_getInstance(), ilUDFPermissionHelper\ACTION_FIELD_DELETE, ilUDFPermissionHelper\CONTEXT_FIELD, ILIAS\Repository\ctrl(), getPermissions(), and ILIAS\Repository\lng().

                                 : void
    {
        $user_field_definitions = ilUserDefinedFields::_getInstance();
        $fields = $this->request->getFields();

        // all fields have to be deletable
        $fail = [];
        foreach ($fields as $id) {
            if (!$this->getPermissions()->hasPermission(
                ilUDFPermissionHelper::CONTEXT_FIELD,
                (string) $id,
                ilUDFPermissionHelper::ACTION_FIELD_DELETE
            )) {
                $field = $user_field_definitions->getDefinition($id);
                $fail[] = $field['field_name'];
            }
        }
        if ($fail) {
            $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('msg_no_perm_delete') . ' ' . implode(', ', $fail), true);
            $this->ctrl->redirect($this, 'listUserDefinedFields');
        }

        foreach ($fields as $id) {
            $user_field_definitions->delete($id);
        }

        $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('udf_field_deleted'), true);
        $this->ctrl->redirect($this);
    }

Here is the call graph for this function:

edit()

ilCustomUserFieldsGUI::edit

(

?ilPropertyFormGUI

$a_form = null

)

Definition at line 482 of file class.ilCustomUserFieldsGUI.php.

References initForm().

Referenced by update().

                                                           : void
    {
        if (!$a_form) {
            $a_form = $this->initForm('edit');
        }

        $this->main_tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilCustomUserFieldsGUI::executeCommand

(

)

Definition at line 87 of file class.ilCustomUserFieldsGUI.php.

References ILIAS\Repository\ctrl().

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

        switch ($next_class) {
            default:
                if (!$cmd) {
                    $cmd = 'listUserDefinedFields';
                }
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

getAccessOptions()

ilCustomUserFieldsGUI::getAccessOptions

(

)

Get all access options, order is kept in forms.

Returns

array<string,string>

Definition at line 137 of file class.ilCustomUserFieldsGUI.php.

References ILIAS\Repository\lng().

Referenced by initForm(), and validateForm().

                                      : array
    {
        $opts = [];
        $opts['visible'] = $this->lng->txt('user_visible_in_profile');
        $opts['visib_reg'] = $this->lng->txt('visible_registration');
        $opts['visib_lua'] = $this->lng->txt('usr_settings_visib_lua');
        $opts['course_export'] = $this->lng->txt('course_export');
        $opts['group_export'] = $this->lng->txt('group_export');
        $opts["prg_export"] = $this->lng->txt("prg_export");
        $opts['changeable'] = $this->lng->txt('changeable');
        $opts['changeable_lua'] = $this->lng->txt('usr_settings_changeable_lua');
        $opts['required'] = $this->lng->txt('required_field');
        $opts['export'] = $this->lng->txt('export');
        $opts['searchable'] = $this->lng->txt('header_searchable');
        $opts['certificate'] = $this->lng->txt('certificate');
        return $opts;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAccessPermissions()

static ilCustomUserFieldsGUI::getAccessPermissions ( )

static

Returns

array<string,string>

Definition at line 158 of file class.ilCustomUserFieldsGUI.php.

References ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_CERTIFICATE, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_CHANGEABLE_LOCAL, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_CHANGEABLE_PERSONAL, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_EXPORT, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_REQUIRED, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_SEARCHABLE, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_COURSES, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_GROUPS, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_LOCAL, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_PERSONAL, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_PRG, and ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_REGISTRATION.

Referenced by ilCustomUserFieldSettingsTableGUI\__construct().

                                                 : array
    {
        return [
            'visible' => ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_PERSONAL,
            'changeable' => ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_CHANGEABLE_PERSONAL,
            'searchable' => ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_SEARCHABLE,
            'required' => ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_REQUIRED,
            'export' => ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_EXPORT,
            'course_export' => ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_COURSES,
            'group_export' => ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_GROUPS,
            'prg_export' => ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_PRG,
            'visib_reg' => ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_REGISTRATION,
            'visib_lua' => ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_LOCAL,
            'changeable_lua' => ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_CHANGEABLE_LOCAL,
            'certificate' => ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_CERTIFICATE
        ];
    }

Here is the caller graph for this function:

getPermissions()

ilCustomUserFieldsGUI::getPermissions ( )

protected

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

References $permissions.

Referenced by deleteField(), and listUserDefinedFields().

                                       : ilClaimingPermissionHelper
    {
        return $this->permissions;
    }

Here is the caller graph for this function:

initFieldDefinition()

ilCustomUserFieldsGUI::initFieldDefinition ( )

protected

Definition at line 176 of file class.ilCustomUserFieldsGUI.php.

References ilMemberAgreement\_hasAgreements(), ilUDFPermissionHelper\ACTION_FIELD_EDIT_ACCESS, ilUDFPermissionHelper\ACTION_FIELD_EDIT_PROPERTY, ilUDFPermissionHelper\CONTEXT_FIELD, ILIAS\Repository\lng(), ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_CERTIFICATE, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_CHANGEABLE_LOCAL, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_CHANGEABLE_PERSONAL, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_EXPORT, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_REQUIRED, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_SEARCHABLE, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_COURSES, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_GROUPS, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_LOCAL, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_PERSONAL, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_PRG, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_REGISTRATION, ilUDFPermissionHelper\SUBACTION_FIELD_PROPERTIES, and ilUDFPermissionHelper\SUBACTION_FIELD_TITLE.

Referenced by initForm().

                                            : array // Missing array type.
    {
        if (ilMemberAgreement::_hasAgreements()) {
            $this->lng->loadLanguageModule('ps');
            $this->main_tpl->setOnScreenMessage('info', $this->lng->txt('ps_warning_modify'));
        }

        $perms = [];
        if ($this->field_definition) {
            $perms = $this->permissions->hasPermissions(
                ilUDFPermissionHelper::CONTEXT_FIELD,
                (string) $this->field_definition['field_id'],
                [
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_PROPERTY,
                        ilUDFPermissionHelper::SUBACTION_FIELD_TITLE
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_PROPERTY,
                        ilUDFPermissionHelper::SUBACTION_FIELD_PROPERTIES
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_PERSONAL
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_REGISTRATION
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_LOCAL
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_COURSES
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_GROUPS
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_PRG
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_CHANGEABLE_PERSONAL
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_CHANGEABLE_LOCAL
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_REQUIRED
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_EXPORT
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_SEARCHABLE
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_CERTIFICATE
                    ]
                ]
            );
        }
        return $perms;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initForm()

ilCustomUserFieldsGUI::initForm ( string  $a_mode = 'create' )

protected

Definition at line 251 of file class.ilCustomUserFieldsGUI.php.

References $id, XapiProxy\$plugin, ilMemberAgreement\_hasAgreements(), ilUDFPermissionHelper\ACTION_FIELD_EDIT_ACCESS, ilUDFPermissionHelper\ACTION_FIELD_EDIT_PROPERTY, ILIAS\Repository\ctrl(), getAccessOptions(), ilCustomUserFieldsHelper\getInstance(), initFieldDefinition(), ILIAS\Repository\lng(), null, ilFormPropertyGUI\setRequired(), ilUDFPermissionHelper\SUBACTION_FIELD_PROPERTIES, ilUDFPermissionHelper\SUBACTION_FIELD_TITLE, UDF_TYPE_SELECT, UDF_TYPE_TEXT, and UDF_TYPE_WYSIWYG.

Referenced by addField(), create(), edit(), and update().

                                                          : ilPropertyFormGUI
    {
        $perms = [];
        $se_mu = null;
        $perm_map = [];
        $udf_type = null;

        if (ilMemberAgreement::_hasAgreements()) {
            $this->lng->loadLanguageModule('ps');
            $this->main_tpl->setOnScreenMessage('info', $this->lng->txt('ps_warning_modify'));
        }

        if ($this->field_definition) {
            $perms = $this->initFieldDefinition();
            $perm_map = self::getAccessPermissions();
        }

        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));

        $name = new ilTextInputGUI($this->lng->txt('field_name'), 'name');
        $name->setRequired(true);
        $form->addItem($name);

        if ($perms && !$perms[ilUDFPermissionHelper::ACTION_FIELD_EDIT_PROPERTY][ilUDFPermissionHelper::SUBACTION_FIELD_TITLE]) {
            $name->setDisabled(true);
        }

        // type
        $radg = new ilRadioGroupInputGUI($this->lng->txt('field_type'), 'field_type');
        $radg->setRequired(true);
        foreach (ilCustomUserFieldsHelper::getInstance()->getUDFTypes() as $udf_type => $udf_name) {
            $op = new ilRadioOption($udf_name, (string) $udf_type);
            $radg->addOption($op);

            switch ($udf_type) {
                case UDF_TYPE_TEXT:
                case UDF_TYPE_WYSIWYG:
                    // do nothing
                    break;
                case UDF_TYPE_SELECT:
                    // select values
                    $se_mu = new ilTextWizardInputGUI($this->lng->txt('value'), 'selvalue');
                    $se_mu->setRequired(true);
                    $se_mu->setSize(32);
                    $se_mu->setMaxLength(128);
                    $se_mu->setValues(['']);
                    $op->addSubItem($se_mu);
                    break;

                default:
                    $plugin = ilCustomUserFieldsHelper::getInstance()->getPluginForType($udf_type);
                    if ($plugin instanceof ilUDFDefinitionPlugin) {
                        $plugin->addDefinitionTypeOptionsToRadioOption($op, $this->field_id);
                    }
                    break;
            }
        }

        $form->addItem($radg);

        if ($perms && !$perms[ilUDFPermissionHelper::ACTION_FIELD_EDIT_PROPERTY][ilUDFPermissionHelper::SUBACTION_FIELD_PROPERTIES]) {
            $se_mu->setDisabled(true);
            $se_mu->setRequired(false);
        }


        // access
        $acc = new ilCheckboxGroupInputGUI($this->lng->txt('access'), 'access');

        $acc_values = [];
        foreach ($this->getAccessOptions() as $id => $caption) {
            $opt = new ilCheckboxOption($caption, $id);
            $acc->addOption($opt);

            if ($this->field_definition && $this->field_definition[$id]) {
                $acc_values[] = $id;
            }

            if ($perms && !$perms[ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS][$perm_map[$id]]) {
                $opt->setDisabled(true);
            }
        }

        $form->addItem($acc);


        if ($a_mode == 'create') {
            $radg->setValue((string) UDF_TYPE_TEXT);
            $form->setTitle($this->lng->txt('add_new_user_defined_field'));
            $form->addCommandButton('create', $this->lng->txt('save'));
        } else {
            $name->setValue($this->field_definition['field_name']);
            $radg->setValue((string) $this->field_definition['field_type']);
            $radg->setDisabled(true);
            $acc->setValue($acc_values);

            switch ($this->field_definition['field_type']) {
                case UDF_TYPE_SELECT:
                    $values = $this->field_definition['field_values'];
                    if (!is_array($values) || $values === []) {
                        $values = [''];
                    }
                    $se_mu->setValue($values);
                    $form->setTitle($this->lng->txt('udf_update_select_field'));
                    break;

                case UDF_TYPE_TEXT:
                    $form->setTitle($this->lng->txt('udf_update_text_field'));
                    break;

                case UDF_TYPE_WYSIWYG:
                    $form->setTitle($this->lng->txt('udf_update_wysiwyg_field'));
                    break;

                default:
                    $plugin = ilCustomUserFieldsHelper::getInstance()->getPluginForType($udf_type);
                    if ($plugin instanceof ilUDFDefinitionPlugin) {
                        $form->setTitle($plugin->getDefinitionUpdateFormTitle());
                    }
                    break;
            }
            $form->addCommandButton('update', $this->lng->txt('save'));
        }
        $form->addCommandButton('listUserDefinedFields', $this->lng->txt('cancel'));
        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listUserDefinedFields()

ilCustomUserFieldsGUI::listUserDefinedFields

(

)

Definition at line 102 of file class.ilCustomUserFieldsGUI.php.

References ilUDFPermissionHelper\ACTION_UDF_CREATE_FIELD, ilUDFPermissionHelper\CONTEXT_UDF, ILIAS\Repository\ctrl(), getPermissions(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

Referenced by askDeleteField(), and updateFields().

                                           : void
    {
        if ($this->getPermissions()->hasPermission(
            ilUDFPermissionHelper::CONTEXT_UDF,
            (string) $this->ref_id,
            ilUDFPermissionHelper::ACTION_UDF_CREATE_FIELD
        )) {
            $this->toolbar->addComponent(
                $this->ui_factory->link()->standard(
                    $this->lng->txt('add_user_defined_field'),
                    $this->ctrl->getLinkTarget($this, 'addField')
                )
            );
        }

        $tab = new ilCustomUserFieldSettingsTableGUI($this, 'listUserDefinedFields', $this->getPermissions());
        if ($this->confirm_change) {
            $tab->setConfirmChange();
        }
        $this->main_tpl->setContent($tab->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilCustomUserFieldsGUI::update

(

)

Definition at line 491 of file class.ilCustomUserFieldsGUI.php.

References XapiProxy\$plugin, ilUserDefinedFields\_getInstance(), ilMemberAgreement\_reset(), ilUDFPermissionHelper\ACTION_FIELD_EDIT_ACCESS, ilUDFPermissionHelper\ACTION_FIELD_EDIT_PROPERTY, ilUDFPermissionHelper\CONTEXT_FIELD, ILIAS\Repository\ctrl(), ilUserDefinedData\deleteFieldValue(), edit(), ilCustomUserFieldsHelper\getInstance(), initForm(), ILIAS\Repository\lng(), null, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_CERTIFICATE, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_CHANGEABLE_LOCAL, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_CHANGEABLE_PERSONAL, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_EXPORT, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_REQUIRED, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_SEARCHABLE, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_COURSES, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_GROUPS, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_LOCAL, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_PERSONAL, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_PRG, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_REGISTRATION, ilUDFPermissionHelper\SUBACTION_FIELD_PROPERTIES, ilUDFPermissionHelper\SUBACTION_FIELD_TITLE, UDF_TYPE_SELECT, and validateForm().

                            : void
    {
        $perms = [];

        $user_field_definitions = ilUserDefinedFields::_getInstance();
        $user_field_definitions->setFieldType($this->field_definition['field_type']);

        // gather old select options
        $old_options = null;
        if ($this->field_id) {
            $old_values = $user_field_definitions->getDefinition($this->field_id);
            if ($old_values['field_type'] == UDF_TYPE_SELECT) {
                $old_options = $old_values['field_values'];
            }

            $perms = $this->permissions->hasPermissions(
                ilUDFPermissionHelper::CONTEXT_FIELD,
                (string) $this->field_id,
                [
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_PROPERTY,
                        ilUDFPermissionHelper::SUBACTION_FIELD_TITLE
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_PROPERTY,
                        ilUDFPermissionHelper::SUBACTION_FIELD_PROPERTIES
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_PERSONAL
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_REGISTRATION
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_LOCAL
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_COURSES
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_GROUPS
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_PRG
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_CHANGEABLE_PERSONAL
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_CHANGEABLE_LOCAL
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_REQUIRED
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_EXPORT
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_SEARCHABLE
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_CERTIFICATE
                    ]
                ]
            );
        }

        $access = [];
        $form = $this->initForm('edit');
        if ($this->validateForm($form, $user_field_definitions, $access, $perms) && $this->field_id) {
            // field values are set in validateForm()...

            if (!$perms || $perms[ilUDFPermissionHelper::ACTION_FIELD_EDIT_PROPERTY][ilUDFPermissionHelper::SUBACTION_FIELD_PROPERTIES]) {
                // diff old select options against new to handle deleted values properly
                if (is_array($old_options)) {
                    foreach ($old_options as $old_option) {
                        if (!in_array($old_option, $user_field_definitions->getFieldValues())) {
                            ilUserDefinedData::deleteFieldValue($this->field_id, $old_option);
                        }
                    }
                }
            }
            // disabled fields
            elseif (is_array($old_options)) {
                $user_field_definitions->setFieldValues($old_options);
            }

            if (!$perms || $perms[ilUDFPermissionHelper::ACTION_FIELD_EDIT_PROPERTY][ilUDFPermissionHelper::SUBACTION_FIELD_TITLE]) {
                $user_field_definitions->setFieldName($form->getInput('name'));
            } else {
                $user_field_definitions->setFieldName($this->field_definition['field_name']);
            }

            $user_field_definitions->enableVisible($access['visible']);
            $user_field_definitions->enableVisibleRegistration($access['visib_reg']);
            $user_field_definitions->enableVisibleLocalUserAdministration($access['visib_lua']);
            $user_field_definitions->enableCourseExport($access['course_export']);
            $user_field_definitions->enableGroupExport($access['group_export']);
            $user_field_definitions->enablePrgExport($access['prg_export']);
            $user_field_definitions->enableChangeable($access['changeable']);
            $user_field_definitions->enableChangeableLocalUserAdministration($access['changeable_lua']);
            $user_field_definitions->enableRequired($access['required']);
            $user_field_definitions->enableExport($access['export']);
            $user_field_definitions->enableSearchable($access['searchable']);
            $user_field_definitions->enableCertificate($access['certificate']);
            $user_field_definitions->update($this->field_id);

            if ($user_field_definitions->isPluginType()) {
                $plugin = ilCustomUserFieldsHelper::getInstance()->getPluginForType($user_field_definitions->getFieldType());
                if ($plugin instanceof ilUDFDefinitionPlugin) {
                    $plugin->updateDefinitionFromForm($form, $this->field_id);
                }
            }

            if ($access['course_export']) {
                ilMemberAgreement::_reset();
            }

            $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
            $this->ctrl->redirect($this);
        }

        $form->setValuesByPost();
        $this->edit($form);
    }

Here is the call graph for this function:

updateFields()

ilCustomUserFieldsGUI::updateFields

(

string

$action = ''

)

Update custom fields properties (from table gui)

Definition at line 688 of file class.ilCustomUserFieldsGUI.php.

References $field_id, $valid, ilUserDefinedFields\_getInstance(), ilUDFPermissionHelper\ACTION_FIELD_EDIT_ACCESS, ilUDFPermissionHelper\CONTEXT_FIELD, ILIAS\Repository\ctrl(), listUserDefinedFields(), ILIAS\Repository\lng(), ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_CERTIFICATE, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_CHANGEABLE_LOCAL, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_CHANGEABLE_PERSONAL, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_EXPORT, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_REQUIRED, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_SEARCHABLE, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_COURSES, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_GROUPS, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_LOCAL, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_PERSONAL, ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_PRG, and ilUDFPermissionHelper\SUBACTION_FIELD_ACCESS_VISIBLE_REGISTRATION.

                                                     : void
    {
        $user_field_definitions = ilUserDefinedFields::_getInstance();
        $a_fields = $user_field_definitions->getDefinitions();

        $checked = $this->request->getChecked();

        $perm_map = self::getAccessPermissions();

        foreach ($a_fields as $field_id => $definition) {
            $perms = $this->permissions->hasPermissions(
                ilUDFPermissionHelper::CONTEXT_FIELD,
                (string) $field_id,
                [
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_PERSONAL
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_REGISTRATION
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_LOCAL
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_COURSES
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_GROUPS
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_VISIBLE_PRG
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_CHANGEABLE_PERSONAL
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_CHANGEABLE_LOCAL
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_REQUIRED
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_EXPORT
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_SEARCHABLE
                    ],
                    [
                        ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS,
                        ilUDFPermissionHelper::SUBACTION_FIELD_ACCESS_CERTIFICATE
                    ]
                ]
            );

            // disabled field
            foreach ($perm_map as $prop => $perm) {
                if (!$perms[ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS][$perm]) {
                    $checked[$prop . '_' . $field_id] = $definition[$prop];
                }
            }
        }

        $valid = true;
        foreach ($a_fields as $field_id => $definition) {
            if (isset($checked['required_' . $field_id]) && (int) $checked['required_' . $field_id] &&
                (!isset($checked['visib_reg_' . $field_id]) || !(int) $checked['visib_reg_' . $field_id])) {
                $this->confirm_change = true;

                $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('invalid_visible_required_options_selected'));
                $valid = false;
            }
        }

        if (!$valid) {
            $this->listUserDefinedFields();
            return;
        }

        foreach ($a_fields as $field_id => $definition) {
            $user_field_definitions->setFieldName($definition['field_name']);
            $user_field_definitions->setFieldType($definition['field_type']);
            $user_field_definitions->setFieldValues($definition['field_values']);
            $user_field_definitions->enableVisible((bool) ($checked['visible_' . $field_id] ?? false));
            $user_field_definitions->enableChangeable((bool) ($checked['changeable_' . $field_id] ?? false));
            $user_field_definitions->enableRequired((bool) ($checked['required_' . $field_id] ?? false));
            $user_field_definitions->enableSearchable((bool) ($checked['searchable_' . $field_id] ?? false));
            $user_field_definitions->enableExport((bool) ($checked['export_' . $field_id] ?? false));
            $user_field_definitions->enableCourseExport((bool) ($checked['course_export_' . $field_id] ?? false));
            $user_field_definitions->enableVisibleLocalUserAdministration((bool) ($checked['visib_lua_' . $field_id] ?? false));
            $user_field_definitions->enableChangeableLocalUserAdministration((bool) ($checked['changeable_lua_' . $field_id] ?? false));
            $user_field_definitions->enableGroupExport((bool) ($checked['group_export_' . $field_id] ?? false));
            $user_field_definitions->enableVisibleRegistration((bool) ($checked['visib_reg_' . $field_id] ?? false));
            $user_field_definitions->enableCertificate((bool) ($checked['certificate_' . $field_id] ?? false));
            $user_field_definitions->enablePrgExport((bool) ($checked['prg_export_' . $field_id] ?? false));

            $user_field_definitions->update($field_id);
        }

        $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
        $this->ctrl->redirect($this);
    }

Here is the call graph for this function:

validateForm()

ilCustomUserFieldsGUI::validateForm ( ilPropertyFormGUI  $form, ilUserDefinedFields  $user_field_definitions, array &  $access, ?array  $a_field_permissions = null  )

protected

Definition at line 379 of file class.ilCustomUserFieldsGUI.php.

References $id, $valid, ilUDFPermissionHelper\ACTION_FIELD_EDIT_ACCESS, ilUDFPermissionHelper\ACTION_FIELD_EDIT_PROPERTY, ilPropertyFormGUI\checkInput(), getAccessOptions(), ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), ILIAS\Repository\lng(), ilUserDefinedFields\nameExists(), ilUserDefinedFields\setFieldValues(), ilUDFPermissionHelper\SUBACTION_FIELD_PROPERTIES, UDF_DUPLICATE_VALUES, UDF_TYPE_SELECT, and ilUserDefinedFields\validateValues().

Referenced by create(), and update().

     : bool {
        $perm_map = [];

        if ($form->checkInput()) {
            $valid = true;

            $incoming = (array) $form->getInput('access');

            if ($a_field_permissions) {
                $perm_map = self::getAccessPermissions();
            }

            $access = [];
            foreach (array_keys($this->getAccessOptions()) as $id) {
                $access[$id] = in_array($id, $incoming);

                // disabled fields
                if ($a_field_permissions && !$a_field_permissions[ilUDFPermissionHelper::ACTION_FIELD_EDIT_ACCESS][$perm_map[$id]]) {
                    $access[$id] = $this->field_definition[$id];
                }
            }

            if ($access['required'] && !$access['visib_reg']) {
                $this->confirm_change = true;
                $form->getItemByPostVar('access')->setAlert($this->lng->txt('udf_required_requires_visib_reg'));
                $valid = false;
            }

            if (!$this->field_id && $user_field_definitions->nameExists($form->getInput('name'))) {
                $form->getItemByPostVar('name')->setAlert($this->lng->txt('udf_name_already_exists'));
                $valid = false;
            }

            if ($form->getInput('field_type') == UDF_TYPE_SELECT &&
                (!$a_field_permissions || $a_field_permissions[ilUDFPermissionHelper::ACTION_FIELD_EDIT_PROPERTY][ilUDFPermissionHelper::SUBACTION_FIELD_PROPERTIES])) {
                $user_field_definitions->setFieldValues($form->getInput('selvalue'));
                if ($error = $user_field_definitions->validateValues()) {
                    switch ($error) {
                        case UDF_DUPLICATE_VALUES:
                            $form->getItemByPostVar('selvalue')->setAlert($this->lng->txt('udf_duplicate_entries'));
                            $valid = false;
                            break;
                    }
                }
            }

            if (!$valid) {
                $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('form_input_not_valid'));
            }
            return $valid;
        }

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$confirm_change

bool ilCustomUserFieldsGUI::$confirm_change = false

private

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

$ctrl

ilCtrlInterface ilCustomUserFieldsGUI::$ctrl

private

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

$field_definition

array ilCustomUserFieldsGUI::$field_definition = []

private

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

$field_id

int ilCustomUserFieldsGUI::$field_id = 0

private

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

Referenced by updateFields().

$lng

Language ilCustomUserFieldsGUI::$lng

private

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

$main_tpl

ilGlobalTemplateInterface ilCustomUserFieldsGUI::$main_tpl

private

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

$permissions

ilClaimingPermissionHelper ilCustomUserFieldsGUI::$permissions

private

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

Referenced by getPermissions().

$ref_id

int ilCustomUserFieldsGUI::$ref_id = 0

private

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

Referenced by __construct().

$request

UserGUIRequest ilCustomUserFieldsGUI::$request

private

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

$toolbar

ilToolbarGUI ilCustomUserFieldsGUI::$toolbar

private

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

$ui_factory

UIFactory ilCustomUserFieldsGUI::$ui_factory

private

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

---

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

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