ILIAS
Release_5_0_x_branch Revision 61816
|
Class for generation of member export files. More...
Public Member Functions | |
__construct ($a_ref_id, $a_type=self::EXPORT_CSV) | |
Constructor. | |
setFilename ($a_file) | |
set filename | |
getFilename () | |
get filename | |
getRefId () | |
get ref_id | |
getType () | |
get obj type | |
getExportType () | |
get current export type | |
getObjId () | |
Get obj id. | |
create () | |
Create Export File. | |
getCSVString () | |
toString method | |
createExcel () | |
createCSV () | |
Create CSV File. |
Data Fields | |
const | EXPORT_CSV = 1 |
const | EXPORT_EXCEL = 2 |
Protected Member Functions | |
addCol ($a_value, $a_row, $a_col) | |
Write on column. | |
addRow () | |
Add row. | |
getOrderedExportableFields () | |
Get ordered enabled fields. | |
write () | |
Write data. | |
initMembers () | |
Init member object. |
Private Member Functions | |
fetchUsers () | |
Fetch all users that will be exported. | |
readCourseData ($a_user_ids, $a_status= 'member') | |
Read All User related course data. | |
readCourseSpecificFieldsData () | |
Read course specific fields data. | |
addCourseField ($a_usr_id, $a_field, $row, $col) | |
fill course specific fields | |
addUserDefinedField ($udf_data, $a_field, $row, $col) | |
Add user defined fields. |
Private Attributes | |
$ref_id | |
$obj_id | |
$type | |
$members | |
$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 72 of file class.ilMemberExport.php.
References $lng, ilPrivacySettings\_getInstance(), ilObject\_lookupType(), ilMemberAgreement\_readByObjId(), and initMembers().
|
protected |
Write on column.
object | $a_value | |
object | $a_row | |
object | $a_col |
Definition at line 220 of file class.ilMemberExport.php.
References getExportType().
Referenced by addCourseField(), addUserDefinedField(), and write().
|
private |
fill course specific fields
private
int | usr_id |
string | field |
Definition at line 599 of file class.ilMemberExport.php.
References $row, ilCourseDefinedFieldDefinition\_getFields(), and addCol().
Referenced by write().
|
protected |
Add row.
Definition at line 238 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 629 of file class.ilMemberExport.php.
References $row, and addCol().
Referenced by write().
ilMemberExport::create | ( | ) |
Create Export File.
public
Definition at line 152 of file class.ilMemberExport.php.
References createCSV(), createExcel(), fetchUsers(), and getExportType().
ilMemberExport::createCSV | ( | ) |
Create CSV File.
public
Definition at line 203 of file class.ilMemberExport.php.
References write().
Referenced by create().
ilMemberExport::createExcel | ( | ) |
Definition at line 186 of file class.ilMemberExport.php.
References getFilename(), and write().
Referenced by create().
|
private |
Fetch all users that will be exported.
private
Definition at line 509 of file class.ilMemberExport.php.
References $user_ids, ilObjUser\_readUsersProfileData(), ilUtil\_sortIds(), readCourseData(), and readCourseSpecificFieldsData().
Referenced by create().
ilMemberExport::getCSVString | ( | ) |
toString method
public
Definition at line 176 of file class.ilMemberExport.php.
ilMemberExport::getExportType | ( | ) |
get current export type
Definition at line 132 of file class.ilMemberExport.php.
References $export_type.
Referenced by addCol(), addRow(), and create().
ilMemberExport::getFilename | ( | ) |
get filename
Definition at line 105 of file class.ilMemberExport.php.
References $filename.
Referenced by createExcel().
ilMemberExport::getObjId | ( | ) |
Get obj id.
Definition at line 141 of file class.ilMemberExport.php.
References $obj_id.
Referenced by initMembers().
|
protected |
Get ordered enabled fields.
public
Definition at line 258 of file class.ilMemberExport.php.
References $privacy, ilCourseDefinedFieldDefinition\_getFields(), ilUserDefinedFields\_getInstance(), ilPrivacySettings\_getInstance(), ilExportFieldsInfo\_getInstanceByType(), ilCourseDefinedFieldDefinition\_hasFields(), and ilObject\_lookupType().
Referenced by write().
ilMemberExport::getRefId | ( | ) |
ilMemberExport::getType | ( | ) |
get obj type
Definition at line 123 of file class.ilMemberExport.php.
References $type.
Referenced by initMembers(), and readCourseData().
|
protected |
Init member object.
Definition at line 652 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 553 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 584 of file class.ilMemberExport.php.
References ilCourseUserData\_getValuesByObjId().
Referenced by fetchUsers().
ilMemberExport::setFilename | ( | $a_file | ) |
set filename
object | $a_file |
Definition at line 96 of file class.ilMemberExport.php.
|
protected |
Write data.
Definition at line 307 of file class.ilMemberExport.php.
References $GLOBALS, $row, ilCourseDefinedFieldDefinition\_getFields(), ilUserDefinedFields\_getInstance(), ilCourseDefinedFieldDefinition\_lookupName(), addCol(), addCourseField(), addRow(), addUserDefinedField(), ilDatePresentation\formatPeriod(), ilFormat\formatUnixTime(), getOrderedExportableFields(), IL_CAL_UNIX, IL_CRS_ADMIN, IL_CRS_MEMBER, IL_CRS_TUTOR, IL_GRP_ADMIN, IL_GRP_MEMBER, ilBookingEntry\lookupManagedBookingsForObject(), and ilDatePresentation\setUseRelativeDates().
Referenced by createCSV(), and createExcel().
|
private |
Definition at line 57 of file class.ilMemberExport.php.
Referenced by getExportType().
|
private |
Definition at line 58 of file class.ilMemberExport.php.
Referenced by getFilename().
|
private |
Definition at line 53 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 64 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 55 of file class.ilMemberExport.php.
|
private |
Definition at line 50 of file class.ilMemberExport.php.
Referenced by getType().
|
private |
Definition at line 61 of file class.ilMemberExport.php.
|
private |
Definition at line 62 of file class.ilMemberExport.php.
|
private |
Definition at line 60 of file class.ilMemberExport.php.
Referenced by fetchUsers().
|
private |
Definition at line 63 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().