This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilDclRecordListGUI:

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

	getRefId ()

	getObjId ()

	executeCommand ()
	execute command More...

	showImportExcel (?ilPropertyFormGUI $form=null)

	initImportForm ()
	Init form. More...

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

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

	doTableSwitch ()
	doTableSwitch More...

	doTableViewSwitch ()
	doTableViewSwitch 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)

	getAvailableTables ()

	getRecordListTableGUI (bool $use_tableview_filter)

	createSwitchers ()

	checkAccess ()

Protected Attributes
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	$ilToolbar

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
	init (ilDataCollectionOutboundsAdapter $adapter)

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

	recordBelongsToCollection (ilDclBaseRecordModel $record)

Private Attributes
ilDataCollectionUiPort	$dclUi

ilDataCollectionAccessPort	$dclAccess

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Definition at line 19 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.

References $DIC, $mode, $table_id, $tableview_id, ILIAS\Repository\ctrl(), ilObjectGUI\getObject(), ilDclCache\getTableCache(), ILIAS\FileDelivery\http(), init(), ILIAS\Repository\lng(), ilDataCollectionOutboundsAdapter\new(), ILIAS\Repository\refinery(), and ILIAS\Repository\tabs().

     {
         global $DIC;
 
         $this->init(ilDataCollectionOutboundsAdapter::new());
 
         $this->ctrl = $DIC->ctrl();
         $this->ilToolbar = $DIC->toolbar();
         $this->lng = $DIC->language();
         $this->tabs = $DIC->tabs();
         $this->http = $DIC->http();
         $this->refinery = $DIC->refinery();
 
         $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_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;
             }
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ applyFilter()

ilDclRecordListGUI::applyFilter ( )

protected

Exceptions

ilCtrlException

Definition at line 322 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();
     }

◆ checkAccess()

ilDclRecordListGUI::checkAccess ( )

protected

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

References $table_id, and $tableview_id.

Referenced by executeCommand().

                                     : bool
     {
         return ilObjDataCollectionAccess::hasAccessTo(
             $this->parent_obj->getRefId(),
             $this->table_id,
             $this->tableview_id
         );
     }

Here is the caller graph for this function:

◆ createSwitchers()

ilDclRecordListGUI::createSwitchers ( )

protected

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

References $ilToolbar, ilToolbarGUI\addButtonInstance(), ilToolbarGUI\addInputItem(), ilToolbarGUI\addSeparator(), ilToolbarGUI\addText(), ILIAS\Repository\ctrl(), getAvailableTables(), ilSubmitButton\getInstance(), ILIAS\Repository\lng(), and ilToolbarGUI\setFormAction().

Referenced by executeCommand().

                                         : void
     {
         $ilToolbar = $this->ilToolbar;
         $ilToolbar->setFormAction($this->ctrl->getFormActionByClass("ilDclRecordListGUI", "doTableSwitch"));
 
         //table switcher
         $options = $this->getAvailableTables();
         if (count($options) > 1) {
             $table_selection = new ilSelectInputGUI('', 'table_id');
             $table_selection->setOptions($options);
             $table_selection->setValue($this->table_id);
 
             $ilToolbar->addText($this->lng->txt("dcl_table"));
             $ilToolbar->addInputItem($table_selection);
             $button = ilSubmitButton::getInstance();
             $button->setCaption('change');
             $button->setCommand('doTableSwitch');
             $ilToolbar->addButtonInstance($button);
             $ilToolbar->addSeparator();
         }
 
         //tableview switcher
         $options = [];
         foreach ($this->table_obj->getVisibleTableViews($this->parent_obj->getRefId()) as $tableview) {
             $options[$tableview->getId()] = $tableview->getTitle();
         }
 
         if (count($options) > 1) {
             $tableview_selection = new ilSelectInputGUI('', 'tableview_id');
             $tableview_selection->setOptions($options);
             $tableview_selection->setValue($this->tableview_id);
             $ilToolbar->addText($this->lng->txt("dcl_tableview"));
             $ilToolbar->addInputItem($tableview_selection);
 
             $button = ilSubmitButton::getInstance();
             $button->setCaption('change');
             $button->setCommand('doTableViewSwitch');
             $ilToolbar->addButtonInstance($button);
             $ilToolbar->addSeparator();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doTableSwitch()

ilDclRecordListGUI::doTableSwitch ( )

doTableSwitch

Exceptions

ilCtrlException

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

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

                                    : void
     {
         $this->ctrl->clearParameters($this);
         $table_id = $this->http->wrapper()->post()->retrieve('table_id', $this->refinery->kindlyTo()->int());
         $this->ctrl->setParameterByClass(ilObjDataCollectionGUI::class, "table_id", $table_id);
         $this->ctrl->setParameter($this, "table_id", $table_id);
         $this->ctrl->clearParametersByClass(ilObjDataCollectionGUI::class);
         $this->ctrl->redirect($this, self::CMD_SHOW);
     }

Here is the call graph for this function:

◆ doTableViewSwitch()

ilDclRecordListGUI::doTableViewSwitch ( )

doTableViewSwitch

Exceptions

ilCtrlException

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

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

                                        : void
     {
         $tableview_id = $this->http->wrapper()->post()->retrieve('tableview_id', $this->refinery->kindlyTo()->int());
         $this->ctrl->setParameterByClass("ilObjDataCollectionGUI", "tableview_id", $tableview_id);
         $this->ctrl->redirect($this, self::CMD_SHOW);
     }

Here is the call graph for this function:

◆ endImport()

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

End import.

Exceptions

ilTemplateException

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

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

Referenced by importRecords().

                                                       : void
     {
         $output = new ilTemplate("tpl.dcl_import_terminated.html", true, true, "Modules/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();
         }
         if (!count($warnings)) {
             $output->setCurrentBlock("warnings");
             $output->setVariable("WARNING", $this->lng->txt("dcl_no_warnings"));
             $output->parseCurrentBlock();
         }
         $output->setVariable("BACK_LINK", $this->ctrl->getLinkTargetByClass("ilDclRecordListGUI", "listRecords"));
         $output->setVariable("BACK", $this->lng->txt("back"));
         $this->dclUi->setContent($output->get());
     }

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 111 of file class.ilDclRecordListGUI.php.

References $DIC, $ilSetting, $table_id, $tableview_id, ilToolbarGUI\addButtonInstance(), ilToolbarGUI\addStickyItem(), checkAccess(), createSwitchers(), ILIAS\Repository\ctrl(), ilLinkButton\getInstance(), getRecordListTableGUI(), ilObjDataCollectionAccess\hasAccessToFields(), ilObjDataCollectionAccess\hasPermissionToAddRecord(), ILIAS\Repository\lng(), setSubTabs(), and ILIAS\Repository\tabs().

                                     : void
     {
         if (!$this->checkAccess()) {
             $this->dclUi->displayFailureMessage($this->lng->txt('permission_denied'));
             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:
                 $this->setSubTabs($this->mode);
                 $this->listRecords(true);
                 break;
             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;
         }
     }

Here is the call graph for this function:

◆ getAvailableTables()

ilDclRecordListGUI::getAvailableTables ( )

protected

Returns: string[]

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

References ilObjDataCollectionAccess\hasWriteAccess().

Referenced by createSwitchers().

                                            : array
     {
         if (ilObjDataCollectionAccess::hasWriteAccess($this->parent_obj->getRefId())) {
             $tables = $this->parent_obj->object->getTables();
         } else {
             $tables = $this->parent_obj->object->getVisibleTables();
         }
         $options = [];
         foreach ($tables as $table) {
             $options[$table->getId()] = $table->getTitle();
         }
 
         return $options;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObjId()

ilDclRecordListGUI::getObjId ( )

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

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

◆ getRecordListTableGUI()

ilDclRecordListGUI::getRecordListTableGUI ( bool $use_tableview_filter )

protected

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

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

Referenced by executeCommand().

                                                                         : ilDclRecordListTableGUI
     {
         $table_obj = $this->table_obj;
 
         $list = new ilDclRecordListTableGUI($this, "listRecords", $table_obj, $this->tableview_id, $this->mode);
         $list->initFilter();
         if ($use_tableview_filter) {
             $list->initFilter();
             $list->resetOffset();
             $list->resetFilter();
             $list->initFilterFromTableView();
         }
 
         $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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRefId()

ilDclRecordListGUI::getRefId ( )

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

Referenced by getRecordListTableGUI().

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

Here is the caller graph for this function:

◆ getTableId()

ilDclRecordListGUI::getTableId ( )

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

References $table_id.

                                 : int
     {
         return $this->table_id;
     }

◆ getTableviewId()

ilDclRecordListGUI::getTableviewId ( )

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

References $tableview_id.

                                     : int
     {
         return $this->tableview_id;
     }

◆ importExcel()

ilDclRecordListGUI::importExcel ( )

Import Data from Excel sheet.

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

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

                                  : 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, $simulate);
         } else {
             $this->showImportExcel($form);
         }
     }

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 263 of file class.ilDclRecordListGUI.php.

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

Referenced by importExcel().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init()

ilDclRecordListGUI::init ( ilDataCollectionOutboundsAdapter $adapter )

private

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

References ilDataCollectionOutboundsAdapter\getDataCollectionAccess(), and ilDataCollectionOutboundsAdapter\getDataCollectionUi().

Referenced by __construct().

      : void {
         $this->dclUi = $adapter->getDataCollectionUi();
         $this->dclAccess = $adapter->getDataCollectionAccess();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initImportForm()

ilDclRecordListGUI::initImportForm ( )

Init form.

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

References ILIAS\Repository\lng(), ilFormPropertyGUI\setInfo(), and ilFormPropertyGUI\setRequired().

Referenced by importExcel(), and showImportExcel().

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

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 468 of file class.ilDclRecordListGUI.php.

References ilDclBaseRecordModel\getTable().

Referenced by sendFile().

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

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 335 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();
     }

◆ sendFile()

ilDclRecordListGUI::sendFile ( )

send File to User

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

References $filename, ILIAS\LTI\ToolProvider\$key, $ref_id, ILIAS\Repository\ctrl(), ilFileDelivery\deliverFileAttached(), ilObjFile\getFile(), ilDclCache\getRecordCache(), ilDclCache\getRecordFieldCache(), ilDclCache\getRecordRepresentation(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ilDclPropertyFormGUI\rebuildTempFileByHash(), recordBelongsToCollection(), ILIAS\Repository\refinery(), and ILIAS\Repository\tabs().

                               : void
     {
         $hasIlFileHash = $this->http->wrapper()->query()->has('ilfilehash');
         //need read access to receive file
         if ($this->dclAccess->hasReadPermission($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'];
                 $filename = $_FILES["field_" . $field_id]['name'];
             } else {
                 $rec_id = $this->http->wrapper()->query()->retrieve('record_id', $this->refinery->kindlyTo()->int());
                 $record = ilDclCache::getRecordCache($rec_id);
                 $field_id = $this->http->wrapper()->query()->retrieve('field_id', $this->refinery->kindlyTo()->int());
                 $file_obj = new ilObjFile($record->getRecordFieldValue($field_id), false);
                 if (!$this->recordBelongsToCollection($record)) {
                     return;
                 }
                 $filepath = $file_obj->getFile();
                 $filename = $file_obj->getFileName();
             }
 
             ilFileDelivery::deliverFileAttached($filepath, $filename);
         }
     }

Here is the call graph for this function:

◆ setSubTabs()

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

protected

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

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

Referenced by executeCommand().

                                                                      : void
     {
         $this->ctrl->setParameter($this, self::GET_MODE, self::MODE_VIEW);
         $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);
     }

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 205 of file class.ilDclRecordListGUI.php.

References initImportForm().

Referenced by importExcel().

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