ilDataCollectionRecordListGUI Class Reference

Class ilDataCollectionField. More...

Collaboration diagram for ilDataCollectionRecordListGUI:

Public Member Functions
	__construct (ilObjDataCollectionGUI $a_parent_obj, $table_id)
	Constructor. More...
	executeCommand ()
	execute command More...
	listRecords ()
	List Records. More...
	exportExcel ()
	showImportExcel ($form=null)
	importExcel ()
	endImport ($i, $warnings)
	getReferenceFromValue ($field, $value)
	doTableSwitch ()
	doTableSwitch More...
	applyFilter ()
	resetFilter ()
	sendFile ()

Protected Attributes
	$max_imports = 100
	$supported_import_datatypes

Private Member Functions
	importRecords ($file, $simulate=false)
	getExcelCharForInteger ($int)
	checkImportType ($field, &$warnings)
	getImportFieldsFromTitles ($titles, &$warnings)
	recordBelongsToCollection (ilDataCollectionRecord $record)

Private Attributes
	$table_obj

Detailed Description

Class ilDataCollectionField.

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 20 of file class.ilDataCollectionRecordListGUI.php.

Constructor & Destructor Documentation

__construct()

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

Constructor.

Parameters

object	$a_parent_obj
int	$table_id

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

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

    {
        global $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);

        return;
    }

Here is the call graph for this function:

Member Function Documentation

applyFilter()

ilDataCollectionRecordListGUI::applyFilter

(

)

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

References $ilCtrl, and listRecords().

    {
        global $ilCtrl;

        $table =  new ilDataCollectionRecordListTableGUI($this, "listRecords", $this->table_obj);
        $table->resetOffset();
        $table->writeFilterToSession();
        $this->listRecords();
    }

Here is the call graph for this function:

checkImportType()

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

private

Parameters

$field	ilDataCollectionField
$warnings	array

Definition at line 325 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 363 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
	)

Definition at line 275 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 58 of file class.ilDataCollectionRecordListGUI.php.

References $cmd, $ilCtrl, and $tpl.

    {
        global $tpl, $ilCtrl;

        $cmd = $ilCtrl->getCmd();

        switch($cmd)
        {
            default:
                $this->$cmd();
                break;
        }
    }

exportExcel()

ilDataCollectionRecordListGUI::exportExcel

(

)

Definition at line 148 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);
        $list->exportData(ilTable2GUI::EXPORT_EXCEL, true);
    }

Here is the call graph for this function:

getExcelCharForInteger()

ilDataCollectionRecordListGUI::getExcelCharForInteger (   $int )

private

Definition at line 309 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[]

Returns

ilDataCollectionField[]

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

References $lng, checkImportType(), and getExcelCharForInteger().

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($value == $field->getTitle())
                        $import_fields[$key] = $field;
                }
            }
        }
        foreach($titles as $key => $value)
        {
            if(!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 299 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

(

)

Definition at line 199 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

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

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

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' => '',
                        );
                    }
                    $field->checkValidity($value, $record->getId());
                    if(!$simulate) $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:

listRecords()

ilDataCollectionRecordListGUI::listRecords

(

)

List Records.

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

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

Referenced by applyFilter(), and resetFilter().

    {
        global $ilTabs, $tpl, $lng, $ilCtrl, $ilToolbar;

        // Show tables
        require_once("./Modules/DataCollection/classes/class.ilDataCollectionTable.php");
        if(ilObjDataCollection::_hasWriteAccess($this->parent_obj->ref_id))
            $tables = $this->parent_obj->object->getTables();
        else
            $tables = $this->parent_obj->object->getVisibleTables();


        foreach($tables as $table)
        {
            $options[$table->getId()] = $table->getTitle();
        }

        $tpl->addCss("./Modules/DataCollection/css/dcl_reference_hover.css");

        if(count($options) > 0){
            include_once './Services/Form/classes/class.ilSelectInputGUI.php';
            $table_selection = new ilSelectInputGUI('', 'table_id');
            $table_selection->setOptions($options);
            $table_selection->setValue($this->table_id);

            $ilToolbar->setFormAction($ilCtrl->getFormActionByClass("ilDataCollectionRecordListGUI", "doTableSwitch"));
            $ilToolbar->addText($lng->txt("dcl_table"));
            $ilToolbar->addInputItem($table_selection);
            $ilToolbar->addFormButton($lng->txt('change'),'doTableSwitch');
            $ilToolbar->addSeparator();
        }
        if(($this->table_obj->getExportEnabled() || $this->table_obj->hasPermissionToFields($this->parent_obj->ref_id)) && count($this->table_obj->getExportableFields()))
            $ilToolbar->addButton($lng->txt('dcl_export_table_excel'), $ilCtrl->getFormActionByClass("ildatacollectionrecordlistgui", "exportExcel"));

        if($this->table_obj->hasPermissionToAddRecord($this->parent_obj->ref_id) && $this->table_obj->hasCustomFields()){
            $ilCtrl->setParameterByClass("ildatacollectionrecordeditgui","record_id", null);
            $ilToolbar->addButton($lng->txt("dcl_import_records .xls"), $ilCtrl->getFormActionByClass("ildatacollectionrecordlistgui", "showImportExcel"));
            $ilToolbar->addButton($lng->txt("dcl_add_new_record"), $ilCtrl->getFormActionByClass("ildatacollectionrecordeditgui", "create"),
                                "", "", "", "", "submit emphsubmit"); // #11502
        }

        // requested not to implement this way...
        //$tpl->addJavaScript("Modules/DataCollection/js/fastTableSwitcher.js");
        $tpl->addJavaScript("Modules/DataCollection/js/datacollection.js");

        if(count($this->table_obj->getRecordFields()) == 0){
            ilUtil::sendInfo($lng->txt("dcl_no_fields_yet")." ".($this->table_obj->hasPermissionToFields($this->parent_obj->ref_id)?$lng->txt("dcl_create_fields"):""));
        }

        $list = new ilDataCollectionRecordListTableGUI($this, "listRecords", $this->table_obj);
        $list->setExternalSegmentation(true);
        $list->setExternalSorting(true);
        $list->determineLimit();
        $list->determineOffsetAndOrder();
        $data = $this->table_obj->getPartialRecords($list->getOrderField(), $list->getOrderDirection(), $list->getLimit(), $list->getOffset(), $list->getFilter());
        $records = $data['records'];
        $total = $data['total'];
        $list->setMaxCount($total);
        $list->setRecordData($records);

        $tpl->getStandardTemplate();
        $tpl->setPermanentLink("dcl", $this->parent_obj->ref_id);
        if ($desc = $this->table_obj->getDescription()) {
            $desc = "<div class='ilDclTableDescription'>{$desc}</div>";
        }
        $tpl->setContent($desc . $list->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

recordBelongsToCollection()

ilDataCollectionRecordListGUI::recordBelongsToCollection ( ilDataCollectionRecord  $record )

private

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

References 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

(

)

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

References $ilCtrl, and listRecords().

    {
        global $ilCtrl;

        $table =  new ilDataCollectionRecordListTableGUI($this, "listRecords", $this->table_obj);
        $table->resetOffset();
        $table->resetFilter();
        $this->listRecords();
    }

Here is the call graph for this function:

sendFile()

ilDataCollectionRecordListGUI::sendFile

(

)

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

References $_GET, ilUtil\deliverFile(), ilDataCollectionCache\getRecordCache(), and recordBelongsToCollection().

    {
        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 163 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

$max_imports

ilDataCollectionRecordListGUI::$max_imports = 100

protected

Definition at line 23 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 25 of file class.ilDataCollectionRecordListGUI.php.

Referenced by checkImportType().

$table_obj

ilDataCollectionRecordListGUI::$table_obj

private

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

Referenced by exportExcel().

---

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

• Modules/DataCollection/classes/class.ilDataCollectionRecordListGUI.php