@ilCtrl_Calls ilDclRecordListGUI: ilDataCollectionUploadHandlerGUI More...

Collaboration diagram for ilDclRecordListGUI:

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

	getRefId ()

	getObjId ()

	executeCommand ()

	listRecords ()

	showImportExcel (?Standard $form=null)

	downloadImportTemplate ()

	initImportForm ()

	importExcel ()

	endImport (int $i, array $warnings)

	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'

const	CMD_DOWNLOAD_IMPORT_TEMPLATE = 'downloadImportTemplate'

Protected Member Functions
	denyImportAccessUnlessGranted ()

	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

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

bool	$filter_changed = false

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

Private Member Functions
	hasImportableFields (ilDclTable $table)

	importRecords (string $rid, bool $simulate=false)

Private Attributes
ilAccessHandler	$access

ilGlobalTemplateInterface	$tpl

Services	$irss

AbstractResourceStakeholder	$stakeholder

Detailed Description

@ilCtrl_Calls ilDclRecordListGUI: ilDataCollectionUploadHandlerGUI

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

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 66 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->access = $DIC->access();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->ui_factory = $DIC->ui()->factory();
        $this->renderer = $DIC->ui()->renderer();
        $this->irss = $DIC->resourceStorage();
        $this->stakeholder = new ilDataCollectionStakeholder();
 
        $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

Definition at line 316 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 483 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:

◆ denyImportAccessUnlessGranted()

ilDclRecordListGUI::denyImportAccessUnlessGranted ( )

protected

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

                                                      : void
    {
        if (!$this->hasImportableFields($this->table_obj)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('dcl_import_template_no_fields'), true);
            $this->ctrl->redirect($this, self::CMD_LIST_RECORDS);
        }
    }

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

Referenced by downloadImportTemplate(), and showImportExcel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ downloadImportTemplate()

ilDclRecordListGUI::downloadImportTemplate ( )

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

                                            : void
    {
        $this->denyImportAccessUnlessGranted();
 
        new ilDclContentImporter($this->parent_obj->object->getRefId(), $this->table_id)->sendImportTemplate();
    }

References denyImportAccessUnlessGranted(), and ilDclContentImporter\sendImportTemplate().

Here is the call graph for this function:

◆ endImport()

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

Definition at line 301 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 ( )

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

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);
        if ($next_class === strtolower(ilDataCollectionUploadHandlerGUI::class)) {
            $this->ctrl->forwardCommand(new ilDataCollectionUploadHandlerGUI());
            return;
        }
 
        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;
            default:
                $this->$cmd();
                break;
        }
    }

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

Here is the call graph for this function:

◆ getObjId()

ilDclRecordListGUI::getObjId ( )

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

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

◆ getRecordListTableGUI()

ilDclRecordListGUI::getRecordListTableGUI ( )

protected

Definition at line 445 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, $total, 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 105 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 508 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 513 of file class.ilDclRecordListGUI.php.

                                    : int
    {
        return $this->tableview_id;
    }

References $tableview_id.

◆ hasImportableFields()

ilDclRecordListGUI::hasImportableFields ( ilDclTable $table )

private

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

                                                           : bool
    {
        foreach ($table->getRecordFields() as $field) {
            if (in_array($field->getDatatypeId(), ilDclContentImporter::SUPPORTED_IMPORT_DATATYPES, true)) {
                return true;
            }
        }
 
        return false;
    }

References ilDclTable\getRecordFields(), and ilDclContentImporter\SUPPORTED_IMPORT_DATATYPES.

Referenced by denyImportAccessUnlessGranted().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importExcel()

ilDclRecordListGUI::importExcel ( )

Definition at line 256 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()->withRequest($this->http->request());
        $data = $form->getData();
        if ($data !== null) {
            $this->importRecords($data['import_file'][0], $data['simulate']);
        } else {
            $this->showImportExcel($form);
        }
    }

References $data, ilObjDataCollectionAccess\hasPermissionToAddRecord(), ILIAS\FileDelivery\http(), importRecords(), initImportForm(), ILIAS\Repository\lng(), and showImportExcel().

Here is the call graph for this function:

◆ importRecords()

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

private

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

                                                                       : void
    {
        $identification = $this->irss->manage()->find($rid);
        $result = new ilDclContentImporter($this->parent_obj->object->getRefId(), $this->table_id)
            ->import($this->irss->consume()->stream($identification)->getStream()->getMetadata('uri'), $simulate);
        $this->irss->manage()->remove($identification, $this->stakeholder);
        $this->endImport($result['line'], $result['warnings']);
    }

References endImport(), and ilDclContentImporter\import().

Referenced by importExcel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initImportForm()

ilDclRecordListGUI::initImportForm ( )

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

                                    : Standard
    {
        return $this->ui_factory->input()->container()->form()->standard(
            $this->ctrl->getFormAction($this, 'importExcel'),
            [
                'import_file' => $this->ui_factory->input()->field()->file(new ilDataCollectionUploadHandlerGUI(), $this->lng->txt('import_file'))
                    ->withAcceptedMimeTypes([MimeType::APPLICATION__VND_OPENXMLFORMATS_OFFICEDOCUMENT_SPREADSHEETML_SHEET])
                    ->withRequired(true),
                'simulate' => $this->ui_factory->input()->field()->checkbox($this->lng->txt('dcl_simulate_import'), $this->lng->txt('dcl_simulate_import_info'))
            ]
        )->withSubmitLabel($this->lng->txt('import'));
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\UI\Component\Input\Container\Form\Standard\withSubmitLabel().

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 152 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->hasImportableFields($this->table_obj)) {
            $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 $message, ILIAS\Scripts\PHPStan\$target, 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:

◆ resetFilter()

ilDclRecordListGUI::resetFilter ( )

protected

Definition at line 326 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:

◆ setSubTabs()

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

protected

Definition at line 416 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 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 ( ?Standard $form = null )

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

                                                           : void
    {
        $this->denyImportAccessUnlessGranted();
 
        $this->tabs->clearTargets();
        $this->tabs->setBackTarget($this->lng->txt('back'), $this->ctrl->getLinkTarget($this, self::CMD_LIST_RECORDS));
        $this->ctrl->saveParameter($this, self::GET_TABLE_ID);
        $this->ctrl->saveParameter($this, self::GET_TABLEVIEW_ID);
        $this->tabs->addTab('import', $this->lng->txt('import'), $this->ctrl->getLinkTarget($this, self::CMD_SHOW_IMPORT_EXCEL));
        $this->tabs->activateTab('import');
 
        if (!$form) {
            $form = $this->initImportForm();
        }
 
        $message_box = $this->ui_factory->messageBox()->info($this->lng->txt('dcl_file_format_description'))
            ->withButtons([$this->ui_factory->button()->standard(
                $this->lng->txt('dcl_download_import_template'),
                $this->ctrl->getLinkTarget($this, self::CMD_DOWNLOAD_IMPORT_TEMPLATE)
            )]);
 
        $this->tpl->setContent($this->renderer->render([$message_box]) . $this->renderer->render($form));
    }