Inheritance diagram for ilMemberExportGUI:

Collaboration diagram for ilMemberExportGUI:

Public Member Functions
	__construct (int $a_ref_id)
	Constructor @access public. More...

	executeCommand ()

	initCSV (?ilPropertyFormGUI $a_form=null)

	initExcel (?ilPropertyFormGUI $a_form=null)

	show ()

	export ()
	Export, create member export file and store it in data directory. More...

	exportExcel ()

	deliverData ()

	showFileList ()
	Show file list of available export files. More...

	downloadExportFile (array $ids)
	Download export file. More...

	confirmDeleteExportFile (array $ids)
	Confirm deletion of export files. More...

	deleteExportFile ()
	Delete member export files. More...

Protected Member Functions
	initSettingsForm (bool $a_is_excel=false)

	handleIncoming ()

	getTableActionURLBuilder ()

	handleTableAction ()

	initFileIdsFromPost ()

	initFileSystemStorage ()

Protected Attributes
GlobalHttpState	$http

Factory	$refinery

ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

ilToolbarGUI	$toolbar

ilObjUser	$user

Profile	$profile

UIRenderer	$ui_renderer

UIFactory	$ui_factory

DataFactory	$data_factory

ilMemberExport	$export = null

ilExportFieldsInfo	$fields_info = null

ilFileSystemAbstractionStorage	$fss_export = null

ilUserFormSettings	$exportSettings

Private Attributes
int	$ref_id

int	$obj_id

string	$type

Detailed Description

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om \

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

Constructor & Destructor Documentation

◆ __construct()

ilMemberExportGUI::__construct ( int $a_ref_id )

Constructor @access public.

Parameters

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

    {
        global $DIC;
 
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
 
        $this->ctrl = $DIC->ctrl();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->toolbar = $DIC->toolbar();
        $this->user = $DIC->user();
        $this->profile = $DIC['user']->getProfile();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('ps');
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->data_factory = new DataFactory();
        $this->ref_id = $a_ref_id;
        $this->obj_id = ilObject::_lookupObjId($this->ref_id);
        $this->type = ilObject::_lookupType($this->obj_id);
 
        $this->fields_info = ilExportFieldsInfo::_getInstanceByType($this->type);
        $this->initFileSystemStorage();
    }

References $DIC, ilExportFieldsInfo\_getInstanceByType(), ilObject\_lookupObjId(), ilObject\_lookupType(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), initFileSystemStorage(), ILIAS\Repository\lng(), ILIAS\Repository\profile(), ILIAS\Repository\refinery(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ confirmDeleteExportFile()

ilMemberExportGUI::confirmDeleteExportFile ( array $ids )

Confirm deletion of export files.

Parameters

string[] $ids

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

                                                       : void
    {
        if (!count($ids)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('ps_select_one'), true);
            $this->ctrl->redirect($this, 'show');
        }
        $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');
        foreach ($this->fss_export->getMemberExportFiles() as $file) {
            if (!in_array(md5($file['name']), $ids)) {
                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());
    }

References ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), IL_CAL_UNIX, and ILIAS\Repository\lng().

Referenced by handleTableAction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteExportFile()

ilMemberExportGUI::deleteExportFile ( )

Delete member export files.

Reimplemented in ilPRGMembersExportGUI.

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

                                      : void
    {
        $file_ids = $this->initFileIdsFromPost();
        if (!count($file_ids)) {
            $this->ctrl->redirect($this, 'show');
        }
        foreach ($this->fss_export->getMemberExportFiles() as $file) {
            if (!in_array(md5($file['name']), $file_ids)) {
                continue;
            }
 
            $path = $file['timest'] . '_participant_export_' .
                $file['type'] . '_' . $this->obj_id . '.' . $file['type'];
            if ($this->fss_export->hasMemberExportFile($path)) {
                $this->fss_export->deleteMemberExportFile($path);
                continue;
            }
 
            if ($file['type'] !== "xls") {
                continue;
            }
            //try xlsx if type is xls and file can't be found
            $path = $file['timest'] . '_participant_export_xls_' . $this->obj_id . '.xlsx';
            if ($this->fss_export->hasMemberExportFile($path)) {
                $this->fss_export->deleteMemberExportFile($path);
            }
        }
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('ps_files_deleted'), true);
        $this->ctrl->redirect($this, 'show');
    }

References ILIAS\Repository\ctrl(), initFileIdsFromPost(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ deliverData()

ilMemberExportGUI::deliverData ( )

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

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

References ILIAS\UI\examples\Symbol\Glyph\Date\date(), ilUtil\deliverData(), and ilSession\get().

Here is the call graph for this function:

◆ downloadExportFile()

ilMemberExportGUI::downloadExportFile ( array $ids )

Download export file.

Parameters

string[] $ids

Reimplemented in ilPRGMembersExportGUI.

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

                                                  : void
    {
        $hash = $ids[0] ?? '';
        if (!$hash) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('ps_select_one'), true);
            $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;
                }
            }
        }
    }

References $contents, ILIAS\Repository\ctrl(), ILIAS\UI\examples\Symbol\Glyph\Date\date(), ilUtil\deliverData(), and ILIAS\Repository\lng().

Referenced by handleTableAction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilMemberExportGUI::executeCommand ( )

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

                                    : void
    {
        if (!ilPrivacySettings::getInstance()->checkExportAccess($this->ref_id)) {
            $this->tpl->setOnScreenMessage('failure', $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;
        }
    }

References ILIAS\Repository\ctrl(), ilPrivacySettings\getInstance(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ export()

ilMemberExportGUI::export ( )

Export, create member export file and store it in data directory.

Reimplemented in ilPRGMembersExportGUI.

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

                            : void
    {
        $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');
    }

References $filename, ILIAS\Repository\ctrl(), export(), and handleIncoming().

Referenced by export(), and exportExcel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportExcel()

ilMemberExportGUI::exportExcel ( )

Reimplemented in ilPRGMembersExportGUI.

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

                                 : void
    {
        $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');
    }

References $filename, $obj_id, ILIAS\Repository\ctrl(), export(), ilMemberExport\EXPORT_EXCEL, and handleIncoming().

Here is the call graph for this function:

◆ getTableActionURLBuilder()

ilMemberExportGUI::getTableActionURLBuilder ( )

protected

Returns: array{0: URLBuilder, 1: URLBuilderToken, 2: URLBuilderToken}

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

                                                 : array
    {
        $link = ILIAS_HTTP_PATH . '/' . $this->ctrl->getLinkTarget(
            $this,
            'handleTableAction'
        );
        $url_builder = new URLBuilder($this->data_factory->uri($link));
        return $url_builder->acquireParameters(['mem_exp_tbl'], 'table_ids', 'table_action');
    }

References ILIAS\Repository\ctrl().

Referenced by handleTableAction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleIncoming()

ilMemberExportGUI::handleIncoming ( )

protected

Reimplemented in ilPRGMembersExportGUI.

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

                                       : void
    {
        $settings = [];
        $incoming = [];
        if ($this->http->wrapper()->post()->has('export_members')) {
            $incoming = $this->http->wrapper()->post()->retrieve(
                'export_members',
                $this->refinery->kindlyTo()->dictOf(
                    $this->refinery->kindlyTo()->string()
                )
            );
        }
        if (count($incoming)) {
            foreach ($incoming as $id) {
                $settings[$id] = true;
            }
        }
 
        // Save (form) settings
        $this->exportSettings = new ilUserFormSettings('memexp');
        $this->exportSettings->set($settings);
        $this->exportSettings->store();
    }

References $id, $settings, ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by export(), and exportExcel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleTableAction()

ilMemberExportGUI::handleTableAction ( )

protected

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

                                          : void
    {
        list($url_builder, $id_token, $action_token) = $this->getTableActionURLBuilder();
 
        if (!$this->http->wrapper()->query()->has($action_token->getName())) {
            return;
        }
 
        $action = $this->http->wrapper()->query()->retrieve(
            $action_token->getName(),
            $this->refinery->kindlyTo()->string()
        );
 
        $ids = [];
        if ($this->http->wrapper()->query()->has($id_token->getName())) {
            $ids = $this->http->wrapper()->query()->retrieve(
                $id_token->getName(),
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string())
            );
 
            if ($ids === ['ALL_OBJECTS']) {
                $data_retrieval = new DataRetrieval($this->fss_export, $this->lng);
                $ids = $data_retrieval->getAllIDs();
            }
        }
 
        switch ($action) {
            case TableBuilder::ACTION_DOWNLOAD:
                $this->downloadExportFile($ids);
                break;
 
            case TableBuilder::ACTION_DELETE:
                $this->confirmDeleteExportFile($ids);
                break;
        }
    }

References confirmDeleteExportFile(), downloadExportFile(), getTableActionURLBuilder(), ILIAS\FileDelivery\http(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ initCSV()

ilMemberExportGUI::initCSV ( ?ilPropertyFormGUI $a_form = null )

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

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

References initSettingsForm().

Here is the call graph for this function:

◆ initExcel()

ilMemberExportGUI::initExcel ( ?ilPropertyFormGUI $a_form = null )

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

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

References initSettingsForm().

Here is the call graph for this function:

◆ initFileIdsFromPost()

ilMemberExportGUI::initFileIdsFromPost ( )

protected

Returns: string[]

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

                                            : array
    {
        $ids = [];
        if ($this->http->wrapper()->post()->has('id')) {
            $ids = $this->http->wrapper()->post()->retrieve(
                'id',
                $this->refinery->kindlyTo()->listOf(
                    $this->refinery->kindlyTo()->string()
                )
            );
        }
 
        return $ids;
    }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by deleteExportFile(), and ilPRGMembersExportGUI\deleteExportFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFileSystemStorage()

ilMemberExportGUI::initFileSystemStorage ( )

protected

Reimplemented in ilPRGMembersExportGUI.

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

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

Referenced by __construct().

Here is the caller graph for this function:

◆ initSettingsForm()

ilMemberExportGUI::initSettingsForm ( bool $a_is_excel = false )

protected

Reimplemented in ilPRGMembersExportGUI.

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

                                                                 : ilPropertyFormGUI
    {
        // Check user selection
        $this->exportSettings = new ilUserFormSettings('memexp');
 
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt('ps_export_settings'));
 
        if ($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 ($this->profile->getVisibleUserDefinedFields(Context::buildFromObjectType($this->type)) as $field) {
            $field_id = 'udf_' . $field->getIdentifier();
            $udata->addOption(new ilCheckboxOption($field->getLabel($this->lng), $field_id));
            if ($this->exportSettings->enabled($field_id)) {
                $current_udata[] = $field_id;
            }
        }
 
        $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
        if (ilBookingEntry::hasObjectBookingEntries($this->obj_id, $this->user->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;
    }

References ilCourseDefinedFieldDefinition\_getFields(), ILIAS\Repository\ctrl(), ilBookingEntry\hasObjectBookingEntries(), ILIAS\Repository\lng(), ILIAS\Repository\profile(), and ILIAS\Repository\user().

Referenced by initCSV(), and initExcel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ show()

ilMemberExportGUI::show ( )

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

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

References ILIAS\Repository\lng(), showFileList(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

◆ showFileList()

ilMemberExportGUI::showFileList ( )

Show file list of available export files.

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

                                  : void
    {
        $table = new TableBuilder(
            new DataRetrieval($this->fss_export, $this->lng),
            $this->lng,
            $this->ui_factory,
            $this->http,
            $this->user,
            $this->data_factory
        );
 
        $this->tpl->setContent(
            $this->ui_renderer->render(
                $table->get(...$this->getTableActionURLBuilder())
            )
        );
    }