ilDclRecordListGUI Class Reference

Collaboration diagram for ilDclRecordListGUI:

Public Member Functions
	__construct (ilObjDataCollectionGUI $a_parent_obj, $table_id)
	executeCommand ()
	execute command More...
	showImportExcel ($form=null)
	initImportForm ()
	Init form. More...
	importExcel ()
	Import Data from Excel sheet. More...
	endImport ($i, $warnings)
	End import. More...
	doTableSwitch ()
	doTableSwitch More...
	doTableViewSwitch ()
	doTableViewSwitch More...
	sendFile ()
	send File to User More...

Data Fields
const	GET_TABLE_ID = 'table_id'
const	GET_TABLEVIEW_ID = 'tableview_id'
const	GET_MODE = 'mode'
const	MODE_VIEW = 1
const	MODE_MANAGE = 2
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 ()
	getAvailableTables ()
	getRecordListTableGUI ($use_tableview_filter)
	createSwitchers ()
	checkAccess ()

Protected Attributes
	$mode = self::MODE_VIEW
	$table_obj
	$ctrl
	$lng
	$tableview_id

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...
	recordBelongsToCollection (ilDclBaseRecordModel $record)

Detailed Description

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

Constructor & Destructor Documentation

__construct()

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

Parameters

ilObjDataCollectionGUI	$a_parent_obj
	$table_id

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

References $_GET, $DIC, $ilCtrl, $lng, $tableview_id, and ilDclCache\getTableCache().

    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $lng = $DIC['lng'];
        $this->ctrl = $ilCtrl;
        $this->lng = $lng;

        $this->table_id = $table_id;
        if ($this->table_id == null) {
            $this->table_id = filter_input(INPUT_GET, self::GET_TABLE_ID);
        }

        $this->obj_id = $a_parent_obj->obj_id;
        $this->parent_obj = $a_parent_obj;
        $this->table_obj = ilDclCache::getTableCache($table_id);

        if ($tableview_id = filter_input(INPUT_GET, self::GET_TABLEVIEW_ID)) {
            $this->tableview_id = $tableview_id;
        } else {
            //get first visible tableview
            $this->tableview_id = $this->table_obj->getFirstTableViewId($this->parent_obj->ref_id);
            //this is for ilDclTextRecordRepresentation with link to detail page
            $_GET[self::GET_TABLEVIEW_ID] = $this->tableview_id; //TODO: find better way
        }
        
        $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 = (isset($_GET[self::GET_MODE]) && in_array($_GET[self::GET_MODE], self::$available_modes)) ? (int) $_GET[self::GET_MODE] : self::MODE_VIEW;
    }

Here is the call graph for this function:

Member Function Documentation

applyFilter()

ilDclRecordListGUI::applyFilter ( )

protected

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

References $table.

    {
        $table = new ilDclRecordListTableGUI($this, "listRecords", $this->table_obj, $this->tableview_id);
        $table->initFilter();
        $table->resetOffset();
        $table->writeFilterToSession();
        $this->ctrl->redirect($this, self::CMD_LIST_RECORDS);
    }

checkAccess()

ilDclRecordListGUI::checkAccess ( )

protected

Returns

bool

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

Referenced by executeCommand().

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

Here is the caller graph for this function:

createSwitchers()

ilDclRecordListGUI::createSwitchers ( )

protected

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

References $DIC, PHPMailer\PHPMailer\$options, getAvailableTables(), and ilSubmitButton\getInstance().

Referenced by executeCommand().

    {
        global $DIC;
        $ilToolbar = $DIC['ilToolbar'];
        $ilToolbar->setFormAction($this->ctrl->getFormActionByClass("ilDclRecordListGUI", "doTableSwitch"));

        //table switcher
        $options = $this->getAvailableTables();
        if (count($options) > 1) {
            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->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 = array();
        foreach ($this->table_obj->getVisibleTableViews($this->parent_obj->ref_id) 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

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

References $_POST.

    {
        $this->ctrl->clearParameters($this);
        $this->ctrl->setParameterByClass(ilObjDataCollectionGUI::class, "table_id", $_POST['table_id']);
        $this->ctrl->setParameter($this, "table_id", $_POST['table_id']);
        $this->ctrl->clearParametersByClass(ilObjDataCollectionGUI::class, 'tableview_id');
        $this->ctrl->redirect($this, self::CMD_SHOW);
    }

doTableViewSwitch()

ilDclRecordListGUI::doTableViewSwitch

(

)

doTableViewSwitch

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

References $_POST.

    {
        $this->ctrl->setParameterByClass("ilObjDataCollectionGUI", "tableview_id", $_POST['tableview_id']);
        $this->ctrl->redirect($this, self::CMD_SHOW);
    }

endImport()

ilDclRecordListGUI::endImport	(		$i,
			$warnings
	)

End import.

Parameters

$i
$warnings

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

References $DIC, $i, Sabre\VObject\$output, $tpl, $warning, and $warnings.

Referenced by importRecords().

    {
        global $DIC;
        $tpl = $DIC['tpl'];
        $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"));
        $tpl->setContent($output->get());
    }

Here is the caller graph for this function:

executeCommand()

ilDclRecordListGUI::executeCommand

(

)

execute command

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

References $DIC, $ilSetting, $list, $tpl, checkAccess(), createSwitchers(), ilLinkButton\getInstance(), getRecordListTableGUI(), ilObjDataCollectionAccess\hasAccessToFields(), ilObjDataCollectionAccess\hasPermissionToAddRecord(), ilUtil\sendFailure(), ilUtil\sendInfo(), and ilUtil\stripSlashes().

    {
        global $DIC;
        $ilTabs = $DIC['ilTabs'];

        if (!$this->checkAccess()) {
            ilUtil::sendFailure($this->lng->txt('permission_denied'), true);

            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->listRecords(true);
                break;
            case self::CMD_LIST_RECORDS:
                $this->setSubTabs();
                $this->listRecords();
                break;
            case self::CMD_CONFIRM_DELETE_RECORDS:
                $this->confirmDeleteRecords();
                break;
            case self::CMD_CANCEL_DELETE:
                $this->setSubTabs();
                $this->listRecords();
                break;
            case self::CMD_DELETE_RECORDS:
                $this->deleteRecords();
                break;
            case self::CMD_SHOW_IMPORT_EXCEL:
                $ilTabs->setBack2Target($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

array

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

References PHPMailer\PHPMailer\$options, $table, and ilObjDataCollectionAccess\hasWriteAccess().

Referenced by createSwitchers().

    {
        if (ilObjDataCollectionAccess::hasWriteAccess($this->parent_obj->ref_id)) {
            $tables = $this->parent_obj->object->getTables();
        } else {
            $tables = $this->parent_obj->object->getVisibleTables();
        }
        $options = array();
        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:

getRecordListTableGUI()

ilDclRecordListGUI::getRecordListTableGUI (   $use_tableview_filter )

protected

Parameters

$use_tableview_filter

Returns

array

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

References $data, $list, $records, $table_obj, and $total.

Referenced by executeCommand().

    {
        $table_obj = $this->table_obj;

        $list = new ilDclRecordListTableGUI($this, "listRecords", $table_obj, $this->tableview_id, $this->mode);
        if ($use_tableview_filter) {
            $list->initFilter();
            $list->resetFilter();
            $list->initFilterFromTableView();
        } else {
            $list->initFilter();
        }

        $list->setExternalSegmentation(true);
        $list->setExternalSorting(true);
        $list->determineOffsetAndOrder();

        $limit = $list->getLimit();
        $offset = $list->getOffset();

        $num_records = count($table_obj->getPartialRecords($list->getOrderField(), $list->getOrderDirection(), $limit, $offset, $list->getFilter()));

        // Fix no data found on new filter application when on a site other than the first
        if ($num_records === 0) {
            $list->resetOffset();
            $offset = 0;
        }

        $data = $table_obj->getPartialRecords($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 caller graph for this function:

importExcel()

ilDclRecordListGUI::importExcel

(

)

Import Data from Excel sheet.

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

References $form, ilObjDataCollectionAccess\hasPermissionToAddRecord(), importRecords(), initImportForm(), and showImportExcel().

    {
        if (!(ilObjDataCollectionAccess::hasPermissionToAddRecord($this->parent_obj->ref_id, $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 (   $file,   $simulate = false  )

private

Import records from Excel file.

Parameters

	$file
bool	$simulate

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

References $result, and endImport().

Referenced by importExcel().

    {
        $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:

initImportForm()

ilDclRecordListGUI::initImportForm

(

)

Init form.

Returns

ilPropertyFormGUI

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

References $form, ilFormPropertyGUI\setInfo(), and ilFormPropertyGUI\setRequired().

Referenced by importExcel(), and showImportExcel().

    {
        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $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

Parameters

ilDclBaseRecordModel

$record

Returns

bool

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

References $_GET, $DIC, $mode, $table, and ilDclBaseRecordModel\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()

ilDclRecordListGUI::resetFilter ( )

protected

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

References $table.

    {
        $table = new ilDclRecordListTableGUI($this, "show", $this->table_obj, $this->tableview_id);
        $table->initFilter();
        $table->resetOffset();
        $table->resetFilter();
        $this->ctrl->redirect($this, self::CMD_LIST_RECORDS);
    }

sendFile()

ilDclRecordListGUI::sendFile

(

)

send File to User

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

References $_GET, $_POST, $DIC, $ilUser, $key, $tpl, ilUtil\deliverFile(), ilDclCache\getRecordCache(), ilDclCache\getRecordFieldCache(), ilDclCache\getRecordRepresentation(), ilDclPropertyFormGUI\rebuildTempFileByHash(), recordBelongsToCollection(), and ilUtil\sendInfo().

    {
        global $DIC;
        $ilAccess = $DIC['ilAccess'];
        $ilUser = $DIC['ilUser'];
        //need read access to receive file
        if ($ilAccess->checkAccess("read", "", $this->parent_obj->ref_id)) {

            // deliver temp-files
            if (isset($_GET['ilfilehash'])) {
                $filehash = $_GET['ilfilehash'];
                $field_id = $_GET['field_id'];
                ilDclPropertyFormGUI::rebuildTempFileByHash($filehash);

                $filepath = $_FILES["field_" . $field_id]['tmp_name'];
                $filetitle = $_FILES["field_" . $field_id]['name'];
            } else {
                $rec_id = $_GET['record_id'];
                $record = ilDclCache::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;
                }
                $filepath = $file_obj->getFile();
                $filetitle = $file_obj->getTitle();
            }

            ilUtil::deliverFile($filepath, $filetitle);
        }
    }

Here is the call graph for this function:

showImportExcel()

ilDclRecordListGUI::showImportExcel

(

$form = null

)

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

References $DIC, $form, $tpl, and initImportForm().

Referenced by importExcel().

    {
        global $DIC;
        $tpl = $DIC['tpl'];
        if (!$form) {
            $form = $this->initImportForm();
        }
        $tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$available_modes

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

staticprotected

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

$ctrl

ilDclRecordListGUI::$ctrl

protected

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

$lng

ilDclRecordListGUI::$lng

protected

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

Referenced by __construct().

$mode

ilDclRecordListGUI::$mode = self::MODE_VIEW

protected

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

Referenced by recordBelongsToCollection().

$table_obj

ilDclRecordListGUI::$table_obj

protected

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

Referenced by getRecordListTableGUI().

$tableview_id

ilDclRecordListGUI::$tableview_id

protected

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

Referenced by __construct().

CMD_CANCEL_DELETE

const ilDclRecordListGUI::CMD_CANCEL_DELETE = 'cancelDelete'

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

CMD_CONFIRM_DELETE_RECORDS

const ilDclRecordListGUI::CMD_CONFIRM_DELETE_RECORDS = 'confirmDeleteRecords'

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

CMD_DELETE_RECORDS

const ilDclRecordListGUI::CMD_DELETE_RECORDS = 'deleteRecords'

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

CMD_LIST_RECORDS

const ilDclRecordListGUI::CMD_LIST_RECORDS = 'listRecords'

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

Referenced by ilObjDataCollectionGUI\executeCommand(), and ilDclTableViewEditGUI\permissionDenied().

CMD_SHOW

const ilDclRecordListGUI::CMD_SHOW = 'show'

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

CMD_SHOW_IMPORT_EXCEL

const ilDclRecordListGUI::CMD_SHOW_IMPORT_EXCEL = 'showImportExcel'

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

GET_MODE

const ilDclRecordListGUI::GET_MODE = 'mode'

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

GET_TABLE_ID

const ilDclRecordListGUI::GET_TABLE_ID = 'table_id'

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

GET_TABLEVIEW_ID

const ilDclRecordListGUI::GET_TABLEVIEW_ID = 'tableview_id'

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

MODE_MANAGE

const ilDclRecordListGUI::MODE_MANAGE = 2

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

Referenced by ilDclRecordListTableGUI\buildData().

MODE_VIEW

const ilDclRecordListGUI::MODE_VIEW = 1

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

---

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

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