ilExportFieldsInfo Class Reference

Collaboration diagram for ilExportFieldsInfo:

Public Member Functions
	getType ()
	Get object type. More...
	isExportable ($a_field_name)
	Check if field is exportable. More...
	getFieldsInfo ()
	Get informations (exportable) about user data profile fields. More...
	getExportableFields ()
	Get Exportable Fields. More...
	getSelectableFieldsInfo ($a_obj_id)
	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 ($a_type)
	Get Singleton Instance. More...

Private Member Functions
	__construct ($a_type)
	Private Singleton Constructor. More...
	read ()
	Read info about exportable fields. More...

Private Attributes
	$settings
	$db
	$lng
	$obj_type = ''
	$possible_fields = array()

Static Private Attributes
static	$instance = null

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilExportFieldsInfo::__construct (   $a_type )

private

Private Singleton Constructor.

Use getInstance

private

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

References $a_type, $DIC, $ilDB, $ilSetting, $lng, read(), and settings().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $ilSetting = $DIC['ilSetting'];
        $lng = $DIC['lng'];
        
        $this->db = $ilDB;
        $this->lng = $lng;
        $this->settings = $ilSetting;
        
        $this->obj_type = $a_type;
        
        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

_getInstanceByType()

static ilExportFieldsInfo::_getInstanceByType (   $a_type )

static

Get Singleton Instance.

public

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

References $a_type.

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

    {
        if (is_object(self::$instance[$a_type])) {
            return self::$instance[$a_type];
        }
        return self::$instance[$a_type] = new ilExportFieldsInfo($a_type);
    }

Here is the caller graph for this function:

exportableFieldsToInfoString()

ilExportFieldsInfo::exportableFieldsToInfoString

(

)

Get exportable fields as info string.

public

Returns

string info page string

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

References getExportableFields().

    {
        $fields = array();
        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.

public

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

Referenced by exportableFieldsToInfoString(), and getSelectableFieldsInfo().

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

Here is the caller graph for this function:

getFieldsInfo()

ilExportFieldsInfo::getFieldsInfo

(

)

Get informations (exportable) about user data profile fields.

public

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

References $possible_fields.

    {
        return $this->possible_fields;
    }

getSelectableFieldsInfo()

ilExportFieldsInfo::getSelectableFieldsInfo

(

$a_obj_id

)

Get selectable fields.

Returns

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

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

    {
        global $DIC;

        $lng = $DIC['lng'];
        
        $fields = array();
        foreach ($this->getExportableFields() as $field) {
            switch ($field) {
                case 'lastname':
                case 'firstname':
                    break;
    
                case 'username':
                    $fields['login']['txt'] = $lng->txt('login');
                    $fields['login']['default'] = 1;
                    break;
                
                default:
                    // #18795
                    $caption = ($field == "title")
                        ? "person_title"
                        : $field;
                    $fields[$field]['txt'] = $lng->txt($caption);
                    $fields[$field]['default'] = 0;
                    break;
            }
        }
        
        include_once './Services/Booking/classes/class.ilBookingEntry.php';
        if (ilBookingEntry::hasObjectBookingEntries($a_obj_id, $GLOBALS['DIC']['ilUser']->getId())) {
            $GLOBALS['DIC']['lng']->loadLanguageModule('dateplaner');
            $fields['consultation_hour']['txt'] = $GLOBALS['DIC']['lng']->txt('cal_ch_field_ch');
            $fields['consultation_hour']['default'] = 0;
        }
        
        include_once './Services/User/classes/class.ilUserDefinedFields.php';
        if ($this->getType() == 'crs') {
            $udf = ilUserDefinedFields::_getInstance()->getCourseExportableFields();
        } elseif ($this->getType() == 'grp') {
            $udf = ilUserDefinedFields::_getInstance()->getGroupExportableFields();
        }
        if ($udf) {
            foreach ($udf as $field_id => $field) {
                $fields['udf_' . $field_id]['txt'] = $field['field_name'];
                $fields['udf_' . $field_id]['default'] = 0;
            }
        }
        
        include_once './Modules/Course/classes/Export/class.ilCourseDefinedFieldDefinition.php';
        $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'] = $GLOBALS['DIC']['lng']->txt($this->getType() . '_cdf_tbl_last_edit');
            $fields['odf_last_update']['default'] = 0;
        }
        
        return $fields;
    }

Here is the call graph for this function:

getType()

ilExportFieldsInfo::getType

(

)

Get object type.

Returns

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

References $obj_type.

Referenced by getSelectableFieldsInfo(), and read().

    {
        return $this->obj_type;
    }

Here is the caller graph for this function:

isExportable()

ilExportFieldsInfo::isExportable

(

$a_field_name

)

Check if field is exportable.

public

Parameters

string

field name

Returns

bool

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

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

read()

ilExportFieldsInfo::read ( )

private

Read info about exportable fields.

private

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

References $data, $key, getType(), and settings().

Referenced by __construct().

    {
        include_once './Services/User/classes/class.ilUserProfile.php';
        
        $profile = new ilUserProfile();
        $profile->skipGroup('settings');
        
        foreach ($profile->getStandardFields() as $key => $data) {
            if ($this->getType() == 'crs') {
                if (!$data['course_export_hide']) {
                    if (isset($data['course_export_fix_value']) and $data['course_export_fix_value']) {
                        $this->possible_fields[$key] = $data['course_export_fix_value'];
                    } else {
                        $this->possible_fields[$key] = 0;
                    }
                }
            } elseif ($this->getType() == 'grp') {
                if (!$data['group_export_hide']) {
                    if (isset($data['group_export_fix_value']) and $data['group_export_fix_value']) {
                        $this->possible_fields[$key] = $data['group_export_fix_value'];
                    } else {
                        $this->possible_fields[$key] = 0;
                    }
                }
            }
        }
        $settings_all = $this->settings->getAll();

        $field_part_limit = 5;
        switch ($this->getType()) {
            case 'crs':
                $field_prefix = 'usr_settings_course_export_';
                $field_part_limit = 5;
                break;
                
            case 'grp':
                $field_prefix = 'usr_settings_group_export_';
                $field_part_limit = 5;
                break;
        }
        
        foreach ($settings_all as $key => $value) {
            if (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;
                }
            }
        }
        return true;
    }

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

References $key.

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

$db

ilExportFieldsInfo::$db

private

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

$instance

ilExportFieldsInfo::$instance = null

staticprivate

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

$lng

ilExportFieldsInfo::$lng

private

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

Referenced by __construct(), and getSelectableFieldsInfo().

$obj_type

ilExportFieldsInfo::$obj_type = ''

private

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

Referenced by getType().

$possible_fields

ilExportFieldsInfo::$possible_fields = array()

private

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

Referenced by getFieldsInfo().

$settings

ilExportFieldsInfo::$settings

private

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

---

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

• Services/PrivacySecurity/classes/class.ilExportFieldsInfo.php