|
ILIAS
release_6 Revision v6.24-5-g0c8bfefb3b8
|
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 | |
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.
@access 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().
Here is the call graph for this function:
|
protected |
Write on column.
| object | $a_value | |
| object | $a_row | |
| object | $a_col |
Definition at line 237 of file class.ilMemberExport.php.
References EXPORT_CSV, EXPORT_EXCEL, and getExportType().
Referenced by addCourseField(), addUserDefinedField(), and write().
Here is the call graph for this function:
Here is the caller graph for this function:
|
private |
fill course specific fields
@access private
| int | usr_id |
| string | field |
Definition at line 592 of file class.ilMemberExport.php.
References addCol().
Referenced by write().
Here is the call graph for this function:
Here is the caller graph for this function:
|
protected |
Add row.
Definition at line 254 of file class.ilMemberExport.php.
References EXPORT_CSV, EXPORT_EXCEL, and getExportType().
Referenced by write().
Here is the call graph for this function:
Here is the caller graph for this function:
|
private |
Add user defined fields.
@access private
| object | user defined data object |
| int | field |
Definition at line 618 of file class.ilMemberExport.php.
References addCol().
Referenced by write().
Here is the call graph for this function:
Here is the caller graph for this function:| ilMemberExport::create | ( | ) |
Create Export File.
@access public
Definition at line 170 of file class.ilMemberExport.php.
References createCSV(), createExcel(), EXPORT_CSV, EXPORT_EXCEL, fetchUsers(), and getExportType().
Here is the call graph for this function:| ilMemberExport::createCSV | ( | ) |
Create CSV File.
@access public
Definition at line 220 of file class.ilMemberExport.php.
References write().
Referenced by create().
Here is the call graph for this function:
Here is the caller graph for this function:| ilMemberExport::createExcel | ( | ) |
Definition at line 203 of file class.ilMemberExport.php.
References getFilename(), and write().
Referenced by create().
Here is the call graph for this function:
Here is the caller graph for this function:
|
private |
Fetch all users that will be exported.
@access private
Definition at line 514 of file class.ilMemberExport.php.
References ilObjUser\_readUsersProfileData(), ilUtil\_sortIds(), filterUsers(), readCourseData(), readCourseSpecificFieldsData(), and settings().
Referenced by create().
Here is the call graph for this function:
Here is the caller graph for this function:| ilMemberExport::filterUsers | ( | $a_usr_ids | ) |
Definition at line 99 of file class.ilMemberExport.php.
References $GLOBALS.
Referenced by fetchUsers().
Here is the caller graph for this function:| ilMemberExport::getCSVString | ( | ) |
toString method
@access public
Definition at line 193 of file class.ilMemberExport.php.
| ilMemberExport::getExportType | ( | ) |
get current export type
Definition at line 150 of file class.ilMemberExport.php.
References $export_type.
Referenced by addCol(), addRow(), and create().
Here is the caller graph for this function:| ilMemberExport::getFilename | ( | ) |
get filename
Definition at line 123 of file class.ilMemberExport.php.
References $filename.
Referenced by createExcel().
Here is the caller graph for this function:| ilMemberExport::getObjId | ( | ) |
Get obj id.
Definition at line 159 of file class.ilMemberExport.php.
References $obj_id.
Referenced by initMembers().
Here is the caller graph for this function:
|
protected |
Get ordered enabled fields.
@access public
Definition at line 273 of file class.ilMemberExport.php.
References $privacy, ilCourseDefinedFieldDefinition\_getFields(), ilPrivacySettings\_getInstance(), ilUserDefinedFields\_getInstance(), ilExportFieldsInfo\_getInstanceByType(), ilObject\_lookupType(), and settings().
Referenced by write().
Here is the call graph for this function:
Here is the caller graph for this function:| ilMemberExport::getRefId | ( | ) |
get ref_id
Definition at line 132 of file class.ilMemberExport.php.
References $ref_id.
| ilMemberExport::getType | ( | ) |
get obj type
Definition at line 141 of file class.ilMemberExport.php.
References $type.
Referenced by initMembers(), and readCourseData().
Here is the caller graph for this function:
|
protected |
Definition at line 652 of file class.ilMemberExport.php.
References $DIC, $groups, and ilGroupParticipants\_getInstanceByObjId().
Referenced by __construct().
Here is the call graph for this function:
Here is the caller graph for this function:
|
protected |
Init member object.
Definition at line 641 of file class.ilMemberExport.php.
References ilCourseParticipants\_getInstanceByObjId(), ilGroupParticipants\_getInstanceByObjId(), getObjId(), and getType().
Referenced by __construct().
Here is the call graph for this function:
Here is the caller graph for this function:
|
private |
Read All User related course data.
@access 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().
Here is the call graph for this function:
Here is the caller graph for this function:
|
private |
Read course specific fields data.
@access private
Definition at line 577 of file class.ilMemberExport.php.
References ilCourseUserData\_getValuesByObjId().
Referenced by fetchUsers().
Here is the call graph for this function:
Here is the caller graph for this function:| ilMemberExport::setFilename | ( | $a_file | ) |
set filename
| object | $a_file |
Definition at line 114 of file class.ilMemberExport.php.
|
protected |
Write data.
Definition at line 319 of file class.ilMemberExport.php.
References $GLOBALS, $groups, 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().
Here is the call graph for this function:
Here is the caller graph for this function:
|
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.
|
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 addCol(), addRow(), create(), and ilMemberExportGUI\exportExcel().