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

Collaboration diagram for ilMemberExport:

Public Member Functions
	__construct (int $a_ref_id, int $a_type=self::EXPORT_CSV)

	filterUsers (array $a_usr_ids)

	setFilename (string $a_file)

	getFilename ()

	getRefId ()

	getType ()

	getExportType ()

	getObjId ()

	create ()

	getCSVString ()

	createExcel ()

	createCSV ()

Data Fields
const	EXPORT_CSV = 1

const	EXPORT_EXCEL = 2

Protected Member Functions
	addCol (string $a_value, int $a_row, int $a_col)
	Write one column. More...

	addRow ()

	getOrderedExportableFields ()

	write ()

	initMembers ()
	Init member object. More...

	initGroups ()

Protected Attributes
ilLanguage	$lng

ilTree	$tree

ilAccessHandler	$access

array	$agreement = []

ilUserFormSettings	$settings

ilPrivacySettings	$privacy

ilCSVWriter	$csv = null

ilExcel	$worksheet = null

Private Member Functions
	fetchUsers ()

	readCourseData (array $a_user_ids)
	Read All User related course data. More...

	readCourseSpecificFieldsData ()

	addCourseField (int $a_usr_id, string $a_field, int $row, int $col)
	Fill course specific fields. More...

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

Private Attributes
int	$ref_id

int	$obj_id

string	$type

int	$export_type

ilParticipants	$members

array	$groups = []

array	$groups_participants = []

array	$groups_rights = []

string	$filename = null

array	$user_ids = array()

array	$user_course_data = array()

array	$user_course_fields = array()

array	$user_profile_data = array()

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 26 of file class.ilMemberExport.php.

Constructor & Destructor Documentation

◆ __construct()

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

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

References $DIC, ilObject\_lookupType(), ilMemberAgreement\_readByObjId(), ILIAS\Repository\access(), ilPrivacySettings\getInstance(), initGroups(), initMembers(), ILIAS\Repository\lng(), and ILIAS\Repository\settings().

     {
         global $DIC;
 
         $ilObjDataCache = $DIC['ilObjDataCache'];
 
         $this->lng = $DIC->language();
         $this->tree = $DIC->repositoryTree();
         $this->access = $DIC->access();
 
         $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	(	string	$a_value,
		int	$a_row,
		int	$a_col
	)

protected

Write one column.

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

References getExportType().

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

                                                                       : void
     {
         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	(	int	$a_usr_id,
		string	$a_field,
		int	$row,
		int	$col
	)

private

Fill course specific fields.

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

References addCol().

Referenced by write().

                                                                                        : bool
     {
         if (strpos($a_field, 'cdf_') !== 0) {
             return false;
         }
         if (
             !$this->privacy->courseConfirmationRequired() ||
             ($this->agreement[$a_usr_id]['accepted'] ?? false)
         ) {
             $field_info = explode('_', $a_field);
             $field_id = $field_info[1] ?? 0;
             $value = '';
             if (isset($this->user_course_fields[$a_usr_id][$field_id])) {
                 $value = $this->user_course_fields[$a_usr_id][$field_id];
             }
             $this->addCol((string) $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

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

References getExportType().

Referenced by write().

                                : void
     {
         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	(	ilUserDefinedData	$udf_data,
		string	$a_field,
		int	$row,
		int	$col
	)

private

Add user defined fields.

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

References addCol(), ilUserDefinedData\get(), and ilUserDefinedData\getUserId().

Referenced by write().

                                                                                                           : bool
     {
         if (strpos($a_field, 'udf_') !== 0) {
             return false;
         }
 
         if (
             !$this->privacy->courseConfirmationRequired() ||
             (isset($this->agreement[$udf_data->getUserId()]['accepted']) &&
                 $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 ( )

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

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

                             : void
     {
         $this->fetchUsers();
         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 ( )

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

References write().

Referenced by create().

                                : void
     {
         $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 ( )

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

References getFilename(), ILIAS\Repository\lng(), and write().

Referenced by create().

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

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

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

Referenced by create().

                                  : void
     {
         $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);
         }
         if ($this->settings->enabled('waiting_list')) {
             $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 ( array $a_usr_ids )

Parameters

int[] $a_usr_ids

Returns: int[]

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

References ILIAS\Repository\access().

Referenced by fetchUsers().

                                                  : array
     {
         return $this->access->filterUserIdsByRbacOrPositionOfCurrentUser(
             'manage_members',
             'manage_members',
             $this->ref_id,
             $a_usr_ids
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCSVString()

ilMemberExport::getCSVString ( )

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

                                   : ?string
     {
         if ($this->csv instanceof ilCSVWriter) {
             return $this->csv->getCSVString();
         }
         return null;
     }

◆ getExportType()

ilMemberExport::getExportType ( )

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

References $export_type.

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

                                    : int
     {
         return $this->export_type;
     }

Here is the caller graph for this function:

◆ getFilename()

ilMemberExport::getFilename ( )

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

References $filename.

Referenced by createExcel().

                                  : ?string
     {
         return $this->filename;
     }

Here is the caller graph for this function:

◆ getObjId()

ilMemberExport::getObjId ( )

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

References $obj_id.

Referenced by initMembers().

                               : int
     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getOrderedExportableFields()

ilMemberExport::getOrderedExportableFields ( )

protected

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

References ilCourseDefinedFieldDefinition\_getFields(), ilUserDefinedFields\_getInstance(), ilExportFieldsInfo\_getInstanceByType(), ilObject\_lookupType(), ilPrivacySettings\courseConfirmationRequired(), ilPrivacySettings\getInstance(), and ILIAS\Repository\settings().

Referenced by write().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRefId()

ilMemberExport::getRefId ( )

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

References $ref_id.

                               : int
     {
         return $this->ref_id;
     }

◆ getType()

ilMemberExport::getType ( )

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

References $type.

Referenced by initMembers(), and readCourseData().

                              : string
     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ initGroups()

ilMemberExport::initGroups ( )

protected

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

References ilGroupParticipants\_getInstanceByObjId(), and ILIAS\Repository\access().

Referenced by __construct().

                                    : void
     {
         $parent_node = $this->tree->getNodeData($this->ref_id);
         $groups = $this->tree->getSubTree($parent_node, true, ['grp']);
         if (is_array($groups) && count($groups)) {
             $this->groups_rights = [];
             foreach ($groups as $idx => $group_data) {
                 // check for group in group
                 if (
                     $group_data["parent"] != $this->ref_id &&
                     $this->tree->checkForParentType((int) $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
                     $this->groups_rights[$group_data["ref_id"]] =
                         $this->access->checkAccess("write", "", (int) $group_data["ref_id"]);
                     $gobj = ilGroupParticipants::_getInstanceByObjId((int) $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.

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

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

Referenced by __construct().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readCourseData()

ilMemberExport::readCourseData ( array $a_user_ids )

private

Read All User related course data.

Parameters

int[]
string

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

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

Referenced by fetchUsers().

                                                       : void
     {
         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' ? ilParticipants::IL_CRS_ADMIN : ilParticipants::IL_GRP_ADMIN;
             } elseif ($this->members->isTutor($user_id)) {
                 $this->user_course_data[$user_id]['role'] = ilParticipants::IL_CRS_TUTOR;
             } elseif ($this->members->isMember($user_id)) {
                 $this->user_course_data[$user_id]['role'] = $this->getType() === 'crs' ? ilParticipants::IL_CRS_MEMBER : ilParticipants::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

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

References ilCourseUserData\_getValuesByObjId().

Referenced by fetchUsers().

                                                    : void
     {
         $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 ( string $a_file )

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

                                                : void
     {
         $this->filename = $a_file;
     }

◆ write()

ilMemberExport::write ( )

protected

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

References $GLOBALS, ilUserDefinedFields\_getInstance(), ilCourseDefinedFieldDefinition\_lookupName(), addCol(), addCourseField(), addRow(), addUserDefinedField(), ilDatePresentation\formatPeriod(), ILIAS\Survey\Mode\getId(), getOrderedExportableFields(), IL_CAL_DATETIME, IL_CAL_UNIX, ilParticipants\IL_CRS_ADMIN, ilParticipants\IL_CRS_MEMBER, ilParticipants\IL_CRS_TUTOR, ilParticipants\IL_GRP_ADMIN, ilParticipants\IL_GRP_MEMBER, ILIAS\Repository\int(), ILIAS\Repository\lng(), ilBookingEntry\lookupManagedBookingsForObject(), ilObjUser\lookupOrgUnitsRepresentation(), and ilDatePresentation\setUseRelativeDates().

Referenced by createCSV(), and createExcel().

                               : void
     {
         // Add header line
         $row = 0;
         $col = 0;
         foreach ($all_fields = $this->getOrderedExportableFields() as $field) {
             switch ($field) {
                 case 'role':
                     $this->addCol($this->lng->txt($this->getType() . '_role_status'), $row, $col++);
                     break;
                 case 'agreement':
                     $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 (strpos($field, 'udf_') === 0) {
                         $field_id = explode('_', $field);
                         $udf = ilUserDefinedFields::_getInstance();
                         $def = $udf->getDefinition((int) $field_id[1]);
                         #$this->csv->addColumn($def['field_name']);
                         $this->addCol($def['field_name'], $row, $col++);
                     } elseif (strpos($field, 'cdf_') === 0) {
                         $field_id = explode('_', $field);
                         #$this->csv->addColumn(ilCourseDefinedFieldDefinition::_lookupName($field_id[1]));
                         $this->addCol(ilCourseDefinedFieldDefinition::_lookupName((int) $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->addRow();
         // Add user data
         foreach ($this->user_ids as $usr_id) {
             $row++;
             $col = 0;
             $usr_id = (int) $usr_id;
 
             $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 ilParticipants::IL_CRS_ADMIN:
                                 $this->addCol($this->lng->txt('crs_admin'), $row, $col++);
                                 break;
 
                             case ilParticipants::IL_CRS_TUTOR:
                                 $this->addCol($this->lng->txt('crs_tutor'), $row, $col++);
                                 break;
 
                             case ilParticipants::IL_CRS_MEMBER:
                                 $this->addCol($this->lng->txt('crs_member'), $row, $col++);
                                 break;
 
                             case ilParticipants::IL_GRP_ADMIN:
                                 $this->addCol($this->lng->txt('il_grp_admin'), $row, $col++);
                                 break;
 
                             case ilParticipants::IL_GRP_MEMBER:
                                 $this->addCol($this->lng->txt('il_grp_member'), $row, $col++);
                                 break;
 
                             case 'subscriber':
                                 $this->addCol($this->lng->txt($this->getType() . '_subscriber'), $row, $col++);
                                 break;
 
                             default:
                                 $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']) {
                                 $dt = new ilDateTime($this->agreement[$usr_id]['acceptance_time'], IL_CAL_UNIX);
                                 $this->addCol($dt->get(IL_CAL_DATETIME), $row, $col++);
                             } else {
                                 $this->addCol($this->lng->txt('ps_not_accepted'), $row, $col++);
                             }
                         } else {
                             $this->addCol($this->lng->txt('ps_not_accepted'), $row, $col++);
                         }
                         break;
 
                         // These fields are always enabled
                     case 'username':
                         $this->addCol($this->user_profile_data[$usr_id]['login'], $row, $col++);
                         break;
 
                     case 'firstname':
                     case 'lastname':
                         $this->addCol($this->user_profile_data[$usr_id][$field], $row, $col++);
                         break;
 
                     case 'consultation_hour':
                         $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
                             (isset($this->agreement[$usr_id]['accepted']) &&
                                 $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->addRow();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $access

ilAccessHandler ilMemberExport::$access

protected

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

◆ $agreement

array ilMemberExport::$agreement = []

protected

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

◆ $csv

ilCSVWriter ilMemberExport::$csv = null

protected

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

◆ $export_type

int ilMemberExport::$export_type

private

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

Referenced by getExportType().

◆ $filename

string ilMemberExport::$filename = null

private

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

Referenced by getFilename().

◆ $groups

array ilMemberExport::$groups = []

private

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

◆ $groups_participants

array ilMemberExport::$groups_participants = []

private

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

◆ $groups_rights

array ilMemberExport::$groups_rights = []

private

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

◆ $lng

ilLanguage ilMemberExport::$lng

protected

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

◆ $members

ilParticipants ilMemberExport::$members

private

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

◆ $obj_id

int ilMemberExport::$obj_id

private

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

Referenced by getObjId().

◆ $privacy

ilPrivacySettings ilMemberExport::$privacy

protected

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

◆ $ref_id

int ilMemberExport::$ref_id

private

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

Referenced by getRefId().

◆ $settings

ilUserFormSettings ilMemberExport::$settings

protected

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

◆ $tree

ilTree ilMemberExport::$tree

protected

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

◆ $type

string ilMemberExport::$type

private

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

Referenced by getType().

◆ $user_course_data

array ilMemberExport::$user_course_data = array()

private

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

◆ $user_course_fields

array ilMemberExport::$user_course_fields = array()

private

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

◆ $user_ids

array ilMemberExport::$user_ids = array()

private

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

Referenced by fetchUsers().

◆ $user_profile_data

array ilMemberExport::$user_profile_data = array()

private

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

◆ $worksheet

ilExcel ilMemberExport::$worksheet = null

protected

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

◆ EXPORT_CSV

const ilMemberExport::EXPORT_CSV = 1

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

◆ EXPORT_EXCEL

const ilMemberExport::EXPORT_EXCEL = 2

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

Protected Attributes

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

◆ $access

◆ $agreement

◆ $csv

◆ $export_type

◆ $filename

◆ $groups

◆ $groups_participants

◆ $groups_rights

◆ $lng

◆ $members

◆ $obj_id

◆ $privacy

◆ $ref_id

◆ $settings

◆ $tree

◆ $type

◆ $user_course_data

◆ $user_course_fields

◆ $user_ids

◆ $user_profile_data

◆ $worksheet

◆ EXPORT_CSV

◆ EXPORT_EXCEL