ILIAS
release_5-3 Revision v5.3.23-19-g915713cf615
|
Class for generation of member export files. More...
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 | |
Class for generation of member export files.
/
Definition at line 42 of file class.ilMemberExport.php.
ilMemberExport::__construct | ( | $a_ref_id, | |
$a_type = self::EXPORT_CSV |
|||
) |
Constructor.
public
Definition at line 75 of file class.ilMemberExport.php.
References $a_type, $lng, ilPrivacySettings\_getInstance(), ilObject\_lookupType(), ilMemberAgreement\_readByObjId(), initGroups(), initMembers(), and settings().
|
protected |
Write on column.
object | $a_value | |
object | $a_row | |
object | $a_col |
Definition at line 234 of file class.ilMemberExport.php.
References getExportType(), and worksheet.
Referenced by addCourseField(), addUserDefinedField(), and write().
|
private |
fill course specific fields
private
int | usr_id |
string | field |
Definition at line 589 of file class.ilMemberExport.php.
References $row, and addCol().
Referenced by write().
|
protected |
Add row.
Definition at line 251 of file class.ilMemberExport.php.
References getExportType().
Referenced by write().
|
private |
Add user defined fields.
private
object | user defined data object |
int | field |
Definition at line 615 of file class.ilMemberExport.php.
References $row, and addCol().
Referenced by write().
ilMemberExport::create | ( | ) |
Create Export File.
public
Definition at line 167 of file class.ilMemberExport.php.
References createCSV(), createExcel(), fetchUsers(), and getExportType().
ilMemberExport::createCSV | ( | ) |
Create CSV File.
public
Definition at line 217 of file class.ilMemberExport.php.
References write().
Referenced by create().
ilMemberExport::createExcel | ( | ) |
Definition at line 200 of file class.ilMemberExport.php.
References getFilename(), worksheet, and write().
Referenced by create().
|
private |
Fetch all users that will be exported.
private
Definition at line 511 of file class.ilMemberExport.php.
References $user_ids, ilObjUser\_readUsersProfileData(), ilUtil\_sortIds(), filterUsers(), readCourseData(), readCourseSpecificFieldsData(), and settings().
Referenced by create().
ilMemberExport::filterUsers | ( | $a_usr_ids | ) |
Definition at line 96 of file class.ilMemberExport.php.
References $GLOBALS.
Referenced by fetchUsers().
ilMemberExport::getCSVString | ( | ) |
ilMemberExport::getExportType | ( | ) |
get current export type
Definition at line 147 of file class.ilMemberExport.php.
References $export_type.
Referenced by addCol(), addRow(), and create().
ilMemberExport::getFilename | ( | ) |
get filename
Definition at line 120 of file class.ilMemberExport.php.
References $filename.
Referenced by createExcel().
ilMemberExport::getObjId | ( | ) |
Get obj id.
Definition at line 156 of file class.ilMemberExport.php.
References $obj_id.
Referenced by initMembers().
|
protected |
Get ordered enabled fields.
public
Definition at line 270 of file class.ilMemberExport.php.
References $privacy, ilCourseDefinedFieldDefinition\_getFields(), ilUserDefinedFields\_getInstance(), ilPrivacySettings\_getInstance(), ilExportFieldsInfo\_getInstanceByType(), ilObject\_lookupType(), array, and settings().
Referenced by write().
ilMemberExport::getRefId | ( | ) |
ilMemberExport::getType | ( | ) |
get obj type
Definition at line 138 of file class.ilMemberExport.php.
References $type.
Referenced by initMembers(), and readCourseData().
|
protected |
Definition at line 647 of file class.ilMemberExport.php.
References $groups, ilGroupParticipants\_getInstanceByObjId(), and array.
Referenced by __construct().
|
protected |
Init member object.
Definition at line 636 of file class.ilMemberExport.php.
References ilGroupParticipants\_getInstanceByObjId(), ilCourseParticipants\_getInstanceByObjId(), getObjId(), and getType().
Referenced by __construct().
|
private |
Read All User related course data.
private
Definition at line 551 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().
|
private |
Read course specific fields data.
private
Definition at line 574 of file class.ilMemberExport.php.
References ilCourseUserData\_getValuesByObjId().
Referenced by fetchUsers().
ilMemberExport::setFilename | ( | $a_file | ) |
set filename
object | $a_file |
Definition at line 111 of file class.ilMemberExport.php.
|
protected |
Write data.
Definition at line 316 of file class.ilMemberExport.php.
References $def, $GLOBALS, $groups, $row, ilUserDefinedFields\_getInstance(), ilCourseDefinedFieldDefinition\_lookupName(), addCol(), addCourseField(), addRow(), addUserDefinedField(), array, 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().
|
private |
Definition at line 60 of file class.ilMemberExport.php.
Referenced by getExportType().
|
private |
Definition at line 61 of file class.ilMemberExport.php.
Referenced by getFilename().
|
private |
Definition at line 52 of file class.ilMemberExport.php.
Referenced by initGroups(), and write().
|
private |
Definition at line 53 of file class.ilMemberExport.php.
|
private |
Definition at line 54 of file class.ilMemberExport.php.
|
private |
Definition at line 56 of file class.ilMemberExport.php.
Referenced by __construct().
|
private |
Definition at line 51 of file class.ilMemberExport.php.
|
private |
Definition at line 49 of file class.ilMemberExport.php.
Referenced by getObjId().
|
private |
Definition at line 67 of file class.ilMemberExport.php.
Referenced by getOrderedExportableFields().
|
private |
Definition at line 48 of file class.ilMemberExport.php.
Referenced by getRefId().
|
private |
Definition at line 58 of file class.ilMemberExport.php.
|
private |
Definition at line 50 of file class.ilMemberExport.php.
Referenced by getType().
|
private |
Definition at line 64 of file class.ilMemberExport.php.
|
private |
Definition at line 65 of file class.ilMemberExport.php.
|
private |
Definition at line 63 of file class.ilMemberExport.php.
Referenced by fetchUsers().
|
private |
Definition at line 66 of file class.ilMemberExport.php.
const ilMemberExport::EXPORT_CSV = 1 |
Definition at line 44 of file class.ilMemberExport.php.
const ilMemberExport::EXPORT_EXCEL = 2 |
Definition at line 45 of file class.ilMemberExport.php.
Referenced by ilMemberExportGUI\exportExcel().