Class ilDataCollectionRecordListGUI. More...

Collaboration diagram for ilDataCollectionRecordListGUI:

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

	executeCommand ()
	execute command More...

	exportExcel ()
	Export DC as Excel sheet. More...

	showImportExcel ($form=NULL)

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

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

	getReferenceFromValue ($field, $value)

	doTableSwitch ()
	doTableSwitch More...

	sendFile ()
	send File to User More...

Data Fields
const	MODE_VIEW = 1

const	MODE_MANAGE = 2

Protected Member Functions
	applyFilter ()

	resetFilter ()

Protected Attributes
	$mode = self::MODE_VIEW

	$max_imports = 100

	$supported_import_datatypes

	$table_obj

	$ctrl

Static Protected Attributes
static	$available_modes = array( self::MODE_VIEW, self::MODE_MANAGE )

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

	getExcelCharForInteger ($int)

	checkImportType ($field, &$warnings)

	getImportFieldsFromTitles ($titles, &$warnings)

	recordBelongsToCollection (ilDataCollectionRecord $record)

Detailed Description

Class ilDataCollectionRecordListGUI.

Author: Martin Studer ms@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Marcel Raimann mr@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version: $Id:

Definition at line 22 of file class.ilDataCollectionRecordListGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilDataCollectionRecordListGUI::__construct	(	ilObjDataCollectionGUI	$a_parent_obj,
			$table_id
	)

Parameters

ilObjDataCollectionGUI	$a_parent_obj
	$table_id

Definition at line 64 of file class.ilDataCollectionRecordListGUI.php.

References $_GET, $ilCtrl, and ilDataCollectionCache\getTableCache().

                                                                                       {
                 global $ilCtrl;
                 $this->ctrl = $ilCtrl;
                 $this->main_table_id = $a_parent_obj->object->getMainTableId();
                 $this->table_id = $table_id;
                 if ($this->table_id == NULL) {
                         $this->table_id = $_GET["table_id"];
                 }
                 $this->obj_id = $a_parent_obj->obj_id;
                 $this->parent_obj = $a_parent_obj;
                 $this->table_obj = ilDataCollectionCache::getTableCache($table_id);
                 $ilCtrl->setParameterByClass("ildatacollectionrecordeditgui", "table_id", $table_id);
                 $this->mode = (isset($_GET['mode']) AND in_array($_GET['mode'], self::$available_modes)) ? (int)$_GET['mode'] : self::MODE_VIEW;
         }

Here is the call graph for this function:

Member Function Documentation

◆ applyFilter()

ilDataCollectionRecordListGUI::applyFilter ( )

protected

Definition at line 493 of file class.ilDataCollectionRecordListGUI.php.

                                          {
                 $table = new ilDataCollectionRecordListTableGUI($this, "listRecords", $this->table_obj);
                 $table->resetOffset();
                 $table->writeFilterToSession();
                 $this->ctrl->redirect($this, 'listRecords');
                 //              $this->listRecords();
         }

◆ checkImportType()

ilDataCollectionRecordListGUI::checkImportType	(		$field,
		&	$warnings
	)

private

Parameters

ilDataCollectionField	$field
array	$warnings

Returns: bool

Definition at line 435 of file class.ilDataCollectionRecordListGUI.php.

References $lng, and $supported_import_datatypes.

Referenced by getImportFieldsFromTitles().

                                                              {
                 global $lng;
                 if (in_array($field->getDatatypeId(), $this->supported_import_datatypes)) {
                         return true;
                 } else {
                         $warnings[] = $field->getTitle() . ": " . $lng->txt("dcl_not_supported_in_import");
 
                         return false;
                 }
         }

Here is the caller graph for this function:

◆ doTableSwitch()

ilDataCollectionRecordListGUI::doTableSwitch ( )

doTableSwitch

Definition at line 485 of file class.ilDataCollectionRecordListGUI.php.

References $_POST, and $ilCtrl.

                                         {
                 global $ilCtrl;
 
                 $ilCtrl->setParameterByClass("ilObjDataCollectionGUI", "table_id", $_POST['table_id']);
                 $ilCtrl->redirect($this, "listRecords");
         }

◆ endImport()

ilDataCollectionRecordListGUI::endImport	(	$i,
		$warnings
	)

End import.

Parameters

$i
$warnings

Definition at line 375 of file class.ilDataCollectionRecordListGUI.php.

References $ilCtrl, $lng, and $tpl.

Referenced by importRecords().

                                                  {
                 global $tpl, $lng, $ilCtrl;
                 $output = new ilTemplate("tpl.dcl_import_terminated.html", true, true, "Modules/DataCollection");
                 $output->setVariable("IMPORT_TERMINATED", $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", $lng->txt("dcl_no_warnings"));
                         $output->parseCurrentBlock();
                 }
                 $output->setVariable("BACK_LINK", $ilCtrl->getLinkTargetByClass("ilDataCollectionRecordListGUI", "listRecords"));
                 $output->setVariable("BACK", $lng->txt("back"));
                 $tpl->setContent($output->get());
         }

Here is the caller graph for this function:

◆ executeCommand()

ilDataCollectionRecordListGUI::executeCommand ( )

execute command

Definition at line 83 of file class.ilDataCollectionRecordListGUI.php.

References $cmd, $data, $ilCtrl, $lng, $options, $records, $total, $tpl, ilObjDataCollection\_hasWriteAccess(), ilLinkButton\getInstance(), ilDataCollectionLinkButton\getInstance(), and ilUtil\sendInfo().

                                          {
                 global $ilCtrl;
                 $ilCtrl->saveParameter($this, 'mode');
                 $cmd = $this->ctrl->getCmd();
                 switch ($cmd) {
                         case 'listRecords':
                                 $this->setSubTabs();
                                 $this->listRecords();
                                 break;
                         case 'confirmDeleteRecords':
                                 $this->confirmDeleteRecords();
                                 break;
                         case 'cancelDelete':
                                 $this->setSubTabs();
                                 $this->listRecords();
                                 break;
                         case 'deleteRecords':
                                 $this->deleteRecords();
                                 break;
                         default:
                                 $this->$cmd();
                                 break;
                 }
         }

Here is the call graph for this function:

◆ exportExcel()

ilDataCollectionRecordListGUI::exportExcel ( )

Export DC as Excel sheet.

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

References $ilCtrl, $lng, $table_obj, exit, ilTable2GUI\EXPORT_EXCEL, and ilDataCollectionRecordListTableGUI\setRecordData().

                                       {
                 global $ilCtrl, $lng;
                 if (!($this->table_obj->getExportEnabled() || $this->table_obj->hasPermissionToFields($this->parent_obj->ref_id))) {
                         echo $lng->txt("access_denied");
                         exit;
                 }
 
                 require_once('./Modules/DataCollection/classes/class.ilDataCollectionRecordListTableGUI.php');
                 $list = new ilDataCollectionRecordListTableGUI($this, $ilCtrl->getCmd(), $this->table_obj);
                 $list->setRecordData($this->table_obj->getRecordsByFilter($list->getFilter()));
                 $list->setExternalSorting(true);
                 if (!$list->dataExists()) {
                         $this->ctrl->redirect($this->parent_obj);
                 }
 
                 $list->exportData(ilTable2GUI::EXPORT_EXCEL, true);
         }

Here is the call graph for this function:

◆ getExcelCharForInteger()

ilDataCollectionRecordListGUI::getExcelCharForInteger ( $int )

private

Definition at line 415 of file class.ilDataCollectionRecordListGUI.php.

Referenced by getImportFieldsFromTitles(), and importRecords().

                                                       {
                 $char = "";
                 $rng = range("A", "Z");
                 while ($int > 0) {
                         $diff = $int % 26;
                         $char = $rng[$diff - 1] . $char;
                         $int -= $char;
                         $int /= 26;
                 }
 
                 return $char;
         }

Here is the caller graph for this function:

◆ getImportFieldsFromTitles()

ilDataCollectionRecordListGUI::getImportFieldsFromTitles	(		$titles,
		&	$warnings
	)

private

Parameters

$titles	string[]
$warnings

Returns: ilDataCollectionField[]

Definition at line 453 of file class.ilDataCollectionRecordListGUI.php.

References $lng, ilDataCollectionStandardField\_getAllStandardFieldTitles(), checkImportType(), getExcelCharForInteger(), and ilStr\isUtf8().

Referenced by importRecords().

                                                                         {
                 global $lng;
                 $fields = $this->table_obj->getRecordFields();
                 $import_fields = array();
                 foreach ($fields as $field) {
                         if ($this->checkImportType($field, $warnings)) {
                                 foreach ($titles as $key => $value) {
                                         if (!ilStr::isUtf8($value)) {
                                                 $value = utf8_encode($value);
                                         }
                                         if ($value == $field->getTitle()) {
                                                 $import_fields[$key] = $field;
                                         }
                                 }
                         }
                 }
                 foreach ($titles as $key => $value) {
                         $std_field_titles = ilDataCollectionStandardField::_getAllStandardFieldTitles();
                         if (in_array($value, $std_field_titles)) {
                                 $warnings[] = "(1, " . $this->getExcelCharForInteger($key) . ") \"" . $value . "\" " . $lng->txt("dcl_std_field_not_importable");
                         } elseif (!isset($import_fields[$key])) {
                                 $warnings[] = "(1, " . $this->getExcelCharForInteger($key) . ") \"" . $value . "\" " . $lng->txt("dcl_row_not_found");
                         }
                 }
 
                 return $import_fields;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getReferenceFromValue()

ilDataCollectionRecordListGUI::getReferenceFromValue	(	$field,
		$value
	)

Parameters

$field	ilDataCollectionField
$value

Returns: int

Definition at line 401 of file class.ilDataCollectionRecordListGUI.php.

References ilDataCollectionCache\getFieldCache(), and ilDataCollectionCache\getTableCache().

Referenced by importRecords().

                                                               {
                 $field = ilDataCollectionCache::getFieldCache($field->getFieldRef());
                 $table = ilDataCollectionCache::getTableCache($field->getTableId());
                 $record_id = 0;
                 foreach ($table->getRecords() as $record) {
                         if ($record->getRecordField($field->getId())->getValue() == $value) {
                                 $record_id = $record->getId();
                         }
                 }
 
                 return $record_id;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importExcel()

ilDataCollectionRecordListGUI::importExcel ( )

Import Data from Excel sheet.

Definition at line 272 of file class.ilDataCollectionRecordListGUI.php.

References $file, $lng, exit, importRecords(), and showImportExcel().

                                       {
                 global $lng;
 
                 if (!($this->table_obj->hasPermissionToAddRecord($this->parent_obj->ref_id))) {
                         echo $lng->txt("access_denied");
                         exit;
                 }
                 $form = $this->initForm();
                 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()

ilDataCollectionRecordListGUI::importRecords	(	$file,
		$simulate = `false`
	)

private

Import records from Excel file.

Parameters

	$file
bool	$simulate

Definition at line 297 of file class.ilDataCollectionRecordListGUI.php.

References $file, $ilUser, $lng, endImport(), getExcelCharForInteger(), getImportFieldsFromTitles(), getReferenceFromValue(), IL_CAL_DATETIME, IL_CAL_UNIX, ilDataCollectionDatatype\INPUTFORMAT_DATETIME, ilDataCollectionDatatype\INPUTFORMAT_REFERENCE, and ilStr\isUtf8().

Referenced by importExcel().

                                                                  {
                 global $ilUser, $lng;
                 include_once("./Modules/DataCollection/libs/ExcelReader/excel_reader2.php");
 
                 $warnings = array();
                 try {
                         $excel = new Spreadsheet_Excel_Reader($file);
                 } catch (Exception $e) {
                         $warnings[] = $lng->txt("dcl_file_not_readable");
                 }
                 if (count($warnings)) {
                         $this->endImport(0, $warnings);
 
                         return;
                 }
                 $field_names = array();
                 for ($i = 1; $i <= $excel->colcount(); $i ++) {
                         $field_names[$i] = $excel->val(1, $i);
                 }
                 $fields = $this->getImportFieldsFromTitles($field_names, $warnings);
 
                 for ($i = 2; $i <= $excel->rowcount(); $i ++) {
                         $record = new ilDataCollectionRecord();
                         $record->setTableId($this->table_obj->getId());
                         $record->setOwner($ilUser->getId());
                         $date_obj = new ilDateTime(time(), IL_CAL_UNIX);
                         $record->setCreateDate($date_obj->get(IL_CAL_DATETIME));
                         $record->setTableId($this->table_id);
                         if (!$simulate) {
                                 $record->doCreate();
                         }
                         foreach ($fields as $col => $field) {
                                 $value = $excel->val($i, $col);
                                 try {
                                         if ($field->getDatatypeId() == ilDataCollectionDatatype::INPUTFORMAT_REFERENCE) {
                                                 $old = $value;
                                                 $value = $this->getReferenceFromValue($field, $value);
                                                 if (!$value) {
                                                         $warnings[] = "(" . $i . ", " . $this->getExcelCharForInteger($col) . ") " . $lng->txt("dcl_no_such_reference") . " "
                                                                 . $old;
                                                 }
                                         } else {
                                                 if ($field->getDatatypeId() == ilDataCollectionDatatype::INPUTFORMAT_DATETIME) {
                                                         $value = array(
                                                                 'date' => date('Y-m-d', strtotime($value)),
                                                                 'time' => '00:00:00',
                                                         );
                                                 }
                                         }
                                         $field->checkValidity($value, $record->getId());
                                         if (!$simulate) {
                                                 if (!ilStr::isUtf8($value)) {
                                                         $value = utf8_encode($value);
                                                 }
                                                 $record->setRecordFieldValue($field->getId(), $value);
                                         }
                                 } catch (ilDataCollectionInputException $e) {
                                         $warnings[] = "(" . $i . ", " . $this->getExcelCharForInteger($col) . ") " . $e;
                                 }
                         }
                         if (!$simulate) {
                                 $record->doUpdate();
                         }
                         if ($i - 1 > $this->max_imports) {
                                 $warnings[] = $lng->txt("dcl_max_import") . ($excel->rowcount() - 1) . " > " . $this->max_imports;
                                 break;
                         }
                 }
                 $this->endImport($i - 2, $warnings);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ recordBelongsToCollection()

ilDataCollectionRecordListGUI::recordBelongsToCollection ( ilDataCollectionRecord $record )

private

Parameters

ilDataCollectionRecord $record

Returns: bool

Definition at line 598 of file class.ilDataCollectionRecordListGUI.php.

References $_GET, $ilCtrl, $lng, and ilDataCollectionRecord\getTable().

Referenced by sendFile().

                                                                                    {
                 $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()

ilDataCollectionRecordListGUI::resetFilter ( )

protected

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

                                          {
                 $table = new ilDataCollectionRecordListTableGUI($this, "listRecords", $this->table_obj);
                 $table->resetOffset();
                 $table->resetFilter();
                 $this->ctrl->redirect($this, 'listRecords');
                 //              $this->listRecords();
         }

◆ sendFile()

ilDataCollectionRecordListGUI::sendFile ( )

send File to User

Definition at line 514 of file class.ilDataCollectionRecordListGUI.php.

References $_GET, $_POST, $ilCtrl, $lng, $tpl, ilUtil\deliverFile(), ilDataCollectionCache\getRecordCache(), recordBelongsToCollection(), ilUtil\sendInfo(), and ilUtil\sendSuccess().

                                    {
                 global $ilAccess;
                 //need read access to receive file
                 if ($ilAccess->checkAccess("read", "", $this->parent_obj->ref_id)) {
                         $rec_id = $_GET['record_id'];
                         $record = ilDataCollectionCache::getRecordCache($rec_id);
                         $field_id = $_GET['field_id'];
                         $file_obj = new ilObjFile($record->getRecordFieldValue($field_id), false);
                         if (!$this->recordBelongsToCollection($record, $this->parent_obj->ref_id)) {
                                 return;
                         }
                         ilUtil::deliverFile($file_obj->getFile(), $file_obj->getTitle());
                 }
         }

Here is the call graph for this function:

◆ showImportExcel()

ilDataCollectionRecordListGUI::showImportExcel ( $form = NULL )

Definition at line 229 of file class.ilDataCollectionRecordListGUI.php.

References $file, $ilCtrl, $lng, $tpl, and ilFormPropertyGUI\setInfo().

Referenced by importExcel().

                                                       {
                 global $tpl;
                 if (!$form) {
                         $form = $this->initForm();
                 }
                 $tpl->setContent($form->getHTML());
         }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $available_modes

ilDataCollectionRecordListGUI::$available_modes = array( self::MODE_VIEW, self::MODE_MANAGE )

staticprotected

Definition at line 57 of file class.ilDataCollectionRecordListGUI.php.

◆ $ctrl

ilDataCollectionRecordListGUI::$ctrl

protected

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

◆ $max_imports

ilDataCollectionRecordListGUI::$max_imports = 100

protected

Definition at line 35 of file class.ilDataCollectionRecordListGUI.php.

◆ $mode

ilDataCollectionRecordListGUI::$mode = self::MODE_VIEW

protected

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

◆ $supported_import_datatypes

ilDataCollectionRecordListGUI::$supported_import_datatypes

protected

Initial value:

= array(
                ilDataCollectionDatatype::INPUTFORMAT_BOOLEAN,
                ilDataCollectionDatatype::INPUTFORMAT_NUMBER,
                ilDataCollectionDatatype::INPUTFORMAT_REFERENCE,
                ilDataCollectionDatatype::INPUTFORMAT_TEXT,
                ilDataCollectionDatatype::INPUTFORMAT_DATETIME
        )

Definition at line 39 of file class.ilDataCollectionRecordListGUI.php.

Referenced by checkImportType().

◆ $table_obj

ilDataCollectionRecordListGUI::$table_obj

protected

Definition at line 49 of file class.ilDataCollectionRecordListGUI.php.

Referenced by exportExcel().

◆ MODE_MANAGE

const ilDataCollectionRecordListGUI::MODE_MANAGE = 2

Definition at line 25 of file class.ilDataCollectionRecordListGUI.php.

Referenced by ilDataCollectionRecordListTableGUI\fillRowExcel().

◆ MODE_VIEW

const ilDataCollectionRecordListGUI::MODE_VIEW = 1

Definition at line 24 of file class.ilDataCollectionRecordListGUI.php.

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

Modules/DataCollection/classes/class.ilDataCollectionRecordListGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ applyFilter()

◆ checkImportType()

◆ doTableSwitch()

◆ endImport()

◆ executeCommand()

◆ exportExcel()

◆ getExcelCharForInteger()

◆ getImportFieldsFromTitles()

◆ getReferenceFromValue()

◆ importExcel()

◆ importRecords()

◆ recordBelongsToCollection()

◆ resetFilter()

◆ sendFile()

◆ showImportExcel()

Field Documentation

◆ $available_modes

◆ $ctrl

◆ $max_imports

◆ $mode

◆ $supported_import_datatypes

◆ $table_obj

◆ MODE_MANAGE

◆ MODE_VIEW