Additional user data fields definition. More...

Collaboration diagram for ilUserDefinedFields:

Public Member Functions
	fetchFieldIdFromImportId ($a_import_id)

	fetchFieldIdFromName ($a_name)

	getDefinitions ()

	getDefinition ($a_id)

	getVisibleDefinitions ()

	getLocalUserAdministrationDefinitions ()

	getChangeableLocalUserAdministrationDefinitions ()

	getRegistrationDefinitions ()

	getSearchableDefinitions ()

	getRequiredDefinitions ()

	getCourseExportableFields ()
	get More...

	getGroupExportableFields ()
	get fields visible in groups More...

	getExportableFields ($a_obj_id)
	Get exportable field. More...

	setFieldName ($a_name)

	getFieldName ()

	setFieldType ($a_type)

	getFieldType ()

	setFieldValues ($a_values)

	getFieldValues ()

	enableVisible ($a_visible)

	enabledVisible ()

	enableVisibleLocalUserAdministration ($a_visible)

	enabledVisibleLocalUserAdministration ()

	enableChangeable ($a_changeable)

	enabledChangeable ()

	enableChangeableLocalUserAdministration ($a_changeable)

	enabledChangeableLocalUserAdministration ()

	enableRequired ($a_required)

	enabledRequired ()

	enableSearchable ($a_searchable)

	enabledSearchable ()

	enableExport ($a_export)

	enabledExport ()

	enableCourseExport ($a_course_export)

	enabledCourseExport ()

	enableGroupExport ($a_group_export)

	enabledGroupExport ()

	enableCertificate ($a_c)

	enabledCertificate ()

	enableVisibleRegistration ($a_visible_registration)

	enabledVisibleRegistration ()

	fieldValuesToSelectArray ($a_values)

	validateValues ()

	nameExists ($a_field_name)

	add ()

	delete ($a_id)

	update ($a_id)

	__read ()

	deleteValue ($a_field_id, $a_value_id)

	toXML ()

	addToXML ($xml_writer)
	add user defined field data to xml (using usr dtd) More...

	_newInstance ()

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

Data Fields
	$db = null

	$definitions = array()

Private Member Functions
	__construct ()
	Constructor is private -> use getInstance These definition are used e.g in User XML import. More...

Private Attributes
	$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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilUserDefinedFields::__construct ( )

private

Constructor is private -> use getInstance These definition are used e.g in User XML import.

To avoid instances of this class for every user object during import, it caches this object in a singleton.

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

        {
                global $ilDB;
 
                $this->db =& $ilDB;
 
                $this->__read();
        }

References $ilDB, and __read().

Here is the call graph for this function:

Member Function Documentation

◆ __read()

ilUserDefinedFields::__read ( )

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

        {
                global $ilSetting;
 
                $query = "SELECT * FROM udf_definition ";
                $res = $this->db->query($query);
 
                $this->definitions = array();
                while($row = $res->fetchRow(DB_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) as $item)
                        {
                                if(!is_numeric($item))
                                {
                                        $is_numeric = false;
                                }
                                $sort[] = array("value"=>$item);
                        }                       
                        foreach(ilUtil::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;
                        // fraunhpatch start
                        $this->definitions[$row->field_id]['certificate'] = $row->certificate;
                        // fraunhpatch end
                }
 
                return true;
        }

References $ilSetting, $query, $res, $row, DB_FETCHMODE_OBJECT, and ilUtil\sortArray().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getInstance()

static ilUserDefinedFields::_getInstance ( )

static

Get instance.

Returns: object ilUserDefinedFields

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

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

Referenced by ilUserSearchOptions\__appendUserDefinedFields(), ilObjUserGUI\__checkUserDefinedRequiredFields(), ilCustomUserFieldSettingsTableGUI\__construct(), ilCustomUserFieldsGUI\__construct(), ilPersonalSettingsGUI\__construct(), ilAccountRegistrationGUI\__initForm(), ilObjUserGUI\__showUserDefinedFields(), ilMemberAgreementGUI\addExportFieldInfo(), ilUserDefinedData\addToXML(), ilCustomUserFieldsGUI\askDeleteField(), ilCustomUserFieldsGUI\create(), ilCustomUserFieldsGUI\deleteField(), ilPublicUserProfileGUI\getEmbeddable(), ilMemberExport\getOrderedExportableFields(), ilExportFieldsInfo\getSelectableFieldsInfo(), ilLPTableBaseGUI\getSelectableUserColumns(), ilObjUserFolder\getUserDefinedExportFields(), ilObjUserGUI\getValues(), ilObjUserGUI\handleIgnoredRequiredFields(), ilPersonalProfileGUI\ilPersonalProfileGUI(), ilUserImportParser\importEndTag(), ilObjUserGUI\initForm(), ilMemberExportGUI\initSettingsForm(), ilLDAPAttributeToUser\initUserDefinedFields(), ilLDAPSettingsGUI\initUserDefinedFields(), ilUserXMLWriter\start(), ilCustomUserFieldsGUI\update(), ilUserDefinedData\update(), ilCustomUserFieldsGUI\updateFields(), and ilMemberExport\write().

Here is the caller graph for this function:

◆ _newInstance()

ilUserDefinedFields::_newInstance ( )

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

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

Referenced by ilSoapInstallationInfoXMLWriter\__buildClient().

Here is the caller graph for this function:

◆ add()

ilUserDefinedFields::add ( )

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

        {
                global $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', (int) $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 true;
        }

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

Here is the call graph for this function:

◆ addToXML()

ilUserDefinedFields::addToXML ( $xml_writer )

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

Parameters

*XmlWriter $xml_writer

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

        {
            $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");
 
        }

References getDefinitions(), and UDF_TYPE_SELECT.

Referenced by toXML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilUserDefinedFields::delete ( $a_id )

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

        {
                global $ilDB;
 
                // Delete definitions
                $query = "DELETE FROM udf_definition ".
                        "WHERE field_id = ".$this->db->quote($a_id,'integer')." ";
                $res = $ilDB->manipulate($query);
 
                // Delete usr_data entries
//              $ilDB->dropTableColumn('udf_data','f_'.$a_id);
                include_once("./Services/User/classes/class.ilUserDefinedData.php");
                ilUserDefinedData::deleteEntriesOfField($a_id);
 
                $this->__read();
 
                return true;
        }

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

Here is the call graph for this function:

◆ deleteValue()

ilUserDefinedFields::deleteValue	(	$a_field_id,
		$a_value_id
	)

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

        {
                global $ilDB;
                
                $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
                include_once("./Services/User/classes/class.ilUserDefinedData.php");
                ilUserDefinedData::deleteFieldValue($a_field_id, $old_value);
 
                // fianally read data
                $this->__read();
 
                return true;
        }

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

Here is the call graph for this function:

◆ enableCertificate()

ilUserDefinedFields::enableCertificate ( $a_c )

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

        {
                $this->field_certificate = $a_c;
        }

◆ enableChangeable()

ilUserDefinedFields::enableChangeable ( $a_changeable )

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

        {
                $this->field_changeable = $a_changeable;
        }

◆ enableChangeableLocalUserAdministration()

ilUserDefinedFields::enableChangeableLocalUserAdministration ( $a_changeable )

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

        {
                $this->field_changeable_lua = $a_changeable;
        }

◆ enableCourseExport()

ilUserDefinedFields::enableCourseExport ( $a_course_export )

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

        {
                $this->field_course_export = $a_course_export;
        }

◆ enabledCertificate()

ilUserDefinedFields::enabledCertificate ( )

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

        {
                return $this->field_certificate;
        }

Referenced by add(), and update().

Here is the caller graph for this function:

◆ enabledChangeable()

ilUserDefinedFields::enabledChangeable ( )

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

        {
                return $this->field_changeable;
        }

Referenced by add(), and update().

Here is the caller graph for this function:

◆ enabledChangeableLocalUserAdministration()

ilUserDefinedFields::enabledChangeableLocalUserAdministration ( )

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

        {
                return $this->field_changeable_lua;
        }

Referenced by add(), and update().

Here is the caller graph for this function:

◆ enabledCourseExport()

ilUserDefinedFields::enabledCourseExport ( )

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

        {
                return $this->field_course_export;
        }

Referenced by add(), and update().

Here is the caller graph for this function:

◆ enabledExport()

ilUserDefinedFields::enabledExport ( )

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

        {
                return $this->field_export;
        }

Referenced by add(), and update().

Here is the caller graph for this function:

◆ enabledGroupExport()

ilUserDefinedFields::enabledGroupExport ( )

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

        {
                return $this->field_group_export;
        }

Referenced by add(), and update().

Here is the caller graph for this function:

◆ enabledRequired()

ilUserDefinedFields::enabledRequired ( )

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

        {
                return $this->field_required;
        }

Referenced by add(), and update().

Here is the caller graph for this function:

◆ enabledSearchable()

ilUserDefinedFields::enabledSearchable ( )

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

        {
                return $this->field_searchable;
        }

Referenced by add(), and update().

Here is the caller graph for this function:

◆ enabledVisible()

ilUserDefinedFields::enabledVisible ( )

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

        {
                return $this->field_visible;
        }

Referenced by add(), and update().

Here is the caller graph for this function:

◆ enabledVisibleLocalUserAdministration()

ilUserDefinedFields::enabledVisibleLocalUserAdministration ( )

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

        {
                return $this->field_visib_lua;
        }

Referenced by add(), and update().

Here is the caller graph for this function:

◆ enabledVisibleRegistration()

ilUserDefinedFields::enabledVisibleRegistration ( )

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

        {
                return $this->field_visible_registration;
        }

References $field_visible_registration.

Referenced by add(), and update().

Here is the caller graph for this function:

◆ enableExport()

ilUserDefinedFields::enableExport ( $a_export )

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

        {
                $this->field_export = $a_export;
        }

◆ enableGroupExport()

ilUserDefinedFields::enableGroupExport ( $a_group_export )

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

        {
                $this->field_group_export = $a_group_export;
        }

◆ enableRequired()

ilUserDefinedFields::enableRequired ( $a_required )

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

        {
                $this->field_required = $a_required;
        }

◆ enableSearchable()

ilUserDefinedFields::enableSearchable ( $a_searchable )

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

        {
                $this->field_searchable = $a_searchable;
        }

◆ enableVisible()

ilUserDefinedFields::enableVisible ( $a_visible )

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

        {
                $this->field_visible = $a_visible;
        }

◆ enableVisibleLocalUserAdministration()

ilUserDefinedFields::enableVisibleLocalUserAdministration ( $a_visible )

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

        {
                $this->field_visib_lua = $a_visible;
        }

◆ enableVisibleRegistration()

ilUserDefinedFields::enableVisibleRegistration ( $a_visible_registration )

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

        {
                $this->field_visible_registration = $a_visible_registration;
        }

◆ fetchFieldIdFromImportId()

ilUserDefinedFields::fetchFieldIdFromImportId ( $a_import_id )

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

        {
                global $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])
                {
                        // Check if field exists
                        if(is_array($this->definitions["$parts[3]"]))
                        {
                                return $parts[3];
                        }
                }
                return 0;
        }

References $ilSetting.

◆ fetchFieldIdFromName()

ilUserDefinedFields::fetchFieldIdFromName ( $a_name )

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

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

◆ fieldValuesToSelectArray()

ilUserDefinedFields::fieldValuesToSelectArray ( $a_values )

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

        {
                foreach($a_values as $value)
                {
                        $values[$value] = $value;
                }
                return $values ? $values : array();
        }

◆ getChangeableLocalUserAdministrationDefinitions()

ilUserDefinedFields::getChangeableLocalUserAdministrationDefinitions ( )

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

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

◆ getCourseExportableFields()

ilUserDefinedFields::getCourseExportableFields ( )

get

@access public

Parameters

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

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

Referenced by getExportableFields().

Here is the caller graph for this function:

◆ getDefinition()

ilUserDefinedFields::getDefinition ( $a_id )

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

        {
                return is_array($this->definitions[$a_id]) ? $this->definitions[$a_id] : array();
        }

Referenced by deleteValue().

Here is the caller graph for this function:

◆ getDefinitions()

ilUserDefinedFields::getDefinitions ( )

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

        {
                return $this->definitions ? $this->definitions : array();
        }

Referenced by addToXML().

Here is the caller graph for this function:

◆ getExportableFields()

ilUserDefinedFields::getExportableFields ( $a_obj_id )

Get exportable field.

Parameters

int $a_obj_id

Returns

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

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

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

Here is the call graph for this function:

◆ getFieldName()

ilUserDefinedFields::getFieldName ( )

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

        {
                return $this->field_name;
        }

Referenced by add(), and update().

Here is the caller graph for this function:

◆ getFieldType()

ilUserDefinedFields::getFieldType ( )

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

        {
                return $this->field_type;
        }

Referenced by add(), and update().

Here is the caller graph for this function:

◆ getFieldValues()

ilUserDefinedFields::getFieldValues ( )

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

        {
                return $this->field_values ? $this->field_values : array();
        }

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

Here is the caller graph for this function:

◆ getGroupExportableFields()

ilUserDefinedFields::getGroupExportableFields ( )

get fields visible in groups

@access public

Parameters

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

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

Referenced by getExportableFields().

Here is the caller graph for this function:

◆ getLocalUserAdministrationDefinitions()

ilUserDefinedFields::getLocalUserAdministrationDefinitions ( )

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

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

◆ getRegistrationDefinitions()

ilUserDefinedFields::getRegistrationDefinitions ( )

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

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

◆ getRequiredDefinitions()

ilUserDefinedFields::getRequiredDefinitions ( )

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

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

◆ getSearchableDefinitions()

ilUserDefinedFields::getSearchableDefinitions ( )

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

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

◆ getVisibleDefinitions()

ilUserDefinedFields::getVisibleDefinitions ( )

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

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

◆ nameExists()

ilUserDefinedFields::nameExists ( $a_field_name )

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

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

References $ilDB, $query, and $res.

◆ setFieldName()

ilUserDefinedFields::setFieldName ( $a_name )

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

        {
                $this->field_name = $a_name;
        }

◆ setFieldType()

ilUserDefinedFields::setFieldType ( $a_type )

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

        {
                $this->field_type = $a_type;
        }

◆ setFieldValues()

ilUserDefinedFields::setFieldValues ( $a_values )

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

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

◆ toXML()

ilUserDefinedFields::toXML ( )

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

        {
                include_once './Services/Xml/classes/class.ilXmlWriter.php';
                $xml_writer = new ilXmlWriter();
 
                $this->addToXML ($xml_writer);
 
                return $xml_writer->xmlDumpMem(false);
        }

References addToXML().

Here is the call graph for this function:

◆ update()

ilUserDefinedFields::update ( $a_id )

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

        {
                global $ilDB;
                
                $values = array(
                        'field_name'                            => array('text',$this->getFieldName()),
                        'field_type'                            => array('integer', (int) $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();
 
                return true;
        }

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

Here is the call graph for this function:

◆ validateValues()

ilUserDefinedFields::validateValues ( )

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

        {
                $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;
        }

References getFieldValues(), UDF_DUPLICATE_VALUES, and UDF_NO_VALUES.

Here is the call graph for this function:

Field Documentation

◆ $db

ilUserDefinedFields::$db = null

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

◆ $definitions

ilUserDefinedFields::$definitions = array()

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

◆ $field_visible_registration

ilUserDefinedFields::$field_visible_registration = 0

private

Definition at line 24 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

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __read()

◆ _getInstance()

◆ _newInstance()

◆ add()

◆ addToXML()

◆ delete()

◆ deleteValue()

◆ enableCertificate()

◆ enableChangeable()

◆ enableChangeableLocalUserAdministration()

◆ enableCourseExport()

◆ enabledCertificate()

◆ enabledChangeable()

◆ enabledChangeableLocalUserAdministration()

◆ enabledCourseExport()

◆ enabledExport()

◆ enabledGroupExport()

◆ enabledRequired()

◆ enabledSearchable()

◆ enabledVisible()

◆ enabledVisibleLocalUserAdministration()

◆ enabledVisibleRegistration()

◆ enableExport()

◆ enableGroupExport()

◆ enableRequired()

◆ enableSearchable()

◆ enableVisible()

◆ enableVisibleLocalUserAdministration()

◆ enableVisibleRegistration()

◆ fetchFieldIdFromImportId()

◆ fetchFieldIdFromName()

◆ fieldValuesToSelectArray()

◆ getChangeableLocalUserAdministrationDefinitions()

◆ getCourseExportableFields()

◆ getDefinition()

◆ getDefinitions()

◆ getExportableFields()

◆ getFieldName()

◆ getFieldType()

◆ getFieldValues()

◆ getGroupExportableFields()

◆ getLocalUserAdministrationDefinitions()

◆ getRegistrationDefinitions()

◆ getRequiredDefinitions()

◆ getSearchableDefinitions()

◆ getVisibleDefinitions()

◆ nameExists()

◆ setFieldName()

◆ setFieldType()

◆ setFieldValues()

◆ toXML()

◆ update()

◆ validateValues()

Field Documentation

◆ $db

◆ $definitions

◆ $field_visible_registration