ilCustomUserFieldsHelper Class Reference

Description of class class. More...

Collaboration diagram for ilCustomUserFieldsHelper:

Public Member Functions
	__construct ()
	getUDFTypes ()
	Get udf types. More...
	getPluginForType ($a_type)
	Get plugin for udf type. More...
	getActivePlugins ()
	Get plugins for fields. More...
	getFormPropertyForDefinition ($definition, $a_changeable=true, $a_default_value=null)
	Get form property for definition. More...

Static Public Member Functions
static	getInstance ()
	Get instance. More...

Private Attributes
	$lng = null
	$plugin_admin = null
	$logger = null

Static Private Attributes
static	$instance = null

Detailed Description

Description of class class.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilCustomUserFieldsHelper::__construct

(

)

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

References $DIC.

    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->logger = $DIC->logger()->usr();
        $this->plugin_admin = $DIC['ilPluginAdmin'];
    }

Member Function Documentation

getActivePlugins()

ilCustomUserFieldsHelper::getActivePlugins

(

)

Get plugins for fields.

Parameters

array

$def_ids

Returns

ilUDFDefinitionPlugin[]

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

References XapiProxy\$plugin, ilUDFDefinitionPlugin\UDF_C_NAME, ilUDFDefinitionPlugin\UDF_C_TYPE, and ilUDFDefinitionPlugin\UDF_SLOT_ID.

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

    {
        $plugins = array();

        include_once './Services/User/classes/class.ilUDFDefinitionPlugin.php';
        foreach (
            $this->plugin_admin->getActivePluginsForSlot(
                ilUDFDefinitionPlugin::UDF_C_TYPE,
                ilUDFDefinitionPlugin::UDF_C_NAME,
                ilUDFDefinitionPlugin::UDF_SLOT_ID
            )
            as $plugin) {
            $plug = $this->plugin_admin->getPluginObject(
                ilUDFDefinitionPlugin::UDF_C_TYPE,
                ilUDFDefinitionPlugin::UDF_C_NAME,
                ilUDFDefinitionPlugin::UDF_SLOT_ID,
                $plugin
            );
            if ($plug instanceof ilUDFDefinitionPlugin) {
                $plugins[] = $plug;
            }
        }
        return $plugins;
    }

Here is the caller graph for this function:

getFormPropertyForDefinition()

ilCustomUserFieldsHelper::getFormPropertyForDefinition	(		$definition,
			$a_changeable = true,
			$a_default_value = null
	)

Get form property for definition.

Parameters

array

$definition

Returns

ilFormPropertyGUI

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

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

    {
        $fprop = null;

        switch ($definition['field_type']) {
            case UDF_TYPE_TEXT:
                $fprop = new ilTextInputGUI(
                    $definition['field_name'],
                    'udf_' . $definition['field_id']
                );
                $fprop->setValue($a_default_value);
                $fprop->setSize(40);
                $fprop->setMaxLength(255);
                $fprop->setRequired($definition['required'] ? true : false);
                if (!$a_changeable && (!$definition['required'] || $a_default_value)) {
                    $fprop->setDisabled(true);
                }
                break;

            case UDF_TYPE_WYSIWYG:
                $fprop = new ilTextAreaInputGUI(
                    $definition['field_name'],
                    'udf_' . $definition['field_id']
                );
                $fprop->setValue($a_default_value);
                $fprop->setUseRte(true);
                $fprop->setRequired($definition['required'] ? true : false);
                if (!$a_changeable && (!$definition['required'] || $a_default_value)) {
                    $fprop->setDisabled(true);
                }
                break;

            case UDF_TYPE_SELECT:
                $fprop = new ilSelectInputGUI(
                    $definition['field_name'],
                    'udf_' . $definition['field_id']
                );

                include_once './Services/User/classes/class.ilUserDefinedFields.php';
                $user_defined_fields = ilUserDefinedFields::_getInstance();

                $fprop->setOptions($user_defined_fields->fieldValuesToSelectArray($definition['field_values']));
                $fprop->setValue($a_default_value);
                $fprop->setRequired($definition['required'] ? true : false);
                if (!$a_changeable && (!$definition['required'] || $a_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, $a_changeable, $a_default_value);
                        break;
                    }
                }
                break;
        }

        return $fprop;
    }

Here is the call graph for this function:

getInstance()

static ilCustomUserFieldsHelper::getInstance ( )

static

Get instance.

Returns

ilCustomUserFieldsHelper

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

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

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

Here is the caller graph for this function:

getPluginForType()

ilCustomUserFieldsHelper::getPluginForType

(

$a_type

)

Get plugin for udf type.

Returns

ilUDFDefinitionPlugin

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

References XapiProxy\$plugin, and getActivePlugins().

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

Here is the call graph for this function:

getUDFTypes()

ilCustomUserFieldsHelper::getUDFTypes

(

)

Get udf types.

Returns

type

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

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

    {
        $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')
        );
        include_once './Services/User/classes/class.ilUDFDefinitionPlugin.php';
        foreach ($this->getActivePlugins() as $plugin) {
            $types[$plugin->getDefinitionType()] = $plugin->getDefinitionTypeName();
        }
        return $types;
    }

Here is the call graph for this function:

Field Documentation

$instance

ilCustomUserFieldsHelper::$instance = null

staticprivate

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

$lng

ilCustomUserFieldsHelper::$lng = null

private

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

$logger

ilCustomUserFieldsHelper::$logger = null

private

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

$plugin_admin

ilCustomUserFieldsHelper::$plugin_admin = null

private

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

---

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

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