ilPRGMembersExportGUI Class Reference

export assignments of PRG More...

Inheritance diagram for ilPRGMembersExportGUI:

Collaboration diagram for ilPRGMembersExportGUI:

Public Member Functions
	__construct (protected int $ref_id, protected ilStudyProgrammeUserTable $prg_user_table, protected DataFactory $data_factory)
	export ()
	exportExcel ()
	deleteExportFile ()
	downloadExportFile ()
Public Member Functions inherited from ilMemberExportGUI
	__construct (int $a_ref_id)
	Constructor 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 ()
	Download export file. More...
	confirmDeleteExportFile ()
	Confirm deletion of export files. More...
	deleteExportFile ()
	Delete member export files. More...

Data Fields
const	USERFORMSETTINGS_ID = 'prg_export_settings'
const	EXPORT_FILENAME = '%s_PRGAssignment_export_%s_%s'

Protected Member Functions
	initSettingsForm (bool $a_is_excel=false)
	handleIncoming ()
	initFileSystemStorage ()
Protected Member Functions inherited from ilMemberExportGUI
	initSettingsForm (bool $a_is_excel=false)
	handleIncoming ()
	initFileIdsFromPost ()
	initFileSystemStorage ()

Protected Attributes
ilUserFormSettings	$exportSettings
int	$obj_id
Protected Attributes inherited from ilMemberExportGUI
GlobalHttpState	$http
Factory	$refinery
ilCtrl	$ctrl
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilToolbarGUI	$toolbar
ilMemberExport	$export = null
ilExportFieldsInfo	$fields_info = null
ilFileSystemAbstractionStorage	$fss_export = null
ilUserFormSettings	$exportSettings

Private Member Functions
	exportAssignments ($type)

Detailed Description

export assignments of PRG

Definition at line 26 of file class.ilPRGMembersExportGUI.php.

Constructor & Destructor Documentation

__construct()

ilPRGMembersExportGUI::__construct	(	protected int	$ref_id,
		protected ilStudyProgrammeUserTable	$prg_user_table,
		protected DataFactory	$data_factory
	)

Definition at line 34 of file class.ilPRGMembersExportGUI.php.

References ILIAS\GlobalScreen\Provider\__construct(), and ilObject\_lookupObjId().

      {
        $this->obj_id = ilObject::_lookupObjId($ref_id);
        parent::__construct($ref_id);
    }

Here is the call graph for this function:

Member Function Documentation

deleteExportFile()

ilPRGMembersExportGUI::deleteExportFile

(

)

Definition at line 169 of file class.ilPRGMembersExportGUI.php.

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

                                      : 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']), $_POST['id'])) {
                continue;
            }
            $this->fss_export->deleteMemberExportFile($file['name']);
        }

        $this->tpl->setOnScreenMessage('success', $this->lng->txt('ps_files_deleted'), true);
        $this->ctrl->redirect($this, 'show');
    }

Here is the call graph for this function:

downloadExportFile()

ilPRGMembersExportGUI::downloadExportFile

(

)

Definition at line 187 of file class.ilPRGMembersExportGUI.php.

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

                                        : void
    {
        $fl = '';
        if ($this->http->wrapper()->query()->has('fl')) {
            $fl = $this->http->wrapper()->query()->retrieve(
                'fl',
                $this->refinery->kindlyTo()->string()
            );
        }

        $hash = trim($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['name']);
                $fts = $file['timest'];
                $dat = date('Y_m_d_H-i', (int)$fts);
                $down_name = str_replace($fts, $dat, $file['name']);

                $mime = 'text/csv';
                if ($file['type'] === 'xlsx') {
                    $mime = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet';
                }
                ilUtil::deliverData($contents, $down_name, $mime);
            }
        }
    }

Here is the call graph for this function:

export()

ilPRGMembersExportGUI::export

(

)

Definition at line 115 of file class.ilPRGMembersExportGUI.php.

References ilPRGMemberExport\EXPORT_CSV, and exportAssignments().

                            : void
    {
        $this->exportAssignments(ilPRGMemberExport::EXPORT_CSV);
    }

Here is the call graph for this function:

exportAssignments()

ilPRGMembersExportGUI::exportAssignments (   $type )

private

Definition at line 128 of file class.ilPRGMembersExportGUI.php.

References ilMemberExportGUI\$export, $filename, ilMemberExportGUI\$type, ilMemberExport\create(), ILIAS\Repository\ctrl(), ilPRGMemberExport\EXPORT_CSV, ilMemberExport\getCSVString(), handleIncoming(), ILIAS\Repository\lng(), and ilStudyProgrammeDIC\specificDicFor().

Referenced by export(), and exportExcel().

    {
        $this->handleIncoming();
        $prg_user_table = ilStudyProgrammeDIC::specificDicFor(
            new ilObjStudyProgramme($this->obj_id, false)
        )['ilStudyProgrammeUserTable'];
        $prg_user_table->disablePermissionCheck(true);

        $export = new ilPRGMemberExport(
            $this->ref_id,
            $this->obj_id,
            $prg_user_table,
            $this->exportSettings,
            $this->lng,
            $this->data_factory
        );

        $type_str = ($type === ilPRGMemberExport::EXPORT_CSV) ? 'csv' : 'xls';

        $filename = sprintf(
            self::EXPORT_FILENAME,
            time(),
            $type_str,
            $this->obj_id
        );

        if ($type === ilPRGMemberExport::EXPORT_CSV) {
            $filename .= '.csv';
        }
        $filepath = $this->fss_export->getMemberExportDirectory() . DIRECTORY_SEPARATOR . $filename;


        $this->fss_export->initMemberExportDirectory();
        $export->create($type, $filepath);

        if ($type === ilPRGMemberExport::EXPORT_CSV) {
            $this->fss_export->addMemberExportFile($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()

ilPRGMembersExportGUI::exportExcel

(

)

Definition at line 123 of file class.ilPRGMembersExportGUI.php.

References ilPRGMemberExport\EXPORT_EXCEL, and exportAssignments().

                                 : void
    {
        $this->exportAssignments(ilPRGMemberExport::EXPORT_EXCEL);
    }

Here is the call graph for this function:

handleIncoming()

ilPRGMembersExportGUI::handleIncoming ( )

protected

Definition at line 81 of file class.ilPRGMembersExportGUI.php.

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

Referenced by exportAssignments().

                                       : 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;
            }
        }

        $this->exportSettings = new ilUserFormSettings(self::USERFORMSETTINGS_ID);
        $this->exportSettings->set($settings);
        $this->exportSettings->store();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initFileSystemStorage()

ilPRGMembersExportGUI::initFileSystemStorage ( )

protected

Definition at line 107 of file class.ilPRGMembersExportGUI.php.

                                              : void
    {
        $this->fss_export = new ilFSStoragePRG($this->obj_id);
    }

initSettingsForm()

ilPRGMembersExportGUI::initSettingsForm ( bool  $a_is_excel = false )

protected

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

References ilCheckboxGroupInputGUI\addOption(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

                                                                 : ilPropertyFormGUI
    {
        $this->exportSettings = new ilUserFormSettings(self::USERFORMSETTINGS_ID);

        $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'));

        $current_udata = array();
        $udata = new ilCheckboxGroupInputGUI($this->lng->txt('ps_export_user_data'), 'export_members');
        $form->addItem($udata);

        $columns = array_merge($this->prg_user_table->getColumns($this->obj_id, true));

        foreach ($columns as $field_info) {
            $udata->addOption(new ilCheckboxOption($field_info[1], $field_info[0]));
            if ($this->exportSettings->enabled($field_info[0])) {
                $current_udata[] = $field_info[0];
            }
        }

        $udata->setValue($current_udata);
        return $form;
    }

Here is the call graph for this function:

Field Documentation

$exportSettings

ilUserFormSettings ilPRGMembersExportGUI::$exportSettings

protected

Definition at line 31 of file class.ilPRGMembersExportGUI.php.

$obj_id

int ilPRGMembersExportGUI::$obj_id

protected

Definition at line 32 of file class.ilPRGMembersExportGUI.php.

EXPORT_FILENAME

const ilPRGMembersExportGUI::EXPORT_FILENAME = '%s_PRGAssignment_export_%s_%s'

Definition at line 29 of file class.ilPRGMembersExportGUI.php.

USERFORMSETTINGS_ID

const ilPRGMembersExportGUI::USERFORMSETTINGS_ID = 'prg_export_settings'

Definition at line 28 of file class.ilPRGMembersExportGUI.php.

---

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

• components/ILIAS/StudyProgramme/classes/memberexport/class.ilPRGMembersExportGUI.php