ilDclContentImporter Class Reference

Collaboration diagram for ilDclContentImporter:

Public Member Functions
	__construct (int $ref_id, ?int $table_id=null)
	import (string $file, bool $simulate=false)
	sendImportTemplate ()

Data Fields
const	EXPORT_EXCEL = 'xlsx'
const array	SUPPORTED_IMPORT_DATATYPES

Protected Member Functions
	checkImportType (ilDclBaseFieldModel $field)
	getImportFieldsFromTitles (ilDclTable $table, array $titles)

Protected Attributes
int	$max_imports = 100
array	$warnings
int	$ref_id
	Ref-ID of DataCollection. More...
int	$table_id
	Table-Id for export. More...
ilObjDataCollection	$dcl
array	$tables
ilLanguage	$lng
ilObjUser	$user

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilDclContentImporter::__construct	(	int	$ref_id,
		?int	$table_id = null
	)

Definition at line 59 of file class.ilDclContentImporter.php.

    {
        global $DIC;
 
        $this->ref_id = $ref_id;
        $this->table_id = $table_id;
 
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
 
        $this->dcl = new ilObjDataCollection($ref_id);
        $this->tables = ($table_id) ? [$this->dcl->getTableById($table_id)] : $this->dcl->getTables();
    }

References $DIC, $ref_id, $table_id, ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

checkImportType()

ilDclContentImporter::checkImportType ( ilDclBaseFieldModel  $field )

protected

Definition at line 200 of file class.ilDclContentImporter.php.

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

References ilDclBaseFieldModel\getDatatypeId(), ilDclBaseFieldModel\getTitle(), and ILIAS\Repository\lng().

Referenced by getImportFieldsFromTitles().

Here is the call graph for this function:

Here is the caller graph for this function:

getImportFieldsFromTitles()

ilDclContentImporter::getImportFieldsFromTitles ( ilDclTable  $table, array  $titles  )

protected

Parameters

string[]

$titles

Returns

ilDclBaseFieldModel[]

Definition at line 215 of file class.ilDclContentImporter.php.

                                                                                  : array
    {
        $fields = $table->getRecordFields();
        $import_fields = [];
        foreach ($fields as $field) {
            if ($this->checkImportType($field)) {
                // the fields will add themselves to $import_fields (at the correct position) if their title is in $titles
                $field->checkTitlesForImport($titles, $import_fields);
            }
        }
 
        foreach ($titles as $key => $value) {
            $not_importable_titles = ilDclStandardField::_getNonImportableStandardFieldTitles();
            $importable_titles = ilDclStandardField::_getImportableStandardFieldTitle();
            foreach ($importable_titles as $identifier => $values) {
                if (in_array($value, $values)) {
                    $std_field = new ilDclStandardField();
                    $std_field->setId(substr($identifier, 4));
                    $import_fields[$key] = $std_field;
                    continue 2;
                }
            }
            if (in_array($value, $not_importable_titles)) {
                $this->warnings[] = "(1, " . ilDataCollectionImporter::getExcelCharForInteger($key) . ") \"" . $value . "\" " . $this->lng->txt("dcl_std_field_not_importable");
            } else {
                if (!isset($import_fields[$key])) {
                    $this->warnings[] = "(1, " . ilDataCollectionImporter::getExcelCharForInteger($key + 1) . ") \"" . $value . "\" " . $this->lng->txt("dcl_row_not_found");
                }
            }
        }
 
        return $import_fields;
    }

References ilDclStandardField\_getImportableStandardFieldTitle(), ilDclStandardField\_getNonImportableStandardFieldTitles(), checkImportType(), ilDataCollectionImporter\getExcelCharForInteger(), ilDclTable\getRecordFields(), and ILIAS\Repository\lng().

Referenced by import().

Here is the call graph for this function:

Here is the caller graph for this function:

import()

ilDclContentImporter::import	(	string	$file,
		bool	$simulate = false
	)

Exceptions

ilException
ilDateTimeException

Definition at line 77 of file class.ilDclContentImporter.php.

                                                                : array
    {
        $this->warnings = [];
        $excel = new ilExcel();
        try {
            $excel->loadFromFile($file);
        } catch (Exception) {
            $this->warnings[] = $this->lng->txt("dcl_file_not_readable");
        }
 
        $sheet_count = $excel->getSheetCount();
        $excel->setActiveSheet(0);
 
        if ($sheet_count != count($this->tables)) {
            $this->warnings[] = $this->lng->txt('dcl_file_not_readable');
        }
 
        if (count($this->warnings)) {
            return ['line' => 0, 'warnings' => $this->warnings];
        }
 
        $i = 0;
 
        for ($sheet = 0; $sheet < $sheet_count; $sheet++) {
            $excel->setActiveSheet($sheet);
            $table = $this->tables[$sheet];
 
            // only 31 character-long table-titles are allowed
            $sheet_title = substr($table->getTitle(), 0, 31);
            if ($excel->getSheetTitle() != $sheet_title) {
                $this->warnings[] = $this->lng->txt('dcl_table_title_not_matching');
                continue;
            }
 
            $field_names = [];
            $sheet_data = $excel->getSheetAsArray();
 
            foreach ($sheet_data[0] as $column) {
                $field_names[] = $column;
            }
            $fields = $this->getImportFieldsFromTitles($table, $field_names);
 
            $records_failed = 0;
            for ($i = 2; $i <= count($sheet_data); $i++) {
                $record = new ilDclBaseRecordModel();
                $record->setOwner($this->user->getId());
                $date_obj = new ilDateTime(time(), IL_CAL_UNIX);
                $record->setCreateDate($date_obj);
                $record->setLastUpdate($date_obj);
                $record->setLastEditBy($this->user->getId());
                $record->setTableId($table->getId());
                if (!$simulate) {
                    $record->doCreate();
                }
                $fields_failed = 0;
                foreach ($fields as $col => $field) {
                    try {
                        if ($field->isStandardField()) {
                            $record->setStandardFieldValueFromExcel($excel, $i, $col, $field);
                        } else {
                            $value = $record->getRecordFieldValueFromExcel($excel, $i, $col, $field);
 
                            if (is_array($value) && isset($value['warning'])) {
                                $this->warnings[] = $value['warning'];
                                $value = '';
                            }
 
                            $field->checkValidity($value, $record->getId());
                            if (!$simulate) {
                                $record->setRecordFieldValue($field->getId(), $value);
                            }
                        }
                    } catch (ilDclInputException $e) {
                        $fields_failed++;
                        $this->warnings[] = "(" . $i . ", " . ilDataCollectionImporter::getExcelCharForInteger($col + 1) . ") " . $e;
                    }
                }
 
                if ($fields_failed < count($fields)) {
                    $record_imported = true;
                } else {
                    $records_failed++;
                    $record_imported = false;
                }
 
                if (!$simulate) {
                    if (!$record_imported) { // if no fields have been filled, delete the record again
                        $record->doDelete(true); // omit notification
                    } else {
                        $record->doUpdate();
                    }
                }
                if (($i - 1) - $records_failed > $this->max_imports) {
                    $this->warnings[] = $this->lng->txt("dcl_max_import") . (count($sheet_data) - 1) . " > " . $this->max_imports;
                    break;
                }
            }
        }
 
        return ['line' => (max($i - 2, 0)), 'warnings' => $this->warnings];
    }

References Vendor\Package\$e, $warnings, ilDataCollectionImporter\getExcelCharForInteger(), getImportFieldsFromTitles(), IL_CAL_UNIX, ILIAS\Repository\lng(), and ILIAS\Repository\user().

Referenced by ilDclRecordListGUI\importRecords().

Here is the call graph for this function:

Here is the caller graph for this function:

sendImportTemplate()

ilDclContentImporter::sendImportTemplate

(

)

Definition at line 179 of file class.ilDclContentImporter.php.

                                        : void
    {
        $adapter = new ilExcel();
        $exporter = new ilDclContentExporter($this->ref_id, $this->table_id);
 
        foreach ($this->tables as $table) {
            $adapter->addSheet($table->getTitle());
            $row = 1;
            $col = 0;
            foreach ($table->getRecordFields() as $field) {
                if (in_array($field->getDatatypeId(), $this::SUPPORTED_IMPORT_DATATYPES, true)) {
                    $field->fillHeaderExcel($adapter, $row, $col);
                }
            }
        }
 
        $basename = $this->tables[0]->getTitle() . '_import_template';
        $filename = $exporter->sanitizeFilename($basename);
        $adapter->sendToClient($filename);
    }

References ILIAS\TestQuestionPool\ExportImport\Foundation\Export\$exporter, and $filename.

Referenced by ilDclRecordListGUI\downloadImportTemplate().

Here is the caller graph for this function:

Field Documentation

$dcl

ilObjDataCollection ilDclContentImporter::$dcl

protected

Definition at line 50 of file class.ilDclContentImporter.php.

$lng

ilLanguage ilDclContentImporter::$lng

protected

Definition at line 56 of file class.ilDclContentImporter.php.

$max_imports

int ilDclContentImporter::$max_imports = 100

protected

Definition at line 38 of file class.ilDclContentImporter.php.

$ref_id

int ilDclContentImporter::$ref_id

protected

Ref-ID of DataCollection.

Definition at line 44 of file class.ilDclContentImporter.php.

Referenced by __construct().

$table_id

int ilDclContentImporter::$table_id

protected

Table-Id for export.

Definition at line 48 of file class.ilDclContentImporter.php.

Referenced by __construct().

$tables

array ilDclContentImporter::$tables

protected

Definition at line 54 of file class.ilDclContentImporter.php.

$user

ilObjUser ilDclContentImporter::$user

protected

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

$warnings

array ilDclContentImporter::$warnings

protected

Definition at line 40 of file class.ilDclContentImporter.php.

Referenced by import().

EXPORT_EXCEL

const ilDclContentImporter::EXPORT_EXCEL = 'xlsx'

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

SUPPORTED_IMPORT_DATATYPES

const array ilDclContentImporter::SUPPORTED_IMPORT_DATATYPES

Initial value:

= [
        ilDclDatatype::INPUTFORMAT_BOOLEAN,
        ilDclDatatype::INPUTFORMAT_NUMBER,
        ilDclDatatype::INPUTFORMAT_REFERENCE,
        ilDclDatatype::INPUTFORMAT_TEXT,
        ilDclDatatype::INPUTFORMAT_DATE,
        ilDclDatatype::INPUTFORMAT_TEXT_SELECTION,
        ilDclDatatype::INPUTFORMAT_DATE_SELECTION,
        ilDclDatatype::INPUTFORMAT_DATETIME,
        ilDclDatatype::INPUTFORMAT_DATETIME_SELECTION,
    ]

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

Referenced by ilDclRecordListGUI\hasImportableFields().

---

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

• components/ILIAS/DataCollection/classes/Content/class.ilDclContentImporter.php