ilExportFieldsInfo Class Reference

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 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
string	$obj_type = ''
array	$possible_fields = array()

Static Private Attributes
static array	$instances = []

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilExportFieldsInfo::__construct ( string  $a_type )

private

Private Singleton Constructor.

Use getInstance private

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

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

    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->settings = $DIC->settings();
        $this->obj_type = $a_type;

        $this->read();
    }

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 53 of file class.ilExportFieldsInfo.php.

Referenced by ilMemberExportGUI\__construct(), ilMemberAgreementGUI\addExportFieldInfo(), 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().

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

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 174 of file class.ilExportFieldsInfo.php.

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

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

Here is the call graph for this function:

getExportableFields()

ilExportFieldsInfo::getExportableFields

(

)

Get Exportable Fields.

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

Referenced by exportableFieldsToInfoString(), and getSelectableFieldsInfo().

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

Here is the caller graph for this function:

getFieldsInfo()

ilExportFieldsInfo::getFieldsInfo

(

)

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

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

References $possible_fields.

                                   : array
    {
        return $this->possible_fields;
    }

getSelectableFieldsInfo()

ilExportFieldsInfo::getSelectableFieldsInfo

(

?int

$a_obj_id = null

)

Get selectable fields.

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

References $DIC, ilCourseDefinedFieldDefinition\_getFields(), ilUserDefinedFields\_getInstance(), getExportableFields(), getType(), ilBookingEntry\hasObjectBookingEntries(), and ILIAS\Repository\lng().

Referenced by ilPRGAssignmentDBRepository\__construct().

                                                                  : array
    {
        global $DIC;

        $user = $DIC->user();

        $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 = [];
        switch ($this->getType()) {
            case 'crs':
                $udf = ilUserDefinedFields::_getInstance()->getCourseExportableFields();
                break;
            case 'grp':
                $udf = ilUserDefinedFields::_getInstance()->getGroupExportableFields();
                break;
            case 'prg':
                $udf = ilUserDefinedFields::_getInstance()->getProgrammeExportableFields();
                break;
        }

        if ($udf !== []) {
            foreach ($udf as $field_id => $field) {
                $fields['udf_' . $field_id]['txt'] = $field['field_name'];
                $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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getType()

ilExportFieldsInfo::getType

(

)

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

References $obj_type.

Referenced by getSelectableFieldsInfo(), and read().

                             : string
    {
        return $this->obj_type;
    }

Here is the caller graph for this function:

isExportable()

ilExportFieldsInfo::isExportable

(

$a_field_name

)

Check if field is exportable.

Definition at line 69 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 186 of file class.ilExportFieldsInfo.php.

References $data, getType(), null, and ILIAS\Repository\settings().

Referenced by __construct().

                           : void
    {
        $profile = new ilUserProfile();
        $profile->skipGroup('settings');

        $field_prefix = null;
        $field_part_limit = 5;
        $export_hide = null;
        $export_fix_val = null;
        $type = $this->getType();

        $type_vals = [
            'crs' => ['course_export_hide', 'course_export_fix_value', 'usr_settings_course_export_'],
            'grp' => ['group_export_hide', 'group_export_fix_value', 'usr_settings_group_export_'],
            'prg' => ['prg_export_hide', 'prg_export_fix_value', 'usr_settings_prg_export_']
        ];
        if (array_key_exists($type, $type_vals)) {
            list($export_hide, $export_fix_val, $field_prefix) = $type_vals[$type];
        }

        foreach ($profile->getStandardFields() as $key => $data) {
            if (!array_key_exists($export_hide, $data) || !$data[$export_hide]) {
                if (isset($data[$export_fix_val]) and $data[$export_fix_val]) {
                    $this->possible_fields[$key] = $data[$export_fix_val];
                } else {
                    $this->possible_fields[$key] = 0;
                }
            }
        }

        $settings_all = $this->settings->getAll();
        foreach ($settings_all as $key => $value) {
            if ($field_prefix && stristr($key, $field_prefix) and $value) {
                // added limit for mantis 11096
                $field_parts = explode('_', $key, $field_part_limit);
                $field = $field_parts[count($field_parts) - 1];
                if (array_key_exists($field, $this->possible_fields)) {
                    $this->possible_fields[$field] = 1;
                }
            }
        }
    }

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 232 of file class.ilExportFieldsInfo.php.

                                      : void
    {
        $start_order = array("lastname" => array(), "firstname" => array(), "username" => array());

        foreach ($start_order as $key => $value) {
            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 28 of file class.ilExportFieldsInfo.php.

$lng

ilLanguage ilExportFieldsInfo::$lng

private

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

$obj_type

string ilExportFieldsInfo::$obj_type = ''

private

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

Referenced by getType().

$possible_fields

array ilExportFieldsInfo::$possible_fields = array()

private

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

Referenced by getFieldsInfo().

$settings

ilSetting ilExportFieldsInfo::$settings

private

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

---

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

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