Class for generation of member export files. More...

Collaboration diagram for ilMemberExport:

Public Member Functions
	__construct ($a_ref_id, $a_type=self::EXPORT_CSV)
	Constructor. More...

	filterUsers ($a_usr_ids)

	setFilename ($a_file)
	set filename More...

	getFilename ()
	get filename More...

	getRefId ()
	get ref_id More...

	getType ()
	get obj type More...

	getExportType ()
	get current export type More...

	getObjId ()
	Get obj id. More...

	create ()
	Create Export File. More...

	getCSVString ()
	toString method More...

	createExcel ()

	createCSV ()
	Create CSV File. More...

Data Fields
const	EXPORT_CSV = 1

const	EXPORT_EXCEL = 2

Protected Member Functions
	addCol ($a_value, $a_row, $a_col)
	Write on column. More...

	addRow ()
	Add row. More...

	getOrderedExportableFields ()
	Get ordered enabled fields. More...

	write ()
	Write data. More...

	initMembers ()
	Init member object. More...

	initGroups ()

Private Member Functions
	fetchUsers ()
	Fetch all users that will be exported. More...

	readCourseData ($a_user_ids, $a_status='member')
	Read All User related course data. More...

	readCourseSpecificFieldsData ()
	Read course specific fields data. More...

	addCourseField ($a_usr_id, $a_field, $row, $col)
	fill course specific fields More...

	addUserDefinedField ($udf_data, $a_field, $row, $col)
	Add user defined fields. More...

Private Attributes
	$ref_id

	$obj_id

	$type

	$members

	$groups = array()

	$groups_participants = array()

	$groups_rights = array()

	$lng

	$settings

	$export_type = null

	$filename = null

	$user_ids = array()

	$user_course_data = array()

	$user_course_fields = array()

	$user_profile_data = array()

	$privacy

Detailed Description

Class for generation of member export files.

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

Version: $Id$

/

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

Constructor & Destructor Documentation

◆ __construct()

ilMemberExport::__construct	(	$a_ref_id,
		$a_type = `self::EXPORT_CSV`
	)

Constructor.

public

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

References $a_type, $DIC, $lng, ilPrivacySettings\_getInstance(), ilObject\_lookupType(), ilMemberAgreement\_readByObjId(), initGroups(), initMembers(), and settings().

     {
         global $DIC;
 
         $ilObjDataCache = $DIC['ilObjDataCache'];
         $lng = $DIC['lng'];
         
         $this->lng = $lng;
         
         $this->export_type = $a_type;
         
         $this->ref_id = $a_ref_id;
         $this->obj_id = $ilObjDataCache->lookupObjId($this->ref_id);
         $this->type = ilObject::_lookupType($this->obj_id);
         
         $this->initMembers();
         $this->initGroups();
             
         $this->agreement = ilMemberAgreement::_readByObjId($this->obj_id);
         $this->settings = new ilUserFormSettings('memexp');
         $this->privacy = ilPrivacySettings::_getInstance();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addCol()

ilMemberExport::addCol	(	$a_value,
		$a_row,
		$a_col
	)

protected

Write on column.

Parameters

object	$a_value
object	$a_row
object	$a_col

Returns

Definition at line 237 of file class.ilMemberExport.php.

References getExportType().

Referenced by addCourseField(), addUserDefinedField(), and write().

     {
         switch ($this->getExportType()) {
             case self::EXPORT_CSV:
                 $this->csv->addColumn($a_value);
                 break;
                 
             case self::EXPORT_EXCEL:
                 $this->worksheet->setCell($a_row + 1, $a_col, $a_value);
                 break;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addCourseField()

ilMemberExport::addCourseField	(	$a_usr_id,
		$a_field,
		$row,
		$col
	)

private

fill course specific fields

private

Parameters

int	usr_id
string	field

Returns: bool

Definition at line 592 of file class.ilMemberExport.php.

References $row, and addCol().

Referenced by write().

     {
         if (substr($a_field, 0, 4) != 'cdf_') {
             return false;
         }
         if (!$this->privacy->courseConfirmationRequired() or $this->agreement[$a_usr_id]['accepted']) {
             $field_info = explode('_', $a_field);
             $field_id = $field_info[1];
             $value = $this->user_course_fields[$a_usr_id][$field_id];
             #$this->csv->addColumn($value);
             $this->addCol($value, $row, $col);
             return true;
         }
         #$this->csv->addColumn('');
         $this->addCol('', $row, $col);
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addRow()

ilMemberExport::addRow ( )

protected

Add row.

Returns

Definition at line 254 of file class.ilMemberExport.php.

References getExportType().

Referenced by write().

     {
         switch ($this->getExportType()) {
             case self::EXPORT_CSV:
                 $this->csv->addRow();
                 break;
             
             case self::EXPORT_EXCEL:
                 break;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addUserDefinedField()

ilMemberExport::addUserDefinedField	(	$udf_data,
		$a_field,
		$row,
		$col
	)

private

Add user defined fields.

private

Parameters

object	user defined data object
int	field

Definition at line 618 of file class.ilMemberExport.php.

References $row, and addCol().

Referenced by write().

     {
         if (substr($a_field, 0, 4) != 'udf_') {
             return false;
         }
 
         if (!$this->privacy->courseConfirmationRequired() or $this->agreement[$udf_data->getUserId()]['accepted']) {
             $field_info = explode('_', $a_field);
             $field_id = $field_info[1];
             $value = $udf_data->get('f_' . $field_id);
             #$this->csv->addColumn($value);
             $this->addCol($value, $row, $col);
             return true;
         }
 
         $this->addCol('', $row, $col);
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create()

ilMemberExport::create ( )

Create Export File.

public

Definition at line 170 of file class.ilMemberExport.php.

References createCSV(), createExcel(), fetchUsers(), and getExportType().

     {
         $this->fetchUsers();
         
         // DONE: Switch different export types
         switch ($this->getExportType()) {
             case self::EXPORT_CSV:
                 $this->createCSV();
                 break;
                 
             case self::EXPORT_EXCEL:
                 $this->createExcel();
                 break;
         }
     }

Here is the call graph for this function:

◆ createCSV()

ilMemberExport::createCSV ( )

Create CSV File.

public

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

References write().

Referenced by create().

     {
         include_once('Services/Utilities/classes/class.ilCSVWriter.php');
         $this->csv = new ilCSVWriter();
         
         $this->write();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createExcel()

ilMemberExport::createExcel ( )

Returns

Definition at line 203 of file class.ilMemberExport.php.

References getFilename(), and write().

Referenced by create().

     {
         include_once "./Services/Excel/classes/class.ilExcel.php";
         $this->worksheet = new ilExcel();
         $this->worksheet->addSheet($this->lng->txt("members"));
         
         $this->write();
         
         $this->worksheet->writeToFile($this->getFilename());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fetchUsers()

ilMemberExport::fetchUsers ( )

private

Fetch all users that will be exported.

private

Definition at line 514 of file class.ilMemberExport.php.

References $user_ids, ilObjUser\_readUsersProfileData(), ilUtil\_sortIds(), filterUsers(), readCourseData(), readCourseSpecificFieldsData(), and settings().

Referenced by create().

     {
         $this->readCourseSpecificFieldsData();
         
         if ($this->settings->enabled('admin')) {
             $this->user_ids = $tmp_ids = $this->members->getAdmins();
             $this->readCourseData($tmp_ids);
         }
         if ($this->settings->enabled('tutor')) {
             $this->user_ids = array_merge($tmp_ids = $this->members->getTutors(), $this->user_ids);
             $this->readCourseData($tmp_ids);
         }
         if ($this->settings->enabled('member')) {
             $this->user_ids = array_merge($tmp_ids = $this->members->getMembers(), $this->user_ids);
             $this->readCourseData($tmp_ids);
         }
         if ($this->settings->enabled('subscribers')) {
             $this->user_ids = array_merge($tmp_ids = $this->members->getSubscribers(), $this->user_ids);
             $this->readCourseData($tmp_ids, 'subscriber');
         }
         if ($this->settings->enabled('waiting_list')) {
             include_once('Modules/Course/classes/class.ilCourseWaitingList.php');
             $waiting_list = new ilCourseWaitingList($this->obj_id);
             $this->user_ids = array_merge($waiting_list->getUserIds(), $this->user_ids);
         }
         $this->user_ids = $this->filterUsers($this->user_ids);
 
         // Sort by lastname
         $this->user_ids = ilUtil::_sortIds($this->user_ids, 'usr_data', 'lastname', 'usr_id');
         
         // Finally read user profile data
         $this->user_profile_data = ilObjUser::_readUsersProfileData($this->user_ids);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ filterUsers()

ilMemberExport::filterUsers ( $a_usr_ids )

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

References $GLOBALS.

Referenced by fetchUsers().

     {
         return $GLOBALS['DIC']->access()->filterUserIdsByRbacOrPositionOfCurrentUser(
             'manage_members',
             'manage_members',
             $this->ref_id,
             $a_usr_ids
         );
     }

Here is the caller graph for this function:

◆ getCSVString()

ilMemberExport::getCSVString ( )

toString method

public

Parameters

Definition at line 193 of file class.ilMemberExport.php.

     {
         return $this->csv->getCSVString();
     }

◆ getExportType()

ilMemberExport::getExportType ( )

get current export type

Returns

Definition at line 150 of file class.ilMemberExport.php.

References $export_type.

Referenced by addCol(), addRow(), and create().

     {
         return $this->export_type;
     }

Here is the caller graph for this function:

◆ getFilename()

ilMemberExport::getFilename ( )

get filename

Returns

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

References $filename.

Referenced by createExcel().

     {
         return $this->filename;
     }

Here is the caller graph for this function:

◆ getObjId()

ilMemberExport::getObjId ( )

Get obj id.

Returns

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

References $obj_id.

Referenced by initMembers().

     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getOrderedExportableFields()

ilMemberExport::getOrderedExportableFields ( )

protected

Get ordered enabled fields.

public

Parameters

Definition at line 273 of file class.ilMemberExport.php.

References $privacy, ilCourseDefinedFieldDefinition\_getFields(), ilUserDefinedFields\_getInstance(), ilPrivacySettings\_getInstance(), ilExportFieldsInfo\_getInstanceByType(), ilObject\_lookupType(), and settings().

Referenced by write().

     {
         include_once('Services/PrivacySecurity/classes/class.ilPrivacySettings.php');
         include_once('Services/PrivacySecurity/classes/class.ilExportFieldsInfo.php');
         include_once('Modules/Course/classes/Export/class.ilCourseDefinedFieldDefinition.php');
         include_once('Services/User/classes/class.ilUserDefinedFields.php');
 
         $field_info = ilExportFieldsInfo::_getInstanceByType(ilObject::_lookupType($this->obj_id));
         $field_info->sortExportFields();
         $fields[] = 'role';
         // Append agreement info
         $privacy = ilPrivacySettings::_getInstance();
         if ($privacy->courseConfirmationRequired()) {
             $fields[] = 'agreement';
         }
 
         foreach ($field_info->getExportableFields() as $field) {
             if ($this->settings->enabled($field)) {
                 $fields[] = $field;
             }
         }
         
         $udf = ilUserDefinedFields::_getInstance();
         foreach ($udf->getCourseExportableFields() as $field_id => $udf_data) {
             if ($this->settings->enabled('udf_' . $field_id)) {
                 $fields[] = 'udf_' . $field_id;
             }
         }
         
         // Add course specific fields
         foreach (ilCourseDefinedFieldDefinition::_getFields($this->obj_id) as $field_obj) {
             if ($this->settings->enabled('cdf_' . $field_obj->getId())) {
                 $fields[] = 'cdf_' . $field_obj->getId();
             }
         }
         if ($this->settings->enabled('group_memberships')) {
             $fields[] = 'crs_members_groups';
         }
 
         return $fields ? $fields : array();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRefId()

ilMemberExport::getRefId ( )

get ref_id

Returns

Definition at line 132 of file class.ilMemberExport.php.

References $ref_id.

     {
         return $this->ref_id;
     }

◆ getType()

ilMemberExport::getType ( )

get obj type

Returns

Definition at line 141 of file class.ilMemberExport.php.

References $type.

Referenced by initMembers(), and readCourseData().

     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ initGroups()

ilMemberExport::initGroups ( )

protected

Definition at line 652 of file class.ilMemberExport.php.

References $DIC, $groups, $tree, and ilGroupParticipants\_getInstanceByObjId().

Referenced by __construct().

     {
         global $DIC;
 
         $tree = $DIC['tree'];
         $ilAccess = $DIC['ilAccess'];
         $parent_node = $tree->getNodeData($this->ref_id);
         $groups = $tree->getSubTree($parent_node, true, "grp");
         if (is_array($groups) && sizeof($groups)) {
             include_once('./Modules/Group/classes/class.ilGroupParticipants.php');
             $this->groups_rights = array();
             foreach ($groups as $idx => $group_data) {
                 // check for group in group
                 if ($group_data["parent"] != $this->ref_id && $tree->checkForParentType($group_data["ref_id"], "grp", true)) {
                     unset($groups[$idx]);
                 } else {
                     $this->groups[$group_data["ref_id"]] = $group_data["title"];
                     //TODO: change permissions from write to manage_members plus "|| ilObjGroup->getShowMembers()"----- uncomment below; testing required
                     //$obj = new ilObjGroup($group_data["ref_id"], true);
                     $this->groups_rights[$group_data["ref_id"]] = (bool) $ilAccess->checkAccess("write", "", $group_data["ref_id"])/* || $obj->getShowMembers()*/;
                     $gobj = ilGroupParticipants::_getInstanceByObjId($group_data["obj_id"]);
                     $this->groups_participants[$group_data["ref_id"]] = $gobj->getParticipants();
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initMembers()

ilMemberExport::initMembers ( )

protected

Init member object.

Returns

Definition at line 641 of file class.ilMemberExport.php.

References ilGroupParticipants\_getInstanceByObjId(), ilCourseParticipants\_getInstanceByObjId(), getObjId(), and getType().

Referenced by __construct().

     {
         if ($this->getType() == 'crs') {
             $this->members = ilCourseParticipants::_getInstanceByObjId($this->getObjId());
         }
         if ($this->getType() == 'grp') {
             $this->members = ilGroupParticipants::_getInstanceByObjId($this->getObjId());
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readCourseData()

ilMemberExport::readCourseData	(	$a_user_ids,
		$a_status = `'member'`
	)

private

Read All User related course data.

private

Definition at line 554 of file class.ilMemberExport.php.

References getType(), IL_CRS_ADMIN, IL_CRS_MEMBER, IL_CRS_TUTOR, IL_GRP_ADMIN, and IL_GRP_MEMBER.

Referenced by fetchUsers().

     {
         foreach ($a_user_ids as $user_id) {
             // Read course related data
             if ($this->members->isAdmin($user_id)) {
                 $this->user_course_data[$user_id]['role'] = $this->getType() == 'crs' ? IL_CRS_ADMIN : IL_GRP_ADMIN;
             } elseif ($this->members->isTutor($user_id)) {
                 $this->user_course_data[$user_id]['role'] = IL_CRS_TUTOR;
             } elseif ($this->members->isMember($user_id)) {
                 $this->user_course_data[$user_id]['role'] = $this->getType() == 'crs' ? IL_CRS_MEMBER : IL_GRP_MEMBER;
             } else {
                 $this->user_course_data[$user_id]['role'] = 'subscriber';
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readCourseSpecificFieldsData()

ilMemberExport::readCourseSpecificFieldsData ( )

private

Read course specific fields data.

private

Parameters

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

References ilCourseUserData\_getValuesByObjId().

Referenced by fetchUsers().

     {
         include_once('Modules/Course/classes/Export/class.ilCourseUserData.php');
         $this->user_course_fields = ilCourseUserData::_getValuesByObjId($this->obj_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFilename()

ilMemberExport::setFilename ( $a_file )

set filename

Parameters

object $a_file

Returns

Definition at line 114 of file class.ilMemberExport.php.

     {
         $this->filename = $a_file;
     }

◆ write()

ilMemberExport::write ( )

protected

Write data.

Returns

Definition at line 319 of file class.ilMemberExport.php.

References $def, $GLOBALS, $groups, $row, ilUserDefinedFields\_getInstance(), ilCourseDefinedFieldDefinition\_lookupName(), addCol(), addCourseField(), addRow(), addUserDefinedField(), ilDatePresentation\formatPeriod(), getOrderedExportableFields(), IL_CAL_DATETIME, IL_CAL_UNIX, IL_CRS_ADMIN, IL_CRS_MEMBER, IL_CRS_TUTOR, IL_GRP_ADMIN, IL_GRP_MEMBER, ilBookingEntry\lookupManagedBookingsForObject(), ilObjUser\lookupOrgUnitsRepresentation(), and ilDatePresentation\setUseRelativeDates().

Referenced by createCSV(), and createExcel().

     {
         // Add header line
         $row = 0;
         $col = 0;
         foreach ($all_fields = $this->getOrderedExportableFields() as $field) {
             switch ($field) {
                 case 'role':
                     #$this->csv->addColumn($this->lng->txt($this->getType().'_role_status'));
                     $this->addCol($this->lng->txt($this->getType() . '_role_status'), $row, $col++);
                     break;
                 case 'agreement':
                     #$this->csv->addColumn($this->lng->txt('ps_agreement_accepted'));
                     $this->addCol($this->lng->txt('ps_agreement_accepted'), $row, $col++);
                     break;
                 case 'consultation_hour':
                     $this->lng->loadLanguageModule('dateplaner');
                     $this->addCol($this->lng->txt('cal_ch_field_ch'), $row, $col++);
                     break;
                 
                 case 'org_units':
                     $this->addCol($this->lng->txt('org_units'), $row, $col++);
                     break;
                 
                 default:
                     if (substr($field, 0, 4) == 'udf_') {
                         $field_id = explode('_', $field);
                         include_once('Services/User/classes/class.ilUserDefinedFields.php');
                         $udf = ilUserDefinedFields::_getInstance();
                         $def = $udf->getDefinition($field_id[1]);
                         #$this->csv->addColumn($def['field_name']);
                         $this->addCol($def['field_name'], $row, $col++);
                     } elseif (substr($field, 0, 4) == 'cdf_') {
                         $field_id = explode('_', $field);
                         #$this->csv->addColumn(ilCourseDefinedFieldDefinition::_lookupName($field_id[1]));
                         $this->addCol(ilCourseDefinedFieldDefinition::_lookupName($field_id[1]), $row, $col++);
                     } elseif ($field == "username") {//User Name Presentation Guideline; username should be named login
                         $this->addCol($this->lng->txt("login"), $row, $col++);
                     } else {
                         #$this->csv->addColumn($this->lng->txt($field));
                         $this->addCol($this->lng->txt($field), $row, $col++);
                     }
                     break;
             }
         }
         #$this->csv->addRow();
         $this->addRow();
         // Add user data
         foreach ($this->user_ids as $usr_id) {
             $row++;
             $col = 0;
             
             $udf_data = new ilUserDefinedData($usr_id);
             foreach ($all_fields as $field) {
                 // Handle course defined fields
                 if ($this->addUserDefinedField($udf_data, $field, $row, $col)) {
                     $col++;
                     continue;
                 }
                 
                 if ($this->addCourseField($usr_id, $field, $row, $col)) {
                     $col++;
                     continue;
                 }
                 
                 switch ($field) {
                     case 'role':
                         switch ($this->user_course_data[$usr_id]['role']) {
                             case IL_CRS_ADMIN:
                                 #$this->csv->addColumn($this->lng->txt('crs_admin'));
                                 $this->addCol($this->lng->txt('crs_admin'), $row, $col++);
                                 break;
                                 
                             case IL_CRS_TUTOR:
                                 #$this->csv->addColumn($this->lng->txt('crs_tutor'));
                                 $this->addCol($this->lng->txt('crs_tutor'), $row, $col++);
                                 break;
 
                             case IL_CRS_MEMBER:
                                 #$this->csv->addColumn($this->lng->txt('crs_member'));
                                 $this->addCol($this->lng->txt('crs_member'), $row, $col++);
                                 break;
                                 
                             case IL_GRP_ADMIN:
                                 #$this->csv->addColumn($this->lng->txt('il_grp_admin'));
                                 $this->addCol($this->lng->txt('il_grp_admin'), $row, $col++);
                                 break;
                                 
                             case IL_GRP_MEMBER:
                                 #$this->csv->addColumn($this->lng->txt('il_grp_member'));
                                 $this->addCol($this->lng->txt('il_grp_member'), $row, $col++);
                                 break;
                                 
                             case 'subscriber':
                                 #$this->csv->addColumn($this->lng->txt($this->getType().'_subscriber'));
                                 $this->addCol($this->lng->txt($this->getType() . '_subscriber'), $row, $col++);
                                 break;
                             
                             default:
                                 #$this->csv->addColumn($this->lng->txt('crs_waiting_list'));
                                 $this->addCol($this->lng->txt('crs_waiting_list'), $row, $col++);
                                 break;
                             
                         }
                         break;
                     
                     case 'agreement':
                         if (isset($this->agreement[$usr_id])) {
                             if ($this->agreement[$usr_id]['accepted']) {
                                 #$this->csv->addColumn(il-Format::format-Unix-Time($this->agreement[$usr_id]['acceptance_time'],true));
                                 $dt = new ilDateTime($this->agreement[$usr_id]['acceptance_time'], IL_CAL_UNIX);
                                 $this->addCol($dt->get(IL_CAL_DATETIME), $row, $col++);
                             } else {
                                 #$this->csv->addColumn($this->lng->txt('ps_not_accepted'));
                                 $this->addCol($this->lng->txt('ps_not_accepted'), $row, $col++);
                             }
                         } else {
                             #$this->csv->addColumn($this->lng->txt('ps_not_accepted'));
                             $this->addCol($this->lng->txt('ps_not_accepted'), $row, $col++);
                         }
                         break;
                         
                     // These fields are always enabled
                     case 'username':
                         #$this->csv->addColumn($this->user_profile_data[$usr_id]['login']);
                         $this->addCol($this->user_profile_data[$usr_id]['login'], $row, $col++);
                         break;
                         
                     case 'firstname':
                     case 'lastname':
                         #$this->csv->addColumn($this->user_profile_data[$usr_id][$field]);
                         $this->addCol($this->user_profile_data[$usr_id][$field], $row, $col++);
                         break;
                     
                     case 'consultation_hour':
                         include_once './Services/Booking/classes/class.ilBookingEntry.php';
                         $bookings = ilBookingEntry::lookupManagedBookingsForObject($this->obj_id, $GLOBALS['DIC']['ilUser']->getId());
                         
                         $uts = array();
                         foreach ((array) $bookings[$usr_id] as $ut) {
                             ilDatePresentation::setUseRelativeDates(false);
                             $tmp = ilDatePresentation::formatPeriod(
                                 new ilDateTime($ut['dt'], IL_CAL_UNIX),
                                 new ilDateTime($ut['dtend'], IL_CAL_UNIX)
                             );
                             if (strlen($ut['explanation'])) {
                                 $tmp .= ' ' . $ut['explanation'];
                             }
                             $uts[] = $tmp;
                         }
                         $uts_str = implode(',', $uts);
                         $this->addCol($uts_str, $row, $col++);
                         break;
                     case 'crs_members_groups':
                         $groups = array();
 
                         foreach (array_keys($this->groups) as $grp_ref) {
                             if (in_array($usr_id, $this->groups_participants[$grp_ref])
                                 && $this->groups_rights[$grp_ref]) {
                                 $groups[] = $this->groups[$grp_ref];
                             }
                         }
                         $this->addCol(implode(", ", $groups), $row, $col++);
                         break;
                         
                     case 'org_units':
                         $this->addCol(ilObjUser::lookupOrgUnitsRepresentation($usr_id), $row, $col++);
                         break;
                         
                     default:
                         // Check aggreement
                         if (!$this->privacy->courseConfirmationRequired() or $this->agreement[$usr_id]['accepted']) {
                             #$this->csv->addColumn($this->user_profile_data[$usr_id][$field]);
                             $this->addCol($this->user_profile_data[$usr_id][$field], $row, $col++);
                         } else {
                             #$this->csv->addColumn('');
                             $this->addCol('', $row, $col++);
                         }
                         break;
                         
                 }
             }
             #$this->csv->addRow();
             $this->addRow();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $export_type

ilMemberExport::$export_type = null

private

Definition at line 60 of file class.ilMemberExport.php.

Referenced by getExportType().

◆ $filename

ilMemberExport::$filename = null

private

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

Referenced by getFilename().

◆ $groups

ilMemberExport::$groups = array()

private

Definition at line 52 of file class.ilMemberExport.php.

Referenced by initGroups(), and write().

◆ $groups_participants

ilMemberExport::$groups_participants = array()

private

Definition at line 53 of file class.ilMemberExport.php.

◆ $groups_rights

ilMemberExport::$groups_rights = array()

private

Definition at line 54 of file class.ilMemberExport.php.

◆ $lng

ilMemberExport::$lng

private

Definition at line 56 of file class.ilMemberExport.php.

Referenced by __construct().

◆ $members

ilMemberExport::$members

private

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

◆ $obj_id

ilMemberExport::$obj_id

private

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

Referenced by getObjId().

◆ $privacy

ilMemberExport::$privacy

private

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

Referenced by getOrderedExportableFields().

◆ $ref_id

ilMemberExport::$ref_id

private

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

Referenced by getRefId().

◆ $settings

ilMemberExport::$settings

private

Definition at line 58 of file class.ilMemberExport.php.

◆ $type

ilMemberExport::$type

private

Definition at line 50 of file class.ilMemberExport.php.

Referenced by getType().

◆ $user_course_data

ilMemberExport::$user_course_data = array()

private

Definition at line 64 of file class.ilMemberExport.php.

◆ $user_course_fields

ilMemberExport::$user_course_fields = array()

private

Definition at line 65 of file class.ilMemberExport.php.

◆ $user_ids

ilMemberExport::$user_ids = array()

private

Definition at line 63 of file class.ilMemberExport.php.

Referenced by fetchUsers().

◆ $user_profile_data

ilMemberExport::$user_profile_data = array()

private

Definition at line 66 of file class.ilMemberExport.php.

◆ EXPORT_CSV

const ilMemberExport::EXPORT_CSV = 1

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

◆ EXPORT_EXCEL

const ilMemberExport::EXPORT_EXCEL = 2

Definition at line 45 of file class.ilMemberExport.php.

Referenced by ilMemberExportGUI\exportExcel().

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

Services/Membership/classes/Export/class.ilMemberExport.php

Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCol()

◆ addCourseField()

◆ addRow()

◆ addUserDefinedField()

◆ create()

◆ createCSV()

◆ createExcel()

◆ fetchUsers()

◆ filterUsers()

◆ getCSVString()

◆ getExportType()

◆ getFilename()

◆ getObjId()

◆ getOrderedExportableFields()

◆ getRefId()

◆ getType()

◆ initGroups()

◆ initMembers()

◆ readCourseData()

◆ readCourseSpecificFieldsData()

◆ setFilename()

◆ write()

Field Documentation

◆ $export_type

◆ $filename

◆ $groups

◆ $groups_participants

◆ $groups_rights

◆ $lng

◆ $members

◆ $obj_id

◆ $privacy

◆ $ref_id

◆ $settings

◆ $type

◆ $user_course_data

◆ $user_course_fields

◆ $user_ids

◆ $user_profile_data

◆ EXPORT_CSV

◆ EXPORT_EXCEL