class.ilCustomUserFieldsHelper.php

Go to the documentation of this file.

<?php

// still needed, since constants are defined in ilUserDefinedFields
include_once("./Services/User/classes/class.ilUserDefinedFields.php");

class ilCustomUserFieldsHelper
{
    private static ?ilCustomUserFieldsHelper $instance = null;
    private ilLanguage $lng;
    protected ilComponentRepository $component_repository;
    protected ilComponentFactory $component_factory;

    public function __construct()
    {
        global $DIC;

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

    public static function getInstance(): ilCustomUserFieldsHelper
    {
        if (self::$instance) {
            return self::$instance;
        }
        return self::$instance = new self();
    }

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

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

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

    public function getFormPropertyForDefinition(
        array $definition,
        bool $changeable = true,
        string $a_default_value = null
    ): ?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;
    }
}