ilDclContentImporter Class Reference

Hook-Class for exporting data-collections (used in SOAP-Class) This Class avoids duplicated code by routing the request to the right place. More...

Collaboration diagram for ilDclContentImporter:

Public Member Functions
	__construct ($ref_id, $table_id=null)
	import ($file, $simulate=false)

Data Fields
const	EXPORT_EXCEL = 'xls'

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

Protected Attributes
	$max_imports = 100
	$supported_import_datatypes
	$warnings
	$ref_id
	$table_id
	$dcl
	$tables
	$lng

Detailed Description

Hook-Class for exporting data-collections (used in SOAP-Class) This Class avoids duplicated code by routing the request to the right place.

Author

Michael Herren mh@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Constructor & Destructor Documentation

__construct()

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

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

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

References $DIC, $lng, $ref_id, and $table_id.

Member Function Documentation

checkImportType()

ilDclContentImporter::checkImportType (   $field )

protected

Parameters

ilDclBaseFieldModel

$field

Returns

bool

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

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

Referenced by getImportFieldsFromTitles().

Here is the caller graph for this function:

getImportFieldsFromTitles()

ilDclContentImporter::getImportFieldsFromTitles (   $table,   $titles  )

protected

Parameters

ilDclTable	$table
	$titles	string[]

Returns

ilDclBaseFieldModel[]

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

                                                                      {
                $fields = $table->getRecordFields();
                $import_fields = array();
                foreach ($fields as $field) {
                        if ($this->checkImportType($field)) {
                                // the fields will add themselves to $import_fields if their title is in $titles
                                $field->checkTitlesForImport($titles, $import_fields);
                        }
                }
 
                foreach ($titles as $key => $value) {
                        $std_field_titles = ilDclStandardField::_getAllStandardFieldTitles();
                        if (in_array($value, $std_field_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\_getAllStandardFieldTitles(), checkImportType(), and ilDataCollectionImporter\getExcelCharForInteger().

Referenced by import().

Here is the call graph for this function:

Here is the caller graph for this function:

import()

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

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

                                                         {
                global $DIC;
                $ilUser = $DIC['ilUser'];
 
                $this->warnings = array();
                try {
                        $excel = new ilExcel();
                        $excel->loadFromFile($file);
                } catch (Exception $e) {
                        $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 array('line'=>0, 'warnings'=>$this->warnings);
                }
 
                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 = array();
                        $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($ilUser->getId());
                                $date_obj = new ilDateTime(time(), IL_CAL_UNIX);
                                $record->setCreateDate($date_obj->get(IL_CAL_DATETIME));
                                $record->setTableId($table->getId());
                                if (!$simulate) {
                                        $record->doCreate();
                                }
                                $fields_failed = 0;
                                foreach ($fields as $col => $field) {
                                        try {
                                                $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 array('line'=>($i-2 < 0 ? 0 : $i-2), 'warnings'=>$this->warnings);
        }

References $column, $DIC, $file, $ilUser, ilDataCollectionImporter\getExcelCharForInteger(), getImportFieldsFromTitles(), IL_CAL_DATETIME, and IL_CAL_UNIX.

Here is the call graph for this function:

Field Documentation

$dcl

ilDclContentImporter::$dcl

protected

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

$lng

ilDclContentImporter::$lng

protected

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

Referenced by __construct().

$max_imports

ilDclContentImporter::$max_imports = 100

protected

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

$ref_id

ilDclContentImporter::$ref_id

protected

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

Referenced by __construct().

$supported_import_datatypes

ilDclContentImporter::$supported_import_datatypes

protected

Initial value:

= array(
                ilDclDatatype::INPUTFORMAT_BOOLEAN,
                ilDclDatatype::INPUTFORMAT_NUMBER,
                ilDclDatatype::INPUTFORMAT_REFERENCE,
                ilDclDatatype::INPUTFORMAT_TEXT,
                ilDclDatatype::INPUTFORMAT_DATETIME,
                ilDclDatatype::INPUTFORMAT_PLUGIN
        )

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

$table_id

ilDclContentImporter::$table_id

protected

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

Referenced by __construct().

$tables

ilDclContentImporter::$tables

protected

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

$warnings

ilDclContentImporter::$warnings

protected

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

EXPORT_EXCEL

const ilDclContentImporter::EXPORT_EXCEL = 'xls'

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

---

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

• Modules/DataCollection/classes/Content/class.ilDclContentImporter.php