ilUserDefinedFields Class Reference

Additional user data fields definition. More...

Collaboration diagram for ilUserDefinedFields:

Public Member Functions
	fetchFieldIdFromImportId (string $a_import_id)
	fetchFieldIdFromName (string $a_name)
	getDefinitions ()
	getDefinition (int $a_id)
	getVisibleDefinitions ()
	getLocalUserAdministrationDefinitions ()
	getChangeableLocalUserAdministrationDefinitions ()
	getRegistrationDefinitions ()
	getSearchableDefinitions ()
	getRequiredDefinitions ()
	getCourseExportableFields ()
	getGroupExportableFields ()
	getExportableFields (int $a_obj_id)
	Get exportable field. More...
	setFieldName (string $a_name)
	getFieldName ()
	setFieldType (int $a_type)
	isPluginType ()
	getFieldType ()
	setFieldValues (array $a_values)
	getFieldValues ()
	enableVisible (bool $a_visible)
	enabledVisible ()
	enableVisibleLocalUserAdministration (bool $a_visible)
	enabledVisibleLocalUserAdministration ()
	enableChangeable (bool $a_changeable)
	enabledChangeable ()
	enableChangeableLocalUserAdministration (bool $a_changeable)
	enabledChangeableLocalUserAdministration ()
	enableRequired (bool $a_required)
	enabledRequired ()
	enableSearchable (bool $a_searchable)
	enabledSearchable ()
	enableExport (bool $a_export)
	enabledExport ()
	enableCourseExport (bool $a_course_export)
	enabledCourseExport ()
	enableGroupExport (bool $a_group_export)
	enabledGroupExport ()
	enableCertificate (bool $a_c)
	enabledCertificate ()
	enableVisibleRegistration (bool $a_visible_registration)
	enabledVisibleRegistration ()
	fieldValuesToSelectArray (array $a_values, bool $a_with_selection_info=true)
	validateValues ()
	nameExists (string $a_field_name)
	add ()
	delete (int $a_id)
	update (int $a_id)
	deleteValue (int $a_field_id, int $a_value_id)
	toXML ()
	addToXML (ilXmlWriter $xml_writer)
	add user defined field data to xml (using usr dtd) More...

Static Public Member Functions
static	_getInstance ()
static	_newInstance ()

Data Fields
ilDBInterface	$db = null
array	$definitions = array()

Protected Member Functions
	__read ()

Protected Attributes
bool	$field_certificate = false
bool	$field_group_export = false
bool	$field_course_export = false
bool	$field_export = false
bool	$field_searchable = false
bool	$field_required = false
bool	$field_changeable_lua = false
bool	$field_changeable = false
bool	$field_visib_lua = false
array	$field_values = []
int	$field_type = 0
string	$field_name = ""
bool	$field_visible = false

Private Member Functions
	__construct ()

Private Attributes
int	$field_visible_registration = 0

Detailed Description

Additional user data fields definition.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

__construct()

ilUserDefinedFields::__construct ( )

private

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

References $DIC, and __read().

    {
        global $DIC;

        $this->db = $DIC->database();
        $this->__read();
    }

Here is the call graph for this function:

Member Function Documentation

__read()

ilUserDefinedFields::__read ( )

protected

Definition at line 520 of file class.ilUserDefinedFields.php.

References $DIC, $ilSetting, $query, $res, ilDBConstants\FETCHMODE_OBJECT, and ilArrayUtil\sortArray().

Referenced by __construct(), add(), delete(), deleteValue(), and update().

                               : void
    {
        global $DIC;

        $ilSetting = $DIC['ilSetting'];

        $query = "SELECT * FROM udf_definition ";
        $res = $this->db->query($query);

        $this->definitions = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->definitions[$row->field_id]['field_id'] = $row->field_id;
            $this->definitions[$row->field_id]['field_name'] = $row->field_name;
            $this->definitions[$row->field_id]['field_type'] = $row->field_type;
            $this->definitions[$row->field_id]['il_id'] = 'il_' . $ilSetting->get('inst_id', '0') . '_udf_' . $row->field_id;

            // #16953
            $tmp = $sort = array();
            $is_numeric = true;
            foreach ((array) unserialize($row->field_values, ['allowed_classes' => false]) as $item) {
                if (!is_numeric($item)) {
                    $is_numeric = false;
                }
                $sort[] = array("value" => $item);
            }
            foreach (ilArrayUtil::sortArray($sort, "value", "asc", $is_numeric) as $item) {
                $tmp[] = $item["value"];
            }

            $this->definitions[$row->field_id]['field_values'] = $tmp;
            $this->definitions[$row->field_id]['visible'] = $row->visible;
            $this->definitions[$row->field_id]['changeable'] = $row->changeable;
            $this->definitions[$row->field_id]['required'] = $row->required;
            $this->definitions[$row->field_id]['searchable'] = $row->searchable;
            $this->definitions[$row->field_id]['export'] = $row->export;
            $this->definitions[$row->field_id]['course_export'] = $row->course_export;
            $this->definitions[$row->field_id]['visib_reg'] = $row->registration_visible;
            $this->definitions[$row->field_id]['visib_lua'] = $row->visible_lua;
            $this->definitions[$row->field_id]['changeable_lua'] = $row->changeable_lua;
            $this->definitions[$row->field_id]['group_export'] = $row->group_export;
            $this->definitions[$row->field_id]['certificate'] = $row->certificate;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getInstance()

static ilUserDefinedFields::_getInstance ( )

static

Definition at line 59 of file class.ilUserDefinedFields.php.

Referenced by ilUserSearchOptions\__appendUserDefinedFields(), ilObjUserGUI\__checkUserDefinedRequiredFields(), ilUserDefinedFieldsPlaceholderDescription\__construct(), ilUserDefinedFieldsPlaceholderValues\__construct(), ilCustomUserFieldSettingsTableGUI\__construct(), ilCustomUserFieldsGUI\__construct(), ilPersonalSettingsGUI\__construct(), ilObjUserGUI\__showUserDefinedFields(), ilMemberAgreementGUI\addExportFieldInfo(), ilUserDefinedData\addToXML(), ilCustomUserFieldsGUI\askDeleteField(), ilAuthProviderSaml\buildUserAttributeXml(), ilCustomUserFieldsGUI\create(), ilCertificateUserDefinedFieldsHelper\createInstance(), ilCustomUserFieldsGUI\deleteField(), ilObjUser\deleteUserDefinedFieldEntries(), ilLDAPSettingsGUI\getAttributeMappingKeys(), ilPublicUserProfileGUI\getEmbeddable(), ilCustomUserFieldsHelper\getFormPropertyForDefinition(), ilAttendanceList\getNonMemberUserData(), ilMemberExport\getOrderedExportableFields(), ilExportFieldsInfo\getSelectableFieldsInfo(), ilLPTableBaseGUI\getSelectableUserColumns(), ilSamlSettingsGUI\getUserAttributeMappingForm(), ilObjUserFolder\getUserDefinedExportFields(), ilObjUserGUI\getValues(), ilObjUserGUI\handleIgnoredRequiredFields(), ilUserImportParser\importEndTag(), ilMemberExportSettingsGUI\initForm(), ilAccountRegistrationGUI\initForm(), ilObjUserGUI\initForm(), ILIAS\MyStaff\ListUsers\ilMStListUsersTableGUI\initSelectableColumns(), ilMemberExportGUI\initSettingsForm(), ilLDAPAttributeToUser\initUserDefinedFields(), ilLDAPSettingsGUI\initUserDefinedFields(), ilUserProfile\isProfileIncomplete(), ilObjUserGUI\loadUserDefinedDataFromForm(), ilUserQuery\query(), ilAttendanceList\readOrderedExportableFields(), ilUserTableGUI\readUserDefinedFieldsDefinitions(), ilAccountRegistrationGUI\saveForm(), ilSamlSettingsGUI\saveUserAttributeMapping(), ilUserQuery\setUdfFilter(), ilUserXMLWriter\start(), ilUserDefinedData\update(), ilCustomUserFieldsGUI\update(), ilCustomUserFieldsGUI\updateFields(), and ilMemberExport\write().

                                         : self
    {
        static $udf = null;

        if (!is_object($udf)) {
            return $udf = new ilUserDefinedFields();
        }
        return $udf;
    }

Here is the caller graph for this function:

_newInstance()

static ilUserDefinedFields::_newInstance ( )

static

Definition at line 640 of file class.ilUserDefinedFields.php.

                                         : self
    {
        static $udf = null;
        return $udf = new ilUserDefinedFields();
    }

add()

ilUserDefinedFields::add

(

)

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

References $DIC, $ilDB, __read(), enabledCertificate(), enabledChangeable(), enabledChangeableLocalUserAdministration(), enabledCourseExport(), enabledExport(), enabledGroupExport(), enabledRequired(), enabledSearchable(), enabledVisible(), enabledVisibleLocalUserAdministration(), enabledVisibleRegistration(), getFieldName(), getFieldType(), and getFieldValues().

                         : int
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        // Add definition entry
        $next_id = $ilDB->nextId('udf_definition');

        $values = array(
            'field_id' => array('integer',$next_id),
            'field_name' => array('text',$this->getFieldName()),
            'field_type' => array('integer', $this->getFieldType()),
            'field_values' => array('clob',serialize($this->getFieldValues())),
            'visible' => array('integer', (int) $this->enabledVisible()),
            'changeable' => array('integer', (int) $this->enabledChangeable()),
            'required' => array('integer', (int) $this->enabledRequired()),
            'searchable' => array('integer', (int) $this->enabledSearchable()),
            'export' => array('integer', (int) $this->enabledExport()),
            'course_export' => array('integer', (int) $this->enabledCourseExport()),
            'registration_visible' => array('integer', (int) $this->enabledVisibleRegistration()),
            'visible_lua' => array('integer', (int) $this->enabledVisibleLocalUserAdministration()),
            'changeable_lua' => array('integer', (int) $this->enabledChangeableLocalUserAdministration()),
            'group_export' => array('integer', (int) $this->enabledGroupExport()),
            'certificate' => array('integer', (int) $this->enabledCertificate()),
        );

        $ilDB->insert('udf_definition', $values);

        // add table field in usr_defined_data
        $field_id = $next_id;


        $this->__read();

        return $field_id;
    }

Here is the call graph for this function:

addToXML()

ilUserDefinedFields::addToXML

(

ilXmlWriter

$xml_writer

)

add user defined field data to xml (using usr dtd)

Definition at line 607 of file class.ilUserDefinedFields.php.

References $attributes, getDefinitions(), UDF_TYPE_SELECT, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by toXML().

                                                     : void
    {
        $xml_writer->xmlStartTag("UDFDefinitions");
        foreach ($this->getDefinitions() as $definition) {
            $attributes = array(
                "Id" => $definition ["il_id"],
                "Type" => $definition["field_type"] == UDF_TYPE_SELECT ? "SELECT" : "TEXT",
                "Visible" => $definition["visible"] ? "TRUE" : "FALSE",
                "Changeable" => $definition["changeable"] ? "TRUE" : "FALSE",
                "Required" => $definition["required"] ? "TRUE" : "FALSE",
                "Searchable" => $definition["searchable"] ? "TRUE" : "FALSE",
                "CourseExport" => $definition["course_export"] ? "TRUE" : "FALSE",
                "GroupExport" => $definition["group_export"] ? "TRUE" : "FALSE",
                "Certificate" => $definition["certificate"] ? "TRUE" : "FALSE",
                "Export" => $definition["export"] ? "TRUE" : "FALSE",
                "RegistrationVisible" => $definition["visib_reg"] ? "TRUE" : "FALSE",
                "LocalUserAdministrationVisible" => $definition["visib_lua"] ? "TRUE" : "FALSE",
                "LocalUserAdministrationChangeable" => $definition["changeable_lua"] ? "TRUE" : "FALSE",

            );
            $xml_writer->xmlStartTag("UDFDefinition", $attributes);
            $xml_writer->xmlElement('UDFName', null, $definition['field_name']);
            if ($definition["field_type"] == UDF_TYPE_SELECT) {
                $field_values = $definition["field_values"];
                foreach ($field_values as $field_value) {
                    $xml_writer->xmlElement('UDFValue', null, $field_value);
                }
            }
            $xml_writer->xmlEndTag("UDFDefinition");
        }
        $xml_writer->xmlEndTag("UDFDefinitions");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilUserDefinedFields::delete

(

int

$a_id

)

Definition at line 477 of file class.ilUserDefinedFields.php.

References $DIC, $ilDB, $query, __read(), and ilUserDefinedData\deleteEntriesOfField().

                                     : void
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        // Delete definitions
        $query = "DELETE FROM udf_definition " .
            "WHERE field_id = " . $this->db->quote($a_id, 'integer') . " ";
        $ilDB->manipulate($query);

        // Delete usr_data entries
        ilUserDefinedData::deleteEntriesOfField($a_id);

        $this->__read();
    }

Here is the call graph for this function:

deleteValue()

ilUserDefinedFields::deleteValue	(	int	$a_field_id,
		int	$a_value_id
	)

Definition at line 564 of file class.ilUserDefinedFields.php.

References $DIC, $ilDB, __read(), ilUserDefinedData\deleteFieldValue(), and getDefinition().

     : void {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $old_value = "";

        $definition = $this->getDefinition($a_field_id);

        $counter = 0;
        $new_values = array();
        foreach ($definition['field_values'] as $value) {
            if ($counter++ != $a_value_id) {
                $new_values[] = $value;
            } else {
                $old_value = $value;
            }
        }

        $values = array(
            'field_values' => array('clob',serialize($new_values)));
        $ilDB->update('udf_definition', $values, array('field_id' => array('integer',$a_field_id)));


        // sets value to '' where old value is $old_value
        ilUserDefinedData::deleteFieldValue($a_field_id, $old_value);

        // finally read data
        $this->__read();
    }

Here is the call graph for this function:

enableCertificate()

ilUserDefinedFields::enableCertificate

(

bool

$a_c

)

Definition at line 365 of file class.ilUserDefinedFields.php.

                                                : void
    {
        $this->field_certificate = $a_c;
    }

enableChangeable()

ilUserDefinedFields::enableChangeable

(

bool

$a_changeable

)

Definition at line 295 of file class.ilUserDefinedFields.php.

                                                        : void
    {
        $this->field_changeable = $a_changeable;
    }

enableChangeableLocalUserAdministration()

ilUserDefinedFields::enableChangeableLocalUserAdministration

(

bool

$a_changeable

)

Definition at line 305 of file class.ilUserDefinedFields.php.

                                                                               : void
    {
        $this->field_changeable_lua = $a_changeable;
    }

enableCourseExport()

ilUserDefinedFields::enableCourseExport

(

bool

$a_course_export

)

Definition at line 345 of file class.ilUserDefinedFields.php.

                                                             : void
    {
        $this->field_course_export = $a_course_export;
    }

enabledCertificate()

ilUserDefinedFields::enabledCertificate

(

)

Definition at line 370 of file class.ilUserDefinedFields.php.

References $field_certificate.

Referenced by add(), and update().

                                        : bool
    {
        return $this->field_certificate;
    }

Here is the caller graph for this function:

enabledChangeable()

ilUserDefinedFields::enabledChangeable

(

)

Definition at line 300 of file class.ilUserDefinedFields.php.

References $field_changeable.

Referenced by add(), and update().

                                       : bool
    {
        return $this->field_changeable;
    }

Here is the caller graph for this function:

enabledChangeableLocalUserAdministration()

ilUserDefinedFields::enabledChangeableLocalUserAdministration

(

)

Definition at line 310 of file class.ilUserDefinedFields.php.

References $field_changeable_lua.

Referenced by add(), and update().

                                                              : bool
    {
        return $this->field_changeable_lua;
    }

Here is the caller graph for this function:

enabledCourseExport()

ilUserDefinedFields::enabledCourseExport

(

)

Definition at line 350 of file class.ilUserDefinedFields.php.

References $field_course_export.

Referenced by add(), and update().

                                         : bool
    {
        return $this->field_course_export;
    }

Here is the caller graph for this function:

enabledExport()

ilUserDefinedFields::enabledExport

(

)

Definition at line 340 of file class.ilUserDefinedFields.php.

References $field_export.

Referenced by add(), and update().

                                   : bool
    {
        return $this->field_export;
    }

Here is the caller graph for this function:

enabledGroupExport()

ilUserDefinedFields::enabledGroupExport

(

)

Definition at line 360 of file class.ilUserDefinedFields.php.

References $field_group_export.

Referenced by add(), and update().

                                        : bool
    {
        return $this->field_group_export;
    }

Here is the caller graph for this function:

enabledRequired()

ilUserDefinedFields::enabledRequired

(

)

Definition at line 320 of file class.ilUserDefinedFields.php.

References $field_required.

Referenced by add(), and update().

                                     : bool
    {
        return $this->field_required;
    }

Here is the caller graph for this function:

enabledSearchable()

ilUserDefinedFields::enabledSearchable

(

)

Definition at line 330 of file class.ilUserDefinedFields.php.

References $field_searchable.

Referenced by add(), and update().

                                       : bool
    {
        return $this->field_searchable;
    }

Here is the caller graph for this function:

enabledVisible()

ilUserDefinedFields::enabledVisible

(

)

Definition at line 280 of file class.ilUserDefinedFields.php.

References $field_visible.

Referenced by add(), and update().

                                    : bool
    {
        return $this->field_visible;
    }

Here is the caller graph for this function:

enabledVisibleLocalUserAdministration()

ilUserDefinedFields::enabledVisibleLocalUserAdministration

(

)

Definition at line 290 of file class.ilUserDefinedFields.php.

References $field_visib_lua.

Referenced by add(), and update().

                                                           : bool
    {
        return $this->field_visib_lua;
    }

Here is the caller graph for this function:

enabledVisibleRegistration()

ilUserDefinedFields::enabledVisibleRegistration

(

)

Definition at line 380 of file class.ilUserDefinedFields.php.

References $field_visible_registration.

Referenced by add(), and update().

                                                : bool
    {
        return $this->field_visible_registration;
    }

Here is the caller graph for this function:

enableExport()

ilUserDefinedFields::enableExport

(

bool

$a_export

)

Definition at line 335 of file class.ilUserDefinedFields.php.

                                                : void
    {
        $this->field_export = $a_export;
    }

enableGroupExport()

ilUserDefinedFields::enableGroupExport

(

bool

$a_group_export

)

Definition at line 355 of file class.ilUserDefinedFields.php.

                                                           : void
    {
        $this->field_group_export = $a_group_export;
    }

enableRequired()

ilUserDefinedFields::enableRequired

(

bool

$a_required

)

Definition at line 315 of file class.ilUserDefinedFields.php.

                                                    : void
    {
        $this->field_required = $a_required;
    }

enableSearchable()

ilUserDefinedFields::enableSearchable

(

bool

$a_searchable

)

Definition at line 325 of file class.ilUserDefinedFields.php.

                                                        : void
    {
        $this->field_searchable = $a_searchable;
    }

enableVisible()

ilUserDefinedFields::enableVisible

(

bool

$a_visible

)

Definition at line 275 of file class.ilUserDefinedFields.php.

                                                  : void
    {
        $this->field_visible = $a_visible;
    }

enableVisibleLocalUserAdministration()

ilUserDefinedFields::enableVisibleLocalUserAdministration

(

bool

$a_visible

)

Definition at line 285 of file class.ilUserDefinedFields.php.

                                                                         : void
    {
        $this->field_visib_lua = $a_visible;
    }

enableVisibleRegistration()

ilUserDefinedFields::enableVisibleRegistration

(

bool

$a_visible_registration

)

Definition at line 375 of file class.ilUserDefinedFields.php.

                                                                           : void
    {
        $this->field_visible_registration = $a_visible_registration;
    }

fetchFieldIdFromImportId()

ilUserDefinedFields::fetchFieldIdFromImportId

(

string

$a_import_id

)

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

References $DIC, $ilSetting, and $parts.

                                                                 : int
    {
        global $DIC;

        $ilSetting = $DIC['ilSetting'];

        if (!strlen($a_import_id)) {
            return 0;
        }
        $parts = explode('_', $a_import_id);

        if (($parts[0] ?? '') != 'il') {
            return 0;
        }
        if (($parts[1] ?? '') != $ilSetting->get('inst_id', '0')) {
            return 0;
        }
        if (($parts[2] ?? '') != 'udf') {
            return 0;
        }
        if ($parts[3] ?? false) {
            // Check if field exists
            if (is_array(($this->definitions[$parts[3]] ?? false))) {
                return $parts[3];
            }
        }
        return 0;
    }

fetchFieldIdFromName()

ilUserDefinedFields::fetchFieldIdFromName

(

string

$a_name

)

Definition at line 98 of file class.ilUserDefinedFields.php.

                                                        : int
    {
        foreach ($this->definitions as $definition) {
            if ($definition['field_name'] == $a_name) {
                return $definition['field_id'];
            }
        }
        return 0;
    }

fieldValuesToSelectArray()

ilUserDefinedFields::fieldValuesToSelectArray	(	array	$a_values,
		bool	$a_with_selection_info = true
	)

Definition at line 385 of file class.ilUserDefinedFields.php.

References $DIC, and $lng.

     : array {
        global $DIC;

        $lng = $DIC->language();
        $values = [];
        if ($a_with_selection_info) {
            $values[''] = $lng->txt('please_select');
        }
        foreach ($a_values as $value) {
            $values[$value] = $value;
        }
        if (count($values) > (int) $a_with_selection_info) {
            return $values;
        }
        return [];
    }

getChangeableLocalUserAdministrationDefinitions()

ilUserDefinedFields::getChangeableLocalUserAdministrationDefinitions

(

)

Definition at line 140 of file class.ilUserDefinedFields.php.

References $id.

Referenced by ilObjUserGUI\initForm(), and ilObjUserGUI\loadUserDefinedDataFromForm().

                                                                     : array // Missing array type.
    {
        $visible_definition = [];
        foreach ($this->definitions as $id => $definition) {
            if ($definition['changeable_lua']) {
                $visible_definition[$id] = $definition;
            }
        }
        return $visible_definition;
    }

Here is the caller graph for this function:

getCourseExportableFields()

ilUserDefinedFields::getCourseExportableFields

(

)

Definition at line 184 of file class.ilUserDefinedFields.php.

References $id.

Referenced by getExportableFields().

                                               : array // Missing array type.
    {
        $cexp_definition = [];
        foreach ($this->definitions as $id => $definition) {
            if ($definition['course_export']) {
                $cexp_definition[$id] = $definition;
            }
        }
        return $cexp_definition;
    }

Here is the caller graph for this function:

getDefinition()

ilUserDefinedFields::getDefinition

(

int

$a_id

)

Definition at line 113 of file class.ilUserDefinedFields.php.

Referenced by deleteValue().

                                            : array // Missing array type.
    {
        return $this->definitions[$a_id] ?? array();
    }

Here is the caller graph for this function:

getDefinitions()

ilUserDefinedFields::getDefinitions

(

)

Definition at line 108 of file class.ilUserDefinedFields.php.

Referenced by addToXML(), ilObjUserGUI\handleIgnoredRequiredFields(), ilObjUserGUI\initForm(), and ilObjUserGUI\loadUserDefinedDataFromForm().

                                    : array // Missing array type.
    {
        return $this->definitions ?: array();
    }

Here is the caller graph for this function:

getExportableFields()

ilUserDefinedFields::getExportableFields

(

int

$a_obj_id

)

Get exportable field.

Definition at line 209 of file class.ilUserDefinedFields.php.

References ilObject\_lookupType(), getCourseExportableFields(), and getGroupExportableFields().

                                                      : array // Missing array type.
    {
        if (ilObject::_lookupType($a_obj_id) == 'crs') {
            return $this->getCourseExportableFields();
        }
        if (ilObject::_lookupType($a_obj_id) == 'grp') {
            return $this->getGroupExportableFields();
        }
        return array();
    }

Here is the call graph for this function:

getFieldName()

ilUserDefinedFields::getFieldName

(

)

Definition at line 226 of file class.ilUserDefinedFields.php.

References $field_name.

Referenced by add(), and update().

                                  : string
    {
        return $this->field_name;
    }

Here is the caller graph for this function:

getFieldType()

ilUserDefinedFields::getFieldType

(

)

Definition at line 252 of file class.ilUserDefinedFields.php.

References $field_type.

Referenced by add(), and update().

                                  : int
    {
        return $this->field_type;
    }

Here is the caller graph for this function:

getFieldValues()

ilUserDefinedFields::getFieldValues

(

)

Definition at line 270 of file class.ilUserDefinedFields.php.

Referenced by add(), update(), and validateValues().

                                    : array // Missing array type.
    {
        return $this->field_values ?: array();
    }

Here is the caller graph for this function:

getGroupExportableFields()

ilUserDefinedFields::getGroupExportableFields

(

)

Definition at line 195 of file class.ilUserDefinedFields.php.

References $id.

Referenced by getExportableFields().

                                              : array // Missing array type.
    {
        $cexp_definition = [];
        foreach ($this->definitions as $id => $definition) {
            if ($definition['group_export']) {
                $cexp_definition[$id] = $definition;
            }
        }
        return $cexp_definition;
    }

Here is the caller graph for this function:

getLocalUserAdministrationDefinitions()

ilUserDefinedFields::getLocalUserAdministrationDefinitions

(

)

Definition at line 129 of file class.ilUserDefinedFields.php.

References $id.

                                                           : array // Missing array type.
    {
        $visible_definition = [];
        foreach ($this->definitions as $id => $definition) {
            if ($definition['visib_lua']) {
                $visible_definition[$id] = $definition;
            }
        }
        return $visible_definition;
    }

getRegistrationDefinitions()

ilUserDefinedFields::getRegistrationDefinitions

(

)

Definition at line 151 of file class.ilUserDefinedFields.php.

References $id.

                                                : array // Missing array type.
    {
        $visible_definition = [];
        foreach ($this->definitions as $id => $definition) {
            if ($definition['visib_reg']) {
                $visible_definition[$id] = $definition;
            }
        }
        return $visible_definition;
    }

getRequiredDefinitions()

ilUserDefinedFields::getRequiredDefinitions

(

)

Definition at line 173 of file class.ilUserDefinedFields.php.

References $id.

                                            : array // Missing array type.
    {
        $required_definition = [];
        foreach ($this->definitions as $id => $definition) {
            if ($definition['required']) {
                $required_definition[$id] = $definition;
            }
        }
        return $required_definition;
    }

getSearchableDefinitions()

ilUserDefinedFields::getSearchableDefinitions

(

)

Definition at line 162 of file class.ilUserDefinedFields.php.

References $id.

                                              : array // Missing array type.
    {
        $searchable_definition = [];
        foreach ($this->definitions as $id => $definition) {
            if ($definition['searchable']) {
                $searchable_definition[$id] = $definition;
            }
        }
        return $searchable_definition;
    }

getVisibleDefinitions()

ilUserDefinedFields::getVisibleDefinitions

(

)

Definition at line 118 of file class.ilUserDefinedFields.php.

References $id.

                                           : array // Missing array type.
    {
        $visible_definition = [];
        foreach ($this->definitions as $id => $definition) {
            if ($definition['visible']) {
                $visible_definition[$id] = $definition;
            }
        }
        return $visible_definition;
    }

isPluginType()

ilUserDefinedFields::isPluginType

(

)

Definition at line 236 of file class.ilUserDefinedFields.php.

References UDF_TYPE_SELECT, UDF_TYPE_TEXT, and UDF_TYPE_WYSIWYG.

                                  : bool
    {
        if (!$this->field_type) {
            return false;
        }
        switch ($this->field_type) {
            case UDF_TYPE_TEXT:
            case UDF_TYPE_SELECT:
            case UDF_TYPE_WYSIWYG:
                return false;

            default:
                return true;
        }
    }

nameExists()

ilUserDefinedFields::nameExists

(

string

$a_field_name

)

Definition at line 426 of file class.ilUserDefinedFields.php.

References $DIC, $ilDB, $query, and $res.

Referenced by ilCustomUserFieldsGUI\validateForm().

                                                    : bool
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = "SELECT * FROM udf_definition " .
            "WHERE field_name = " . $this->db->quote($a_field_name, 'text') . " ";
        $res = $ilDB->query($query);

        return (bool) $res->numRows();
    }

Here is the caller graph for this function:

setFieldName()

ilUserDefinedFields::setFieldName

(

string

$a_name

)

Definition at line 221 of file class.ilUserDefinedFields.php.

                                                : void
    {
        $this->field_name = $a_name;
    }

setFieldType()

ilUserDefinedFields::setFieldType

(

int

$a_type

)

Definition at line 231 of file class.ilUserDefinedFields.php.

                                             : void
    {
        $this->field_type = $a_type;
    }

setFieldValues()

ilUserDefinedFields::setFieldValues

(

array

$a_values

)

Parameters

array

$a_values,<mixed,mixed>

Definition at line 260 of file class.ilUserDefinedFields.php.

Referenced by ilCustomUserFieldsGUI\validateForm().

                                                   : void
    {
        $this->field_values = array();
        foreach ($a_values as $value) {
            if (strlen($value)) {
                $this->field_values[] = $value;
            }
        }
    }

Here is the caller graph for this function:

toXML()

ilUserDefinedFields::toXML

(

)

Definition at line 597 of file class.ilUserDefinedFields.php.

References addToXML().

                           : string
    {
        $xml_writer = new ilXmlWriter();
        $this->addToXML($xml_writer);
        return $xml_writer->xmlDumpMem(false);
    }

Here is the call graph for this function:

update()

ilUserDefinedFields::update

(

int

$a_id

)

Definition at line 494 of file class.ilUserDefinedFields.php.

References $DIC, $ilDB, __read(), enabledCertificate(), enabledChangeable(), enabledChangeableLocalUserAdministration(), enabledCourseExport(), enabledExport(), enabledGroupExport(), enabledRequired(), enabledSearchable(), enabledVisible(), enabledVisibleLocalUserAdministration(), enabledVisibleRegistration(), getFieldName(), getFieldType(), and getFieldValues().

                                     : void
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $values = array(
            'field_name' => array('text',$this->getFieldName()),
            'field_type' => array('integer', $this->getFieldType()),
            'field_values' => array('clob',serialize($this->getFieldValues())),
            'visible' => array('integer', (int) $this->enabledVisible()),
            'changeable' => array('integer', (int) $this->enabledChangeable()),
            'required' => array('integer', (int) $this->enabledRequired()),
            'searchable' => array('integer', (int) $this->enabledSearchable()),
            'export' => array('integer', (int) $this->enabledExport()),
            'course_export' => array('integer', (int) $this->enabledCourseExport()),
            'registration_visible' => array('integer', (int) $this->enabledVisibleRegistration()),
            'visible_lua' => array('integer', (int) $this->enabledVisibleLocalUserAdministration()),
            'changeable_lua' => array('integer', (int) $this->enabledChangeableLocalUserAdministration()),
            'group_export' => array('integer', (int) $this->enabledGroupExport()),
            'certificate' => array('integer', (int) $this->enabledCertificate())
        );
        $ilDB->update('udf_definition', $values, array('field_id' => array('integer',$a_id)));
        $this->__read();
    }

Here is the call graph for this function:

validateValues()

ilUserDefinedFields::validateValues

(

)

Definition at line 405 of file class.ilUserDefinedFields.php.

References getFieldValues(), UDF_DUPLICATE_VALUES, and UDF_NO_VALUES.

Referenced by ilCustomUserFieldsGUI\validateForm().

                                    : int
    {
        $number = 0;
        $unique = array();
        foreach ($this->getFieldValues() as $value) {
            if (!strlen($value)) {
                continue;
            }
            $number++;
            $unique[$value] = $value;
        }

        if (!count($unique)) {
            return UDF_NO_VALUES;
        }
        if ($number != count($unique)) {
            return UDF_DUPLICATE_VALUES;
        }
        return 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$db

ilDBInterface ilUserDefinedFields::$db = null

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

$definitions

array ilUserDefinedFields::$definitions = array()

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

$field_certificate

bool ilUserDefinedFields::$field_certificate = false

protected

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

Referenced by enabledCertificate().

$field_changeable

bool ilUserDefinedFields::$field_changeable = false

protected

Definition at line 38 of file class.ilUserDefinedFields.php.

Referenced by enabledChangeable().

$field_changeable_lua

bool ilUserDefinedFields::$field_changeable_lua = false

protected

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

Referenced by enabledChangeableLocalUserAdministration().

$field_course_export

bool ilUserDefinedFields::$field_course_export = false

protected

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

Referenced by enabledCourseExport().

$field_export

bool ilUserDefinedFields::$field_export = false

protected

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

Referenced by enabledExport().

$field_group_export

bool ilUserDefinedFields::$field_group_export = false

protected

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

Referenced by enabledGroupExport().

$field_name

string ilUserDefinedFields::$field_name = ""

protected

Definition at line 42 of file class.ilUserDefinedFields.php.

Referenced by getFieldName().

$field_required

bool ilUserDefinedFields::$field_required = false

protected

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

Referenced by enabledRequired().

$field_searchable

bool ilUserDefinedFields::$field_searchable = false

protected

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

Referenced by enabledSearchable().

$field_type

int ilUserDefinedFields::$field_type = 0

protected

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

Referenced by getFieldType().

$field_values

array ilUserDefinedFields::$field_values = []

protected

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

$field_visib_lua

bool ilUserDefinedFields::$field_visib_lua = false

protected

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

Referenced by enabledVisibleLocalUserAdministration().

$field_visible

bool ilUserDefinedFields::$field_visible = false

protected

Definition at line 43 of file class.ilUserDefinedFields.php.

Referenced by enabledVisible().

$field_visible_registration

int ilUserDefinedFields::$field_visible_registration = 0

private

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

Referenced by enabledVisibleRegistration().

---

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

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