Collaboration diagram for ilExportFieldsInfo:

Public Member Functions
	getType ()

	isExportable ($a_field_name)
	Check if field is exportable. More...

	getFieldsInfo ()
	Get informations (exportable) about user data profile fields @access public. More...

	getExportableFields ()
	Get Exportable Fields. More...

	getSelectableFieldsInfo (?int $a_obj_id=null)
	Get selectable fields. More...

	exportableFieldsToInfoString ()
	Get exportable fields as info string. More...

	sortExportFields ()
	sort Exports fields User for Name Presentation Guideline More...

Static Public Member Functions
static	_getInstanceByType (string $a_type)
	Get Singleton Instance. More...

Private Member Functions
	__construct (string $a_type)
	Private Singleton Constructor. More...

	read ()
	Read info about exportable fields. More...

Private Attributes
ilSetting	$settings

ilLanguage	$lng

Profile	$profile

string	$obj_type = ''

array	$possible_fields = array()

Static Private Attributes
static array	$instances = []

Detailed Description

Definition at line 30 of file class.ilExportFieldsInfo.php.

Constructor & Destructor Documentation

◆ __construct()

ilExportFieldsInfo::__construct ( string $a_type )

private

Private Singleton Constructor.

Use getInstance @access private

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

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->settings = $DIC->settings();
        $this->profile = $DIC['user']->getProfile();
        $this->obj_type = $a_type;
 
        $this->read();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ _getInstanceByType()

static ilExportFieldsInfo::_getInstanceByType ( string $a_type )

static

Get Singleton Instance.

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

                                                             : ilExportFieldsInfo
    {
        if (!isset(self::$instances[$a_type])) {
            self::$instances[$a_type] = new self($a_type);
        }
        return self::$instances[$a_type];
    }

Referenced by ilMemberExportGUI\__construct(), ilStudyProgrammeDIC\buildDIC(), ilRegistrationGUI\fillAgreement(), ilLearningSequenceParticipantsTableGUI\getExportFieldsInfo(), ilMemberExport\getOrderedExportableFields(), ilParticipantTableGUI\getSelectableColumns(), ilSubscriberTableGUI\getSelectableColumns(), ilWaitingListTableGUI\getSelectableColumns(), ilBookingReservationsTableGUI\getSelectableUserColumns(), ilObjCourseGUI\infoScreen(), ilObjGroupGUI\infoScreen(), ilMemberExportSettingsGUI\initForm(), ilAttendanceList\readOrderedExportableFields(), and ilStudyProgrammeDIC\specificDicFor().

Here is the caller graph for this function:

◆ exportableFieldsToInfoString()

ilExportFieldsInfo::exportableFieldsToInfoString ( )

Get exportable fields as info string.

Returns: string info page string

Definition at line 169 of file class.ilExportFieldsInfo.php.

                                                  : string
    {
        $fields = [];
        foreach ($this->getExportableFields() as $field) {
            $fields[] = $this->lng->txt($field);
        }
        return implode('<br />', $fields);
    }

References getExportableFields(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getExportableFields()

ilExportFieldsInfo::getExportableFields ( )

Get Exportable Fields.

Definition at line 92 of file class.ilExportFieldsInfo.php.

                                         : array
    {
        $fields = [];
        foreach ($this->possible_fields as $field => $exportable) {
            if ($exportable) {
                $fields[] = $field;
            }
        }
        return $fields;
    }

Referenced by exportableFieldsToInfoString(), and getSelectableFieldsInfo().

Here is the caller graph for this function:

◆ getFieldsInfo()

ilExportFieldsInfo::getFieldsInfo ( )

Get informations (exportable) about user data profile fields @access public.

Definition at line 84 of file class.ilExportFieldsInfo.php.

                                   : array
    {
        return $this->possible_fields;
    }

References $possible_fields.

◆ getSelectableFieldsInfo()

ilExportFieldsInfo::getSelectableFieldsInfo ( ?int $a_obj_id = null )

Get selectable fields.

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

                                                                  : array
    {
        global $DIC;
 
        $user = $DIC->user();
        $profile = $DIC['user']->getProfile();
 
        $fields = [];
        foreach ($this->getExportableFields() as $field) {
            switch ($field) {
                case 'lastname':
                case 'firstname':
                    break;
 
                case 'username':
                    $fields['login']['txt'] = $this->lng->txt('login');
                    $fields['login']['default'] = 1;
                    break;
 
                default:
                    // #18795
                    $caption = ($field == "title")
                        ? "person_title"
                        : $field;
                    $fields[$field]['txt'] = $this->lng->txt($caption);
                    $fields[$field]['default'] = 0;
                    break;
            }
        }
 
        if ($a_obj_id && ilBookingEntry::hasObjectBookingEntries($a_obj_id, $user->getId())) {
            $this->lng->loadLanguageModule('dateplaner');
            $fields['consultation_hour']['txt'] = $this->lng->txt('cal_ch_field_ch');
            $fields['consultation_hour']['default'] = 0;
        }
 
        $udf = $profile->getVisibleUserDefinedFields(Context::buildFromObjectType($this->getType()));
        if ($udf !== []) {
            foreach ($udf as $field_id => $field) {
                $fields['udf_' . $field_id]['txt'] = $field->getLabel($this->lng);
                $fields['udf_' . $field_id]['default'] = 0;
            }
        }
 
        if ($a_obj_id) {
            $cdf = ilCourseDefinedFieldDefinition::_getFields($a_obj_id);
            foreach ($cdf as $def) {
                $fields['odf_' . $def->getId()]['txt'] = $def->getName();
                $fields['odf_' . $def->getId()]['default'] = 0;
            }
            if (count($cdf)) {
                // add last edit
                $fields['odf_last_update']['txt'] = $this->lng->txt($this->getType() . '_cdf_tbl_last_edit');
                $fields['odf_last_update']['default'] = 0;
            }
        }
        return $fields;
    }

References $DIC, $profile, ilCourseDefinedFieldDefinition\_getFields(), getExportableFields(), getType(), ILIAS\User\Profile\Profile\getVisibleUserDefinedFields(), ilBookingEntry\hasObjectBookingEntries(), and ILIAS\Repository\lng().

Referenced by ilPRGAssignmentDBRepository\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getType()

ilExportFieldsInfo::getType ( )

Definition at line 67 of file class.ilExportFieldsInfo.php.

                             : string
    {
        return $this->obj_type;
    }

References $obj_type.

Referenced by getSelectableFieldsInfo(), and read().

Here is the caller graph for this function:

◆ isExportable()

ilExportFieldsInfo::isExportable ( $a_field_name )

Check if field is exportable.

Definition at line 75 of file class.ilExportFieldsInfo.php.

                                               : bool
    {
        return array_key_exists($a_field_name, $this->possible_fields);
    }

◆ read()

ilExportFieldsInfo::read ( )

private

Read info about exportable fields.

Definition at line 181 of file class.ilExportFieldsInfo.php.

                           : void
    {
        $type = $this->getType();
        $this->possible_fields = array_reduce(
            $this->profile->getFields(),
            function (array $c, ProfileField $v) use ($type): array {
                if ($v->isCustom()) {
                    return $c;
                }
                if ($type === 'crs') {
                    $c[$v->getIdentifier()] = $v->isVisibleInCourses();
                }
 
                if ($type === 'grp') {
                    $c[$v->getIdentifier()] = $v->isVisibleInGroups();
                }
 
                if ($type === 'prg') {
                    $c[$v->getIdentifier()] = $v->isVisibleInStudyProgrammes();
                }
 
                return $c;
            },
            $this->possible_fields
        );
    }

References $c, $possible_fields, getType(), if, and ILIAS\Repository\profile().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sortExportFields()

ilExportFieldsInfo::sortExportFields ( )

sort Exports fields User for Name Presentation Guideline

Definition at line 211 of file class.ilExportFieldsInfo.php.

                                      : void
    {
        $start_order = ['lastname' => [], 'firstname' => [], 'username' => []];
 
        foreach (array_keys($start_order) as $key) {
            if (isset($this->possible_fields[$key])) {
                $start_order[$key] = $this->possible_fields[$key];
                unset($this->possible_fields[$key]);
            } else {
                unset($start_order[$key]);
            }
        }
 
        if (count($start_order) > 0) {
            $this->possible_fields = array_merge($start_order, $this->possible_fields);
        }
    }

Field Documentation

◆ $instances

array ilExportFieldsInfo::$instances = []

staticprivate

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

◆ $lng

ilLanguage ilExportFieldsInfo::$lng

private

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

◆ $obj_type

string ilExportFieldsInfo::$obj_type = ''

private

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

Referenced by getType().

◆ $possible_fields

array ilExportFieldsInfo::$possible_fields = array()

private

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

Referenced by getFieldsInfo(), and read().

◆ $profile

Profile ilExportFieldsInfo::$profile

private

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

Referenced by getSelectableFieldsInfo().

◆ $settings

ilSetting ilExportFieldsInfo::$settings

private

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

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

components/ILIAS/PrivacySecurity/classes/class.ilExportFieldsInfo.php

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getInstanceByType()

◆ exportableFieldsToInfoString()

◆ getExportableFields()

◆ getFieldsInfo()

◆ getSelectableFieldsInfo()

◆ getType()

◆ isExportable()

◆ read()

◆ sortExportFields()

Field Documentation

◆ $instances

◆ $lng

◆ $obj_type

◆ $possible_fields

◆ $profile

◆ $settings