Collaboration diagram for ilDclRecordListGUI:

Public Member Functions
	__construct (ilObjDataCollectionGUI $a_parent_obj, int $table_id, int $tableview_id)

	getRefId ()

	getObjId ()

	executeCommand ()
	execute command More...

	listRecords ()

	showImportExcel (?ilPropertyFormGUI $form=null)

	initImportForm ()
	Init form. More...

	importExcel ()
	Import Data from Excel sheet. More...

	endImport (int $i, array $warnings)
	End import. More...

	sendFile ()
	send File to User More...

	getTableId ()

	getTableviewId ()

Data Fields
const	GET_TABLE_ID = 'table_id'

const	GET_TABLEVIEW_ID = 'tableview_id'

const	GET_MODE = "mode"

const	MODE_VIEW = "view"

const	MODE_MANAGE = "manage"

const	CMD_LIST_RECORDS = 'listRecords'

const	CMD_SHOW = 'show'

const	CMD_CONFIRM_DELETE_RECORDS = 'confirmDeleteRecords'

const	CMD_CANCEL_DELETE = 'cancelDelete'

const	CMD_DELETE_RECORDS = 'deleteRecords'

const	CMD_SHOW_IMPORT_EXCEL = 'showImportExcel'

Protected Member Functions
	applyFilter ()

	resetFilter ()

	setSubTabs (string $active_mode=self::GET_MODE)

	getRecordListTableGUI ()

	createSwitchers ()

Protected Attributes
ILIAS UI Factory	$ui_factory

ILIAS UI Renderer	$renderer

string	$mode = self::MODE_VIEW
	Stores current mode active. More...

ilDclTable	$table_obj

int	$table_id

int	$obj_id

ilObjDataCollectionGUI	$parent_obj

int	$tableview_id

ilCtrl	$ctrl

ilToolbarGUI	$toolbar

ilLanguage	$lng

ilTabsGUI	$tabs

ILIAS HTTP Services	$http

ILIAS Refinery Factory	$refinery

ILIAS ResourceStorage Services	$irss

bool	$filter_changed = false

Static Protected Attributes
static array	$available_modes = [self::MODE_VIEW, self::MODE_MANAGE]

Private Member Functions
	importRecords (string $file, bool $simulate=false)
	Import records from Excel file. More...

	recordBelongsToCollection (ilDclBaseRecordModel $record)

Private Attributes
ilAccessHandler	$access

ilGlobalTemplateInterface	$tpl

Detailed Description

Definition at line 21 of file class.ilDclRecordListGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilDclRecordListGUI::__construct	(	ilObjDataCollectionGUI	$a_parent_obj,
		int	$table_id,
		int	$tableview_id
	)

Exceptions

ilCtrlException

Definition at line 63 of file class.ilDclRecordListGUI.php.

    {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->toolbar = $DIC->toolbar();
        $this->lng = $DIC->language();
        $this->tabs = $DIC->tabs();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->irss = $DIC->resourceStorage();
        $this->access = $DIC->access();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->ui_factory = $DIC->ui()->factory();
        $this->renderer = $DIC->ui()->renderer();
 
        $this->table_id = $table_id;
        $this->tableview_id = $tableview_id;
 
        $this->obj_id = $a_parent_obj->getObject()->getId();
        $this->parent_obj = $a_parent_obj;
        $this->table_obj = ilDclCache::getTableCache($table_id);
 
        $this->ctrl->setParameterByClass(ilDclRecordEditGUI::class, self::GET_TABLE_ID, $this->table_id);
        $this->ctrl->setParameterByClass(ilDclRecordEditGUI::class, self::GET_TABLEVIEW_ID, $this->tableview_id);
        $this->ctrl->setParameterByClass(ilDclDetailedViewGUI::class, self::GET_TABLE_ID, $this->table_id);
        $this->ctrl->setParameterByClass(ilDclDetailedViewGUI::class, self::GET_TABLEVIEW_ID, $this->tableview_id);
 
        $this->mode = self::MODE_VIEW;
 
        if ($this->http->wrapper()->query()->has(self::GET_MODE)) {
            $mode = $this->http->wrapper()->query()->retrieve(self::GET_MODE, $this->refinery->kindlyTo()->string());
            if (in_array($mode, self::$available_modes, true)) {
                $this->mode = $mode;
            }
        }
    }

References $DIC, $mode, $table_id, $tableview_id, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilObjectGUI\getObject(), ilDclCache\getTableCache(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), MODE_VIEW, ILIAS\Repository\refinery(), renderer(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

Member Function Documentation

◆ applyFilter()

ilDclRecordListGUI::applyFilter ( )

protected

Exceptions

ilCtrlException

Definition at line 299 of file class.ilDclRecordListGUI.php.

                                    : void
    {
        $table = new ilDclRecordListTableGUI($this, "listRecords", $this->table_obj, $this->tableview_id);
        $table->initFilter();
        $table->resetOffset();
        $table->writeFilterToSession();
        $this->filter_changed = true;
        $this->listRecords();
    }

References listRecords().

Here is the call graph for this function:

◆ createSwitchers()

ilDclRecordListGUI::createSwitchers ( )

protected

Definition at line 538 of file class.ilDclRecordListGUI.php.

                                        : void
    {
        if (ilObjDataCollectionAccess::hasWriteAccess($this->parent_obj->getRefId())) {
            $tables = $this->parent_obj->object->getTables();
        } else {
            $tables = $this->parent_obj->object->getVisibleTables();
        }
 
        $switcher = new ilDclSwitcher($this->toolbar, $this->ui_factory, $this->ctrl, $this->lng);
        $switcher->addTableSwitcherToToolbar(
            $tables,
            self::class,
            self::CMD_SHOW,
            $this->getTableId()
        );
 
        $switcher->addViewSwitcherToToolbar(
            $this->table_obj->getVisibleTableViews(),
            $this->getTableId(),
            self::class,
            self::CMD_SHOW,
            $this->getTableviewId()
        );
    }

References ILIAS\Repository\ctrl(), getTableId(), ilObjDataCollectionAccess\hasWriteAccess(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

Referenced by listRecords().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ endImport()

ilDclRecordListGUI::endImport	(	int	$i,
		array	$warnings
	)

End import.

Exceptions

ilTemplateException

Definition at line 281 of file class.ilDclRecordListGUI.php.

                                                      : void
    {
        $output = new ilTemplate("tpl.dcl_import_terminated.html", true, true, "components/ILIAS/DataCollection");
        $output->setVariable("IMPORT_TERMINATED", $this->lng->txt("dcl_import_terminated") . ": " . $i);
        foreach ($warnings as $warning) {
            $output->setCurrentBlock("warnings");
            $output->setVariable("WARNING", $warning);
            $output->parseCurrentBlock();
        }
 
        $output->setVariable("BACK_LINK", $this->ctrl->getLinkTargetByClass(ilDclRecordListGUI::class, "listRecords"));
        $output->setVariable("BACK", $this->lng->txt("back"));
        $this->tpl->setContent($output->get());
    }

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

Referenced by importRecords().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilDclRecordListGUI::executeCommand ( )

execute command

Exceptions

ilCtrlException

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

                                    : void
    {
        if (!ilObjDataCollectionAccess::hasAccessTo($this->getRefId(), $this->table_id, $this->tableview_id)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
            return;
        }
 
        $this->ctrl->saveParameter($this, self::GET_MODE);
        $cmd = $this->ctrl->getCmd(self::CMD_SHOW);
 
        // 'show' fills all filters with the predefined values from the tableview,
        // whereas 'listRecords' handels the filters "normally", filling them from the POST-variable
        switch ($cmd) {
            case self::CMD_SHOW:
            case self::CMD_CANCEL_DELETE:
            case self::CMD_LIST_RECORDS:
                $this->setSubTabs($this->mode);
                $this->listRecords();
                break;
            case self::CMD_CONFIRM_DELETE_RECORDS:
                $this->confirmDeleteRecords();
                break;
            case self::CMD_DELETE_RECORDS:
                $this->deleteRecords();
                break;
            case self::CMD_SHOW_IMPORT_EXCEL:
                $this->tabs->setBackTarget($this->lng->txt('back'), $this->ctrl->getLinkTarget($this));
                $this->$cmd();
                break;
 
            default:
                $this->$cmd();
                break;
        }
    }

References CMD_CANCEL_DELETE, CMD_CONFIRM_DELETE_RECORDS, CMD_DELETE_RECORDS, CMD_LIST_RECORDS, CMD_SHOW, CMD_SHOW_IMPORT_EXCEL, ILIAS\Repository\ctrl(), getRefId(), listRecords(), ILIAS\Repository\lng(), setSubTabs(), and ILIAS\Repository\tabs().

Here is the call graph for this function:

◆ getObjId()

ilDclRecordListGUI::getObjId ( )

Definition at line 106 of file class.ilDclRecordListGUI.php.

                              : int
    {
        return $this->parent_obj->getObject()->getId();
    }

◆ getRecordListTableGUI()

ilDclRecordListGUI::getRecordListTableGUI ( )

protected

Definition at line 500 of file class.ilDclRecordListGUI.php.

                                              : ilDclRecordListTableGUI
    {
        $table_obj = $this->table_obj;
 
        $list = new ilDclRecordListTableGUI($this, "listRecords", $table_obj, $this->tableview_id, $this->mode);
        $list->initFilter();
 
        $list->setExternalSegmentation(true);
        $list->setExternalSorting(true);
        $list->determineOffsetAndOrder();
 
        if ($this->filter_changed) {
            $list->resetOffset();
        }
 
        $limit = $list->getLimit();
        $offset = $list->getOffset();
 
        $data = $table_obj->getPartialRecords(
            (string) $this->getRefId(),
            $list->getOrderField(),
            $list->getOrderDirection(),
            $limit,
            $offset,
            $list->getFilter()
        );
        $records = $data['records'];
        $total = $data['total'];
 
        $list->setMaxCount($total);
        $list->setRecordData($records);
 
        $list->determineOffsetAndOrder();
        $list->determineLimit();
 
        return $list;
    }

References $data, $table_obj, ilDclTable\getPartialRecords(), and getRefId().

Referenced by listRecords().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRefId()

ilDclRecordListGUI::getRefId ( )

Definition at line 101 of file class.ilDclRecordListGUI.php.

                              : int
    {
        return $this->parent_obj->getRefId();
    }

Referenced by executeCommand(), and getRecordListTableGUI().

Here is the caller graph for this function:

◆ getTableId()

ilDclRecordListGUI::getTableId ( )

Definition at line 563 of file class.ilDclRecordListGUI.php.

                                : int
    {
        return $this->table_id;
    }

References $table_id.

Referenced by createSwitchers().

Here is the caller graph for this function:

◆ getTableviewId()

ilDclRecordListGUI::getTableviewId ( )

Definition at line 568 of file class.ilDclRecordListGUI.php.

                                    : int
    {
        return $this->tableview_id;
    }

References $tableview_id.

◆ importExcel()

ilDclRecordListGUI::importExcel ( )

Import Data from Excel sheet.

Definition at line 247 of file class.ilDclRecordListGUI.php.

                                 : void
    {
        if (!(ilObjDataCollectionAccess::hasPermissionToAddRecord(
            $this->parent_obj->getRefId(),
            $this->table_id
        )) || !$this->table_obj->getImportEnabled()) {
            throw new ilDclException($this->lng->txt("access_denied"));
        }
        $form = $this->initImportForm();
        if ($form->checkInput()) {
            $file = $form->getInput("import_file");
            $file_location = $file["tmp_name"];
            $simulate = $form->getInput("simulate");
            $this->importRecords($file_location, (bool) $simulate);
        } else {
            $this->showImportExcel($form);
        }
    }

References ilObjDataCollectionAccess\hasPermissionToAddRecord(), importRecords(), initImportForm(), ILIAS\Repository\lng(), and showImportExcel().

Here is the call graph for this function:

◆ importRecords()

ilDclRecordListGUI::importRecords	(	string	$file,
		bool	$simulate = `false`
	)

private

Import records from Excel file.

Definition at line 269 of file class.ilDclRecordListGUI.php.

                                                                        : void
    {
        $importer = new ilDclContentImporter($this->parent_obj->object->getRefId(), $this->table_id);
        $result = $importer->import($file, $simulate);
 
        $this->endImport($result['line'], $result['warnings']);
    }

References endImport().

Referenced by importExcel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initImportForm()

ilDclRecordListGUI::initImportForm ( )

Init form.

Definition at line 221 of file class.ilDclRecordListGUI.php.

                                    : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
 
        $item = new ilCustomInputGUI();
        $item->setHtml($this->lng->txt('dcl_file_format_description'));
        $item->setTitle("Info");
        $form->addItem($item);
 
        $file = new ilFileInputGUI($this->lng->txt("import_file"), "import_file");
        $file->setSuffixes(['xlsx']);
        $file->setRequired(true);
        $form->addItem($file);
 
        $cb = new ilCheckboxInputGUI($this->lng->txt("dcl_simulate_import"), "simulate");
        $cb->setInfo($this->lng->txt("dcl_simulate_info"));
        $form->addItem($cb);
 
        $form->addCommandButton("importExcel", $this->lng->txt("import"));
 
        return $form;
    }

References ILIAS\Repository\lng().

Referenced by importExcel(), and showImportExcel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listRecords()

ilDclRecordListGUI::listRecords ( )

Definition at line 151 of file class.ilDclRecordListGUI.php.

                                 : void
    {
        $list = $this->getRecordListTableGUI();
 
        $this->createSwitchers();
 
        $this->ctrl->setParameter($this, 'table_id', $this->table_id);
        $this->ctrl->setParameter($this, 'tableview_id', $this->tableview_id);
 
        $permission_to_add_or_import = ilObjDataCollectionAccess::hasPermissionToAddRecord(
            $this->parent_obj->getRefId(),
            $this->table_id
        ) && $this->table_obj->hasCustomFields();
        if ($permission_to_add_or_import) {
            $this->ctrl->setParameterByClass(ilDclRecordEditGUI::class, "record_id", null);
 
            $add_new = $this->ui_factory->button()->primary(
                $this->lng->txt("dcl_add_new_record"),
                $this->ctrl->getFormActionByClass(ilDclRecordEditGUI::class, "create")
            );
            $this->toolbar->addStickyItem($add_new);
        }
 
        if ($permission_to_add_or_import && $this->table_obj->getImportEnabled()) {
            $this->ctrl->setParameterByClass(ilDclRecordEditGUI::class, "record_id", null);
 
            $import_button = $this->ui_factory->button()->standard(
                $this->lng->txt("dcl_import_records .xls"),
                $this->ctrl->getFormActionByClass(ilDclRecordListGUI::class, self::CMD_SHOW_IMPORT_EXCEL)
            );
            $this->toolbar->addComponent($import_button);
        }
 
        if (count($this->table_obj->getRecordFields()) == 0) {
            $message = $this->lng->txt("dcl_no_fields_yet") . " "
                . (ilObjDataCollectionAccess::hasAccessToFields(
                    $this->parent_obj->getRefId(),
                    $this->table_id
                ) ? $this->lng->txt("dcl_create_fields") : "");
            $this->tpl->setOnScreenMessage('info', $message, true);
        }
 
        $target = '';
        if ($this->http->wrapper()->query()->has('table_id')) {
            $target .= $this->http->wrapper()->query()->retrieve('table_id', $this->refinery->to()->string());
        }
        if ($this->http->wrapper()->query()->has('tableview_id')) {
            $target .= '_' . $this->http->wrapper()->query()->retrieve('tableview_id', $this->refinery->to()->string());
        }
 
        $this->tpl->setPermanentLink("dcl", $this->parent_obj->getRefId(), $target);
 
        if ($desc = $this->table_obj->getDescription()) {
            $desc = $this->refinery->string()->markdown()->toHTML()->transform($desc);
            $desc = '<div class="ilDclTableDescription">' . $desc . '</div>';
        }
        $this->tpl->setContent($desc . $list->getHTML());
    }

References createSwitchers(), ILIAS\Repository\ctrl(), getRecordListTableGUI(), ilObjDataCollectionAccess\hasAccessToFields(), ilObjDataCollectionAccess\hasPermissionToAddRecord(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\toolbar().

Referenced by applyFilter(), executeCommand(), and resetFilter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ recordBelongsToCollection()

ilDclRecordListGUI::recordBelongsToCollection ( ilDclBaseRecordModel $record )

private

Definition at line 462 of file class.ilDclRecordListGUI.php.

                                                                            : bool
    {
        $table = $record->getTable();
        $obj_id = $this->parent_obj->object->getId();
        $obj_id_rec = $table->getCollectionObject()->getId();
 
        return $obj_id == $obj_id_rec;
    }

References $obj_id, and ilDclBaseRecordModel\getTable().

Referenced by sendFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetFilter()

ilDclRecordListGUI::resetFilter ( )

protected

Exceptions

ilCtrlException

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

                                    : void
    {
        $table = new ilDclRecordListTableGUI($this, "show", $this->table_obj, $this->tableview_id);
        $table->initFilter();
        $table->resetOffset();
        $table->resetFilter();
        $this->filter_changed = true;
        $this->listRecords();
    }

References listRecords().

Here is the call graph for this function:

◆ sendFile()

ilDclRecordListGUI::sendFile ( )

send File to User

Definition at line 325 of file class.ilDclRecordListGUI.php.

                              : void
    {
        $hasIlFileHash = $this->http->wrapper()->query()->has('ilfilehash');
        //need read access to receive file
        if ($this->access->checkAccess('read', "", $this->parent_obj->getRefId())) {
            // deliver temp-files
            if ($hasIlFileHash) {
                $filehash = $this->http->wrapper()->query()->retrieve(
                    'ilfilehash',
                    $this->refinery->kindlyTo()->string()
                );
                $field_id = $this->http->wrapper()->query()->retrieve('field_id', $this->refinery->kindlyTo()->int());
                ilDclPropertyFormGUI::rebuildTempFileByHash($filehash);
 
                $filepath = $_FILES["field_" . $field_id]['tmp_name'];
                $filetitle = $_FILES["field_" . $field_id]['name'];
 
                ilFileDelivery::deliverFileLegacy($filepath, $filetitle);
            } else {
                $rec_id = $this->http->wrapper()
                                     ->query()
                                     ->retrieve('record_id', $this->refinery->kindlyTo()->int());
 
                $record = ilDclCache::getRecordCache($rec_id);
                if (!$this->recordBelongsToCollection($record)) {
                    return;
                }
 
                $field_id = $this->http->wrapper()
                                       ->query()
                                       ->retrieve('field_id', $this->refinery->kindlyTo()->string());
 
 
 
                // Find the current revision
                $rid_string = $record->getRecordFieldValue($field_id);
                $identification = $this->irss->manage()->find($rid_string);
                if ($identification === null) {
                    return;
                }
                $current_revision = $this->irss->manage()->getCurrentRevision($identification);
 
                // Download the File
                $this->irss->consume()
                           ->download($identification)
                           ->overrideFileName($current_revision->getTitle())
                           ->run();
            }
        }
    }

References ILIAS\Repository\access(), ilFileDelivery\deliverFileLegacy(), ilDclCache\getRecordCache(), ILIAS\FileDelivery\http(), ilDclPropertyFormGUI\rebuildTempFileByHash(), recordBelongsToCollection(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ setSubTabs()

ilDclRecordListGUI::setSubTabs ( string $active_mode = self::GET_MODE )

protected

Definition at line 471 of file class.ilDclRecordListGUI.php.

                                                                     : void
    {
        $this->ctrl->setParameter($this, self::GET_MODE, self::MODE_VIEW);
        if ($this->http->wrapper()->query()->has(self::GET_TABLEVIEW_ID)) {
            $this->ctrl->setParameter(
                $this,
                self::GET_TABLEVIEW_ID,
                $this->http->wrapper()->query()->retrieve(self::GET_TABLEVIEW_ID, $this->refinery->kindlyTo()->int())
            );
        }
        $this->tabs->addSubTab(
            self::MODE_VIEW,
            $this->lng->txt('view'),
            $this->ctrl->getLinkTarget($this, self::CMD_LIST_RECORDS)
        );
 
        $ref_id = $this->http->wrapper()->query()->retrieve('ref_id', $this->refinery->kindlyTo()->int());
        if ($this->table_obj->hasPermissionToDeleteRecords($ref_id)) {
            $this->ctrl->setParameter($this, self::GET_MODE, self::MODE_MANAGE);
            $this->tabs->addSubTab(
                self::MODE_MANAGE,
                $this->lng->txt('dcl_manage'),
                $this->ctrl->getLinkTarget($this, self::CMD_LIST_RECORDS)
            );
        }
        $this->tabs->activateSubTab($active_mode);
        $this->ctrl->clearParameters($this);
    }

References $ref_id, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\tabs().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showImportExcel()

ilDclRecordListGUI::showImportExcel ( ?ilPropertyFormGUI $form = null )

Definition at line 210 of file class.ilDclRecordListGUI.php.

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