Collaboration diagram for ilDclDetailedViewGUI:

Public Member Functions
	__construct (ilObjDataCollectionGUI $a_dcl_object)

	executeCommand ()

	renderRecord ($editComments=false)

	doReplace ($found)

	doExtReplace ($found)

Protected Member Functions
	offerAlternativeViews ()

	renderComments ($edit=false)

	determineNextPrevRecords ()
	Find the previous/next record from the current position. More...

	renderPrevNextLinks ()
	Determine and return the markup for the previous/next records. More...

	renderSelectOptions ()
	Render select options. More...

	checkAccess ()

Protected Attributes
	$dcl_gui_object

	$notes_gui

	$table

	$tableview_id

	$record_obj

	$next_record_id = 0

	$prev_record_id = 0

	$current_record_position = 0

	$record_ids = array()

	$is_enabled_paging = true

	$lng

Private Member Functions
	setOptions ($link_name)
	setOptions string $link_name More...

	loadSession ()
	If we come from a goto Link we need to build up the session data. More...

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

Version: $Id:

ilDclDetailedViewGUI: ilDclDetailedViewDefinitionGUI, ilEditClipboardGUI

Definition at line 14 of file class.ilDclDetailedViewGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilDclDetailedViewGUI::__construct ( ilObjDataCollectionGUI $a_dcl_object )

Parameters

ilObjDataCollectionGUI $a_dcl_object

Definition at line 66 of file class.ilDclDetailedViewGUI.php.

References $_GET, $DIC, $ilCtrl, $lng, $objId, $tpl, determineNextPrevRecords(), ilObjStyleSheet\getContentStylePath(), ilDclCache\getRecordCache(), ilObjStyleSheet\getSyntaxStylePath(), and ilUtil\sendFailure().

     {
         global $DIC;
         $tpl = $DIC['tpl'];
         $ilCtrl = $DIC['ilCtrl'];
         $lng = $DIC['lng'];
         $this->dcl_gui_object = $a_dcl_object;
         $this->lng = $lng;
 
         $this->record_id = (int) $_REQUEST['record_id'];
         $this->record_obj = ilDclCache::getRecordCache($this->record_id);
 
         if (!$this->record_obj->hasPermissionToView((int) $_GET['ref_id'])) {
             ilUtil::sendFailure('dcl_msg_no_perm_view', true);
             $ilCtrl->redirectByClass('ildclrecordlistgui', 'listRecords');
         }
 
         // content style (using system defaults)
         $tpl->setCurrentBlock("SyntaxStyle");
         $tpl->setVariable("LOCATION_SYNTAX_STYLESHEET", ilObjStyleSheet::getSyntaxStylePath());
         $tpl->parseCurrentBlock();
 
         $tpl->setCurrentBlock("ContentStyle");
         $tpl->setVariable("LOCATION_CONTENT_STYLESHEET", ilObjStyleSheet::getContentStylePath(0));
         $tpl->parseCurrentBlock();
 
         $this->table = $this->record_obj->getTable();
 
         // Comments
         $repId = $this->dcl_gui_object->getDataCollectionObject()->getId();
         $objId = (int) $this->record_id;
         $this->notesGUI = new ilNoteGUI($repId, $objId);
         $this->notesGUI->enablePublicNotes(true);
         $this->notesGUI->enablePublicNotesDeletion(true);
         $ilCtrl->setParameterByClass("ilnotegui", "record_id", $this->record_id);
         $ilCtrl->setParameterByClass("ilnotegui", "rep_id", $repId);
 
         if (isset($_GET['disable_paging']) && $_GET['disable_paging']) {
             $this->is_enabled_paging = false;
         }
         // Find current, prev and next records for navigation
         if ($this->is_enabled_paging) {
             $this->determineNextPrevRecords();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkAccess()

ilDclDetailedViewGUI::checkAccess ( )

protected

Returns: bool

Definition at line 428 of file class.ilDclDetailedViewGUI.php.

References $tableview_id, and ilDclDetailedViewDefinition\isActive().

Referenced by executeCommand().

     {
         return ilObjDataCollectionAccess::hasAccessTo(filter_input(INPUT_GET, 'ref_id'), $this->table->getId(), $this->tableview_id)
             && ilDclDetailedViewDefinition::isActive($this->tableview_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ determineNextPrevRecords()

ilDclDetailedViewGUI::determineNextPrevRecords ( )

protected

Find the previous/next record from the current position.

Also determine position of current record in whole set.

Definition at line 334 of file class.ilDclDetailedViewGUI.php.

References $_SESSION, and loadSession().

Referenced by __construct().

     {
         if (!isset($_SESSION['dcl_record_ids']) || $_SESSION['dcl_table_id'] != $this->table->getId()) {
             $this->loadSession();
         }
 
         if (isset($_SESSION['dcl_record_ids']) && count($_SESSION['dcl_record_ids'])) {
             $this->record_ids = $_SESSION['dcl_record_ids'];
             foreach ($this->record_ids as $k => $recId) {
                 if ($recId == $this->record_id) {
                     if ($k != 0) {
                         $this->prev_record_id = $this->record_ids[$k - 1];
                     }
                     if (($k + 1) < count($this->record_ids)) {
                         $this->next_record_id = $this->record_ids[$k + 1];
                     }
                     $this->current_record_position = $k + 1;
                     break;
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doExtReplace()

ilDclDetailedViewGUI::doExtReplace ( $found )

Parameters

$found

Returns: string

Definition at line 282 of file class.ilDclDetailedViewGUI.php.

References $tpl, ilDclCache\getRecordCache(), ilObjDataCollectionAccess\hasWriteAccess(), and ilUtil\sendInfo().

     {
         $ref_rec_ids = $this->record_obj->getRecordFieldValue($this->currentField->getId());
         if (!is_array($ref_rec_ids)) {
             $ref_rec_ids = array($ref_rec_ids);
         }
         if (!count($ref_rec_ids) || !$ref_rec_ids) {
             return;
         }
         $ref_recs = array();
         foreach ($ref_rec_ids as $ref_rec_id) {
             $ref_recs[] = ilDclCache::getRecordCache($ref_rec_id);
         }
         $field = $ref_recs[0]->getTable()->getFieldByTitle($found[1]);
 
         $tpl = new ilTemplate("tpl.reference_list.html", true, true, "Modules/DataCollection");
         $tpl->setCurrentBlock("reference_list");
 
         if (!$field) {
             if (ilObjDataCollectionAccess::hasWriteAccess($this->dcl_gui_object->ref_id)) {
                 ilUtil::sendInfo("Bad Viewdefinition at [ext tableOf=\"" . $found[1] . "\" ...]", true);
             }
 
             return;
         }
 
         foreach ($ref_recs as $ref_record) {
             $tpl->setCurrentBlock("reference");
             $tpl->setVariable("CONTENT", $ref_record->getRecordFieldHTML($field->getId()));
             $tpl->parseCurrentBlock();
         }
 
         //$ref_rec->getRecordFieldHTML($field->getId())
         if ($field) {
             return $tpl->get();
         }
     }

Here is the call graph for this function:

◆ doReplace()

ilDclDetailedViewGUI::doReplace ( $found )

Parameters

$found

Returns: array|string

Definition at line 271 of file class.ilDclDetailedViewGUI.php.

References setOptions().

     {
         return $this->record_obj->getRecordFieldSingleHTML($this->currentField->getId(), $this->setOptions($found[1]));
     }

Here is the call graph for this function:

◆ executeCommand()

ilDclDetailedViewGUI::executeCommand ( )

Definition at line 113 of file class.ilDclDetailedViewGUI.php.

References $_GET, $DIC, $ilCtrl, checkAccess(), offerAlternativeViews(), renderRecord(), and ilUtil\sendFailure().

     {
         global $DIC;
         $ilCtrl = $DIC['ilCtrl'];
         $this->tableview_id = $_GET['tableview_id'] ? $_GET['tableview_id'] : $this->table->getFirstTableViewId($_GET['ref_id']);
         $ilCtrl->setParameter($this, 'tableview_id', $this->tableview_id);
         $ilCtrl->setParameter($this->dcl_gui_object, 'tableview_id', $_GET['back_tableview_id'] ? $_GET['back_tableview_id'] : $this->tableview_id);
 
         if (!$this->checkAccess()) {
             if ($this->table->getVisibleTableViews($_GET['ref_id'], true)) {
                 $this->offerAlternativeViews();
             } else {
                 ilUtil::sendFailure($this->lng->txt('permission_denied'), true);
             }
 
             return;
         }
 
         $cmd = $ilCtrl->getCmd();
         $cmdClass = $ilCtrl->getCmdClass();
         switch ($cmdClass) {
             case 'ilnotegui':
                 switch ($cmd) {
                     case 'editNoteForm':
                         $this->renderRecord(true);
                         break;
                     case 'showNotes':
                         $this->renderRecord(false);
                         break;
                     case 'deleteNote':
                         $this->notesGUI->deleteNote();
                         $this->renderRecord();
                         break;
                     case 'cancelDelete':
                         $this->notesGUI->cancelDelete();
                         $this->renderRecord();
                         break;
                     default:
                         $this->notesGUI->$cmd();
                         break;
                 }
                 break;
             default:
                 $this->$cmd();
                 break;
         }
     }

Here is the call graph for this function:

◆ loadSession()

ilDclDetailedViewGUI::loadSession ( )

private

If we come from a goto Link we need to build up the session data.

Definition at line 416 of file class.ilDclDetailedViewGUI.php.

Referenced by determineNextPrevRecords().

     {
         // We need the default sorting etc. to dertermine on which position we currently are, thus we instantiate the table gui.
         $list = new ilDclRecordListTableGUI(new ilDclRecordListGUI($this->dcl_gui_object, $this->table->getId()), "listRecords", $this->table, $this->tableview_id);
         //we then partially load the records. note that this also fills up session data.
         $this->table->getPartialRecords($list->getOrderField(), $list->getOrderDirection(), $list->getLimit(), $list->getOffset(), $list->getFilter());
     }

Here is the caller graph for this function:

◆ offerAlternativeViews()

ilDclDetailedViewGUI::offerAlternativeViews ( )

protected

Definition at line 162 of file class.ilDclDetailedViewGUI.php.

References $DIC, $tpl, and ilUtil\sendInfo().

Referenced by executeCommand().

     {
         global $DIC;
         $tpl = $DIC['tpl'];
         ilUtil::sendInfo($this->lng->txt('dcl_msg_info_alternatives'));
         $table_gui = new ilDclTableViewTableGUI($this, 'renderRecord', $this->table);
         $tpl->setContent($table_gui->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderComments()

ilDclDetailedViewGUI::renderComments ( $edit = false )

protected

Definition at line 321 of file class.ilDclDetailedViewGUI.php.

Referenced by renderRecord().

     {
         if (!$edit) {
             return $this->notesGUI->getOnlyCommentsHtml();
         } else {
             return $this->notesGUI->editNoteForm();
         }
     }

Here is the caller graph for this function:

◆ renderPrevNextLinks()

ilDclDetailedViewGUI::renderPrevNextLinks ( )

protected

Determine and return the markup for the previous/next records.

Returns: string

Definition at line 363 of file class.ilDclDetailedViewGUI.php.

References $DIC, $ilCtrl, $next_record_id, $out, $prev_record_id, and $url.

Referenced by renderRecord().

     {
         global $DIC;
         $ilCtrl = $DIC['ilCtrl'];
         $ilCtrl->setParameter($this, 'tableview_id', $this->tableview_id);
         $prevStr = $this->lng->txt('dcl_prev_record');
         $nextStr = $this->lng->txt('dcl_next_record');
         $ilCtrl->setParameter($this, 'record_id', $this->prev_record_id);
         $url = $ilCtrl->getLinkTarget($this, 'renderRecord');
         $out = ($this->prev_record_id) ? "<a href='{$url}'>{$prevStr}</a>" : "<span class='light'>{$prevStr}</span>";
         $out .= " | ";
         $ilCtrl->setParameter($this, 'record_id', $this->next_record_id);
         $url = $ilCtrl->getLinkTarget($this, 'renderRecord');
         $out .= ($this->next_record_id) ? "<a href='{$url}'>{$nextStr}</a>" : "<span class='light'>{$nextStr}</span>";
 
         return $out;
     }

Here is the caller graph for this function:

◆ renderRecord()

ilDclDetailedViewGUI::renderRecord ( $editComments = false )

Parameters

bool $editComments

Definition at line 175 of file class.ilDclDetailedViewGUI.php.

References $_GET, $current_record_position, $DIC, $ilCtrl, $table, $tpl, ilObjStyleSheet\getEffectiveContentStyleId(), ilLinkButton\getInstance(), ilDclCache\getTableCache(), ilDclRecordEditGUI\REDIRECT_DETAIL, renderComments(), renderPrevNextLinks(), renderSelectOptions(), and setOptions().

Referenced by executeCommand().

     {
         global $DIC;
         $ilTabs = $DIC->tabs();
         $tpl = $DIC->ui()->mainTemplate();
         $ilCtrl = $DIC->ctrl();
 
         $rctpl = new ilDataCollectionGlobalTemplate("tpl.record_view.html", false, true, "Modules/DataCollection");
 
         $ilTabs->setTabActive("id_content");
 
         if (!$this->tableview_id) {
             $ilCtrl->redirectByClass("ildclrecordlistgui", "listRecords");
         }
 
         // see ilObjDataCollectionGUI->executeCommand about instantiation
         $pageObj = new ilDclDetailedViewDefinitionGUI($this->tableview_id);
         $pageObj->setStyleId(ilObjStyleSheet::getEffectiveContentStyleId(0, "dcl"));
 
         $html = $pageObj->getHTML();
         $rctpl->addCss("./Services/COPage/css/content.css");
         $rctpl->fillCssFiles();
         $table = ilDclCache::getTableCache($this->record_obj->getTableId());
         foreach ($table->getRecordFields() as $field) {
             //ILIAS_Ref_Links
             $pattern = '/\[dcliln field="' . preg_quote($field->getTitle(), "/") . '"\](.*?)\[\/dcliln\]/';
             if (preg_match($pattern, $html)) {
                 $html = preg_replace($pattern, $this->record_obj->getRecordFieldSingleHTML($field->getId(), $this->setOptions("$1")), $html);
             }
 
             //DataCollection Ref Links
             $pattern = '/\[dclrefln field="' . preg_quote($field->getTitle(), "/") . '"\](.*?)\[\/dclrefln\]/';
             if (preg_match($pattern, $html)) {
                 $this->currentField = $field;
                 $html = preg_replace_callback($pattern, array($this, "doReplace"), $html);
             }
 
             $pattern = '/\[ext tableOf="' . preg_quote($field->getTitle(), "/") . '" field="(.*?)"\]/';
             if (preg_match($pattern, $html)) {
                 $this->currentField = $field;
                 $html = preg_replace_callback($pattern, array($this, "doExtReplace"), $html);
             }
 
             $html = str_ireplace("[" . $field->getTitle() . "]", $this->record_obj->getRecordFieldSingleHTML($field->getId()), $html);
         }
         foreach ($table->getStandardFields() as $field) {
             $html = str_ireplace("[" . $field->getId() . "]", $this->record_obj->getRecordFieldSingleHTML($field->getId()), $html);
         }
         $rctpl->setVariable("CONTENT", $html);
 
         //Permanent Link
         $tpl->setPermanentLink(
             'dcl',
             filter_input(INPUT_GET, 'ref_id', FILTER_VALIDATE_INT),
             '_' . $this->tableview_id . '_' . $this->record_obj->getId()
         );
 
         // Buttons for previous/next records
 
         if ($this->is_enabled_paging) {
             $prevNextLinks = $this->renderPrevNextLinks();
             $rctpl->setVariable('PREV_NEXT_RECORD_LINKS', $prevNextLinks);
             $ilCtrl->clearParameters($this); // #14083
             $rctpl->setVariable('FORM_ACTION', $ilCtrl->getFormAction($this));
             $rctpl->setVariable('RECORD', $this->lng->txt('dcl_record'));
             $rctpl->setVariable('RECORD_FROM_TOTAL', sprintf($this->lng->txt('dcl_record_from_total'), $this->current_record_position, count($this->record_ids)));
             $rctpl->setVariable('TABLEVIEW_ID', $this->tableview_id);
             $rctpl->setVariable('SELECT_OPTIONS', $this->renderSelectOptions());
         }
 
         // Edit Button
         if ($this->record_obj->hasPermissionToEdit((int) $_GET['ref_id'])) {
             $button = ilLinkButton::getInstance();
             $ilCtrl->setParameterByClass('ildclrecordeditgui', 'table_id', $this->table->getId());
             $ilCtrl->setParameterByClass('ildclrecordeditgui', 'tableview_id', $this->tableview_id);
             $ilCtrl->setParameterByClass('ildclrecordeditgui', 'redirect', ilDclRecordEditGUI::REDIRECT_DETAIL);
             $ilCtrl->saveParameterByClass('ildclrecordeditgui', 'record_id');
             $button->setUrl($ilCtrl->getLinkTargetByClass('ildclrecordeditgui', 'edit'));
             $button->setCaption($this->lng->txt('dcl_edit_record'), false);
             $rctpl->setVariable('EDIT_RECORD_BUTTON', $button->render());
         }
 
         // Comments
         if ($this->table->getPublicCommentsEnabled()) {
             $rctpl->setVariable('COMMENTS', $this->renderComments($editComments));
         }
 
         $tpl->setContent($rctpl->get());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderSelectOptions()

ilDclDetailedViewGUI::renderSelectOptions ( )

protected

Render select options.

Returns: string

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

References $out.

Referenced by renderRecord().

     {
         $out = '';
         foreach ($this->record_ids as $k => $recId) {
             $selected = ($recId == $this->record_id) ? " selected" : "";
             $out .= "<option value='{$recId}'{$selected}>" . ($k + 1) . "</option>";
         }
 
         return $out;
     }

Here is the caller graph for this function:

◆ setOptions()

ilDclDetailedViewGUI::setOptions ( $link_name )

private

setOptions string $link_name

Definition at line 403 of file class.ilDclDetailedViewGUI.php.

Referenced by doReplace(), and renderRecord().

     {
         $options = array();
         $options['link']['display'] = true;
         $options['link']['name'] = $link_name;
 
         return $options;
     }