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

Collaboration diagram for ilCustomUserFieldsHelper:

Public Member Functions
	__construct ()

	getUDFTypes ()

	getPluginForType (string $a_type)
	Get plugin for udf type. More...

	getActivePlugins ()
	Get plugins for fields. More...

	getFormPropertyForDefinition (array $definition, bool $changeable=true, string $a_default_value=null)
	Get form property for definition. More...

Static Public Member Functions
static	getInstance ()

Protected Attributes
ilComponentRepository	$component_repository

ilComponentFactory	$component_factory

Private Attributes
ilLanguage	$lng

Static Private Attributes
static ilCustomUserFieldsHelper	$instance = null

Detailed Description

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

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

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

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

◆ __construct()

ilCustomUserFieldsHelper::__construct ( )

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

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->component_repository = $DIC['component.repository'];
        $this->component_factory = $DIC['component.factory'];
    }

References $DIC, and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ getActivePlugins()

ilCustomUserFieldsHelper::getActivePlugins ( )

Get plugins for fields.

Returns: ilUDFDefinitionPlugin[]

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

                                      : array
    {
        return iterator_to_array($this->component_factory->getActivePluginsInSlot(ilUDFDefinitionPlugin::UDF_SLOT_ID));
    }

References ilUDFDefinitionPlugin\UDF_SLOT_ID.

Referenced by getFormPropertyForDefinition(), getPluginForType(), and getUDFTypes().

Here is the caller graph for this function:

◆ getFormPropertyForDefinition()

ilCustomUserFieldsHelper::getFormPropertyForDefinition	(	array	$definition,
		bool	$changeable = `true`,
		string	$a_default_value = `null`
	)

Get form property for definition.

Definition at line 90 of file class.ilCustomUserFieldsHelper.php.

     : ?ilFormPropertyGUI {
        $fprop = null;
        $default_value = $a_default_value ?? '';
 
        switch ($definition['field_type']) {
            case UDF_TYPE_TEXT:
                $fprop = new ilTextInputGUI(
                    $definition['field_name'],
                    'udf_' . $definition['field_id']
                );
 
                $fprop->setValue($default_value);
                $fprop->setSize(40);
                $fprop->setMaxLength(255);
                $fprop->setRequired((bool) $definition['required']);
                if (!$changeable && (!$definition['required'] || $default_value !== '')) {
                    $fprop->setDisabled(true);
                }
                break;
 
            case UDF_TYPE_WYSIWYG:
                $fprop = new ilTextAreaInputGUI(
                    $definition['field_name'],
                    'udf_' . $definition['field_id']
                );
 
                $fprop->setValue($default_value);
                $fprop->setUseRte(true);
                $fprop->setRequired((bool) $definition['required']);
                if (!$changeable && (!$definition['required'] || $default_value !== '')) {
                    $fprop->setDisabled(true);
                }
                break;
 
            case UDF_TYPE_SELECT:
                $fprop = new ilSelectInputGUI(
                    $definition['field_name'],
                    'udf_' . $definition['field_id']
                );
 
                $user_defined_fields = ilUserDefinedFields::_getInstance();
 
                $fprop->setOptions($user_defined_fields->fieldValuesToSelectArray($definition['field_values']));
                $fprop->setValue($default_value);
                $fprop->setRequired((bool) $definition['required']);
                if (!$changeable && (!$definition['required'] || $default_value !== '')) {
                    $fprop->setDisabled(true);
                }
                break;
 
            default:
                // should be a plugin
                foreach ($this->getActivePlugins() as $plugin) {
                    if ($plugin->getDefinitionType() == $definition['field_type']) {
                        $fprop = $plugin->getFormPropertyForDefinition(
                            $definition,
                            $changeable,
                            $a_default_value
                        );
                        break;
                    }
                }
                break;
        }
 
        return $fprop;
    }

References XapiProxy\$plugin, ilUserDefinedFields\_getInstance(), getActivePlugins(), UDF_TYPE_SELECT, UDF_TYPE_TEXT, and UDF_TYPE_WYSIWYG.

Here is the call graph for this function:

◆ getInstance()

static ilCustomUserFieldsHelper::getInstance ( )

static

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

                                        : ilCustomUserFieldsHelper
    {
        if (self::$instance) {
            return self::$instance;
        }
        return self::$instance = new self();
    }

References $instance.

Referenced by ilCustomUserFieldsGUI\create(), ilAccountRegistrationGUI\initForm(), ilObjUserGUI\initForm(), ilCustomUserFieldsGUI\initForm(), ilPersonalProfileGUI\initPersonalDataForm(), ilUserDefinedData\lookupData(), and ilCustomUserFieldsGUI\update().

Here is the caller graph for this function:

◆ getPluginForType()

ilCustomUserFieldsHelper::getPluginForType ( string $a_type )

Get plugin for udf type.

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

                                                    : ?ilUDFDefinitionPlugin
    {
        foreach ($this->getActivePlugins() as $plugin) {
            if ($plugin->getDefinitionType() == $a_type) {
                return $plugin;
            }
        }
        return null;
    }

References XapiProxy\$plugin, and getActivePlugins().

Here is the call graph for this function:

◆ getUDFTypes()

ilCustomUserFieldsHelper::getUDFTypes ( )

Returns: array<int,string>

Definition at line 52 of file class.ilCustomUserFieldsHelper.php.

                                 : array
    {
        $types = array(
            UDF_TYPE_TEXT => $this->lng->txt('udf_type_text'),
            UDF_TYPE_SELECT => $this->lng->txt('udf_type_select'),
            UDF_TYPE_WYSIWYG => $this->lng->txt('udf_type_wysiwyg')
        );
        foreach ($this->getActivePlugins() as $plugin) {
            $types[$plugin->getDefinitionType()] = $plugin->getDefinitionTypeName();
        }
        return $types;
    }