ilMemberExportGUI Class Reference

Collaboration diagram for ilMemberExportGUI:

Public Member Functions
	__construct ($a_ref_id)
	Constructor. More...
	executeCommand ()
	Execute Command. More...
	initCSV (ilPropertyFormGUI $a_form=null)
	initExcel (ilPropertyFormGUI $a_form=null)
	show ()
	Show list of export files. More...
	export ()
	Export Create member export file and store it in data directory. More...
	exportExcel ()
	deliverData ()
	Deliver Data. More...
	showFileList ()
	Show file list of available export files. More...
	downloadExportFile ()
	Download export file. More...
	confirmDeleteExportFile ()
	Confirm deletion of export files. More...
	deleteExportFile ()
	Delete member export files. More...

Protected Member Functions
	initSettingsForm ($a_is_excel=false)
	handleIncoming ()
	initFileSystemStorage ()
	Init file object. More...

Private Attributes
	$ref_id
	$obj_id
	$type
	$ctrl
	$tpl
	$lng
	$fields_info
	$fss_export = null
	$exportSettings

Detailed Description

Author

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

Version

$Id$

ilMemberExportGUI:

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

Constructor & Destructor Documentation

__construct()

ilMemberExportGUI::__construct

(

$a_ref_id

)

Constructor.

public

Parameters

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

References $ilCtrl, $ilUser, $lng, $tpl, ilExportFieldsInfo\_getInstanceByType(), ilObject\_lookupType(), and initFileSystemStorage().

    {
        global $ilCtrl,$tpl,$lng,$ilUser,$ilObjDataCache;
        
        $this->ctrl = $ilCtrl;
        $this->tpl = $tpl;
        $this->lng = $lng;
        $this->lng->loadLanguageModule('ps');
        $this->ref_id = $a_ref_id;
        $this->obj_id = $ilObjDataCache->lookupObjId($this->ref_id);
        $this->type = ilObject::_lookupType($this->obj_id);
        
        $this->fields_info = ilExportFieldsInfo::_getInstanceByType(ilObject::_lookupType($this->obj_id));
        $this->initFileSystemStorage();
    }

Here is the call graph for this function:

Member Function Documentation

confirmDeleteExportFile()

ilMemberExportGUI::confirmDeleteExportFile

(

)

Confirm deletion of export files.

public

Parameters

Definition at line 399 of file class.ilMemberExportGUI.php.

References $_POST, $counter, $file, ilDatePresentation\formatDate(), IL_CAL_UNIX, and ilUtil\sendFailure().

    {
        if (!count($_POST['id'])) {
            ilUtil::sendFailure($this->lng->txt('ps_select_one'), true);
            $this->ctrl->redirect($this, 'show');
        }
        
        include_once('./Services/Utilities/classes/class.ilConfirmationGUI.php');
        $confirmation_gui = new ilConfirmationGUI();
        $confirmation_gui->setFormAction($this->ctrl->getFormAction($this));
        $confirmation_gui->setHeaderText($this->lng->txt('info_delete_sure') /* .' '.$this->lng->txt('ps_delete_export_files') */);
        $confirmation_gui->setCancel($this->lng->txt('cancel'), 'show');
        $confirmation_gui->setConfirm($this->lng->txt('delete'), 'deleteExportFile');
                
        $counter = 0;
        foreach ($this->fss_export->getMemberExportFiles() as $file) {
            if (!in_array(md5($file['name']), $_POST['id'])) {
                continue;
            }
            
            $confirmation_gui->addItem(
                "id[]",
                md5($file['name']),
                strtoupper($file['type']) . ' - ' .
                ilDatePresentation::formatDate(new ilDateTime($file['timest'], IL_CAL_UNIX))
            );
        }
        
        $this->tpl->setContent($confirmation_gui->getHTML());
    }

Here is the call graph for this function:

deleteExportFile()

ilMemberExportGUI::deleteExportFile

(

)

Delete member export files.

public

Parameters

Definition at line 437 of file class.ilMemberExportGUI.php.

References $_POST, $counter, $file, $ret, and ilUtil\sendSuccess().

    {
        if (!count($_POST['id'])) {
            $this->ctrl->redirect($this, 'show');
        }
        
        $counter = 0;
        foreach ($this->fss_export->getMemberExportFiles() as $file) {
            if (!in_array(md5($file['name']), $_POST['id'])) {
                continue;
            }

            $ret = $this->fss_export->deleteMemberExportFile($file['timest'] . '_participant_export_' .
                $file['type'] . '_' . $this->obj_id . '.' . $file['type']);

            //try xlsx if return is false and type is xls
            if ($file['type'] == "xls" && !$ret) {
                $this->fss_export->deleteMemberExportFile($file['timest'] . '_participant_export_' .
                    $file['type'] . '_' . $this->obj_id . '.' . "xlsx");
            }
        }
        
        ilUtil::sendSuccess($this->lng->txt('ps_files_deleted'), true);
        $this->ctrl->redirect($this, 'show');
    }

Here is the call graph for this function:

deliverData()

ilMemberExportGUI::deliverData

(

)

Deliver Data.

public

Parameters

Definition at line 310 of file class.ilMemberExportGUI.php.

References $_SESSION, $file, date, and ilUtil\deliverData().

    {
        foreach ($this->fss_export->getMemberExportFiles() as $file) {
            if ($file['name'] == $_SESSION['member_export_filename']) {
                $content = $this->fss_export->getMemberExportFile($_SESSION['member_export_filename']);
                ilUtil::deliverData($content, date('Y_m_d_H-i', $file['timest']) .
                '_member_export_' .
                $this->obj_id .
                '.csv', 'text/csv');
            }
        }
    }

Here is the call graph for this function:

downloadExportFile()

ilMemberExportGUI::downloadExportFile

(

)

Download export file.

public

Parameters

Definition at line 343 of file class.ilMemberExportGUI.php.

References $_GET, $contents, $file, date, and ilUtil\deliverData().

    {
        $hash = trim($_GET['fl']);
        if (!$hash) {
            $this->ctrl->redirect($this, 'show');
        }
        
        foreach ($this->fss_export->getMemberExportFiles() as $file) {
            if (md5($file['name']) == $hash) {
                $contents = $this->fss_export->getMemberExportFile($file['timest'] . '_participant_export_' .
                    $file['type'] . '_' . $this->obj_id . '.' . $file['type']);
                
                // newer export files could be .xlsx
                if ($file['type'] == 'xls' && !$contents) {
                    $contents = $this->fss_export->getMemberExportFile($file['timest'] . '_participant_export_' .
                        $file['type'] . '_' . $this->obj_id . '.xlsx');
                    $file['type'] = 'xlsx';
                }

                switch ($file['type']) {
                    case 'xlsx':
                        ilUtil::deliverData(
                            $contents,
                            date('Y_m_d_H-i' . $file['timest']) . '_member_export_' . $this->obj_id . '.xlsx',
                            'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
                        );
                    
                        // no break
                    case 'xls':
                        ilUtil::deliverData(
                            $contents,
                            date('Y_m_d_H-i' . $file['timest']) . '_member_export_' . $this->obj_id . '.xls',
                            'application/vnd.ms-excel'
                        );

                        // no break
                    default:
                    case 'csv':
                        ilUtil::deliverData($contents, date('Y_m_d_H-i' . $file['timest']) .
                            '_member_export_' .
                            $this->obj_id .
                            '.csv', 'text/csv');
                        break;
                }
                return true;
            }
        }
    }

Here is the call graph for this function:

executeCommand()

ilMemberExportGUI::executeCommand

(

)

Execute Command.

public

Parameters

Definition at line 87 of file class.ilMemberExportGUI.php.

References ilPrivacySettings\_getInstance(), and ilUtil\sendFailure().

    {
        global $ilAccess,$rbacsystem;

        
        include_once('Services/PrivacySecurity/classes/class.ilPrivacySettings.php');
        if (!ilPrivacySettings::_getInstance()->checkExportAccess($this->ref_id)) {
            ilUtil::sendFailure($this->lng->txt('permission_denied'), true);
            $this->ctrl->returnToParent($this);
        }
        
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

        switch ($next_class) {
            default:
                if (!$cmd) {
                    $cmd = 'show';
                }
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

export()

ilMemberExportGUI::export

(

)

Export Create member export file and store it in data directory.

public

Definition at line 275 of file class.ilMemberExportGUI.php.

References $filename, handleIncoming(), and time.

Referenced by exportExcel().

    {
        $this->handleIncoming();
        
        $this->export = new ilMemberExport($this->ref_id);
        $this->export->create();
        
        $filename = time() . '_participant_export_csv_' . $this->obj_id . '.csv';
        $this->fss_export->addMemberExportFile($this->export->getCSVString(), $filename);

        $this->ctrl->redirect($this, 'show');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

exportExcel()

ilMemberExportGUI::exportExcel

(

)

Definition at line 288 of file class.ilMemberExportGUI.php.

References $filename, $obj_id, export(), ilMemberExport\EXPORT_EXCEL, handleIncoming(), and time.

    {
        $this->handleIncoming();
        
        $filename = time() . '_participant_export_xls_' . $this->obj_id;
        $this->fss_export->initMemberExportDirectory();
        $filepath = $this->fss_export->getMemberExportDirectory() . DIRECTORY_SEPARATOR . $filename;
        
        $this->export = new ilMemberExport($this->ref_id, ilMemberExport::EXPORT_EXCEL);
        $this->export->setFilename($filepath);
        $this->export->create();

        $this->ctrl->redirect($this, 'show');
    }

Here is the call graph for this function:

handleIncoming()

ilMemberExportGUI::handleIncoming ( )

protected

Definition at line 253 of file class.ilMemberExportGUI.php.

References $_POST, $id, and array.

Referenced by export(), and exportExcel().

    {
        $settings = array();
        $incoming = $_POST['export_members'];
        if (is_array($incoming)) {
            foreach ($incoming as $id) {
                $settings[$id] = true;
            }
        }
    
        // Save (form) settings
        $this->exportSettings = new ilUserFormSettings('memexp');
        $this->exportSettings->set($settings);
        $this->exportSettings->store();
    }

Here is the caller graph for this function:

initCSV()

ilMemberExportGUI::initCSV

(

ilPropertyFormGUI

$a_form = null

)

Definition at line 215 of file class.ilMemberExportGUI.php.

References initSettingsForm().

    {
        if (!$a_form) {
            $a_form = $this->initSettingsForm();
        }
        $this->tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

initExcel()

ilMemberExportGUI::initExcel

(

ilPropertyFormGUI

$a_form = null

)

Definition at line 223 of file class.ilMemberExportGUI.php.

References initSettingsForm().

    {
        if (!$a_form) {
            $a_form = $this->initSettingsForm(true);
        }
        $this->tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

initFileSystemStorage()

ilMemberExportGUI::initFileSystemStorage ( )

protected

Init file object.

Returns

Definition at line 468 of file class.ilMemberExportGUI.php.

Referenced by __construct().

    {
        if ($this->type == 'crs') {
            $this->fss_export = new ilFSStorageCourse($this->obj_id);
        }
        if ($this->type == 'grp') {
            $this->fss_export = new ilFSStorageGroup($this->obj_id);
        }
    }

Here is the caller graph for this function:

initSettingsForm()

ilMemberExportGUI::initSettingsForm (   $a_is_excel = false )

protected

Definition at line 116 of file class.ilMemberExportGUI.php.

References $form, $GLOBALS, ilCourseDefinedFieldDefinition\_getFields(), ilUserDefinedFields\_getInstance(), ilCheckboxGroupInputGUI\addOption(), array, ilBookingEntry\hasObjectBookingEntries(), and ilCheckboxInputGUI\setValue().

Referenced by initCSV(), and initExcel().

    {
        // Check user selection
        $this->exportSettings = new ilUserFormSettings('memexp');
        
        include_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt('ps_export_settings'));
                
        if ((bool) $a_is_excel) {
            $form->addCommandButton('exportExcel', $this->lng->txt('ps_export_excel'));
        } else {
            $form->addCommandButton('export', $this->lng->txt('ps_perform_export'));
        }
        $form->addCommandButton('show', $this->lng->txt('cancel'));
        
        // roles
        $roles = new ilCheckboxGroupInputGUI($this->lng->txt('ps_user_selection'), 'export_members');
        $roles->addOption(new ilCheckboxOption($this->lng->txt('ps_export_admin'), 'admin'));
        if ($this->type == 'crs') {
            $roles->addOption(new ilCheckboxOption($this->lng->txt('ps_export_tutor'), 'tutor'));
        }
        $roles->addOption(new ilCheckboxOption($this->lng->txt('ps_export_member'), 'member'));
        $roles->addOption(new ilCheckboxOption($this->lng->txt('ps_export_sub'), 'subscribers'));
        $roles->addOption(new ilCheckboxOption($this->lng->txt('ps_export_wait'), 'waiting_list'));
        $form->addItem($roles);
        
        $current_roles = array();
        foreach (array('admin', 'tutor', 'member', 'subscribers', 'waiting_list') as $role) {
            if ($this->exportSettings->enabled($role)) {
                $current_roles[] = $role;
            }
        }
        $roles->setValue($current_roles);
        
        // user data
        $current_udata = array();
        $udata = new ilCheckboxGroupInputGUI($this->lng->txt('ps_export_user_data'), 'export_members');
        $form->addItem($udata);
        
        // standard fields
        $this->fields_info->sortExportFields();
        foreach ($this->fields_info->getFieldsInfo() as $field => $exportable) {
            if (!$exportable) {
                continue;
            }
            $udata->addOption(new ilCheckboxOption($this->lng->txt($field), $field));
            if ($this->exportSettings->enabled($field)) {
                $current_udata[] = $field;
            }
        }
        
        // udf
        foreach (ilUserDefinedFields::_getInstance()->getExportableFields($this->obj_id) as $field_id => $udf_data) {
            $field = 'udf_' . $field_id;
            $udata->addOption(new ilCheckboxOption($udf_data['field_name'], $field));
            if ($this->exportSettings->enabled($field)) {
                $current_udata[] = $field;
            }
        }
        
        $udata->setValue($current_udata);
        
        // course custom data
        $cdf_fields = ilCourseDefinedFieldDefinition::_getFields($this->obj_id);
        if (count($cdf_fields)) {
            $cdf = new ilCheckboxGroupInputGUI($this->lng->txt('ps_' . $this->type . '_user_fields'), 'export_members');
            $form->addItem($cdf);
            
            $current_cdf = array();
            foreach ($cdf_fields as $field_obj) {
                $field = 'cdf_' . $field_obj->getId();
                $cdf->addOption(new ilCheckboxOption($field_obj->getName(), $field));
                if ($this->exportSettings->enabled($field)) {
                    $current_cdf[] = $field;
                }
            }
            
            $cdf->setValue($current_cdf);
        }
        
        // consultation hours
        include_once './Services/Booking/classes/class.ilBookingEntry.php';
        if (ilBookingEntry::hasObjectBookingEntries($this->obj_id, $GLOBALS['ilUser']->getId())) {
            $this->lng->loadLanguageModule('dateplaner');
            $chours = new ilCheckboxInputGUI($this->lng->txt('cal_ch_field_ch'), 'export_members[]');
            $chours->setValue('consultation_hour');
            $chours->setChecked($this->exportSettings->enabled('consultation_hour'));
            $form->addItem($chours);
        }

        $grp_membr = new ilCheckboxInputGUI($this->lng->txt('crs_members_groups'), 'export_members[]');
        $grp_membr->setValue('group_memberships');
        $grp_membr->setChecked($this->exportSettings->enabled('group_memberships'));
        $form->addItem($grp_membr);
        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

show()

ilMemberExportGUI::show

(

)

Show list of export files.

public

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

References showFileList().

    {
        global $ilToolbar;
        
        $ilToolbar->addButton(
            $this->lng->txt('ps_perform_export'),
            $this->ctrl->getLinkTarget($this, "initCSV")
        );
        $ilToolbar->addButton(
            $this->lng->txt('ps_export_excel'),
            $this->ctrl->getLinkTarget($this, "initExcel")
        );
        
        $this->showFileList();
    }

Here is the call graph for this function:

showFileList()

ilMemberExportGUI::showFileList

(

)

Show file list of available export files.

public

Definition at line 329 of file class.ilMemberExportGUI.php.

References $tbl.

Referenced by show().

    {
        include_once 'Services/Membership/classes/Export/class.ilMemberExportFileTableGUI.php';
        $tbl = new ilMemberExportFileTableGUI($this, 'show', $this->fss_export);
        $this->tpl->setContent($tbl->getHTML());
    }

Here is the caller graph for this function:

Field Documentation

$ctrl

ilMemberExportGUI::$ctrl

private

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

$exportSettings

ilMemberExportGUI::$exportSettings

private

Definition at line 55 of file class.ilMemberExportGUI.php.

$fields_info

ilMemberExportGUI::$fields_info

private

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

$fss_export

ilMemberExportGUI::$fss_export = null

private

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

$lng

ilMemberExportGUI::$lng

private

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

Referenced by __construct().

$obj_id

ilMemberExportGUI::$obj_id

private

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

Referenced by exportExcel().

$ref_id

ilMemberExportGUI::$ref_id

private

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

$tpl

ilMemberExportGUI::$tpl

private

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

Referenced by __construct().

$type

ilMemberExportGUI::$type

private

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

---

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

• Services/Membership/classes/Export/class.ilMemberExportGUI.php