ilDclDetailedViewGUI: ilDclDetailedViewDefinitionGUI, ilEditClipboardGUI, ilCommentGUI More...

Collaboration diagram for ilDclDetailedViewGUI:

Public Member Functions
	__construct (ilObjDataCollectionGUI $a_dcl_object, int $tableview_id)

	executeCommand ()

	renderRecord (bool $editComments=false)

	doReplace (array $found)

	doExtReplace (array $found)

Protected Member Functions
	offerAlternativeViews ()

	renderComments (bool $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
ILIAS UI Factory	$ui_factory

ILIAS UI Renderer	$renderer

ilObjDataCollectionGUI	$dcl_gui_object

ilDclTable	$table

int	$tableview_id

ilDclBaseRecordModel	$record_obj

int	$next_record_id = 0

int	$prev_record_id = 0

int	$current_record_position = 0

array	$record_ids = []

bool	$is_enabled_paging = true

ilLanguage	$lng

ilCtrlInterface	$ctrl

ILIAS HTTP Services	$http

ILIAS Refinery Factory	$refinery

int	$record_id

ilCommentGUI	$commentGUI

ilDclBaseFieldModel	$currentField

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

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

Private Attributes
ilGlobalTemplateInterface	$main_tpl

Detailed Description

ilDclDetailedViewGUI: ilDclDetailedViewDefinitionGUI, ilEditClipboardGUI, ilCommentGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilDclDetailedViewGUI::__construct	(	ilObjDataCollectionGUI	$a_dcl_object,
		int	$tableview_id
	)

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

References $DIC, $objId, $record_id, $ref_id, $tableview_id, ILIAS\Repository\ctrl(), determineNextPrevRecords(), ilObjStyleSheet\getContentStylePath(), ilDclCache\getRecordCache(), ilObjStyleSheet\getSyntaxStylePath(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

     {
         global $DIC;
 
         $tpl = $DIC->ui()->mainTemplate();
         $this->ctrl = $DIC->ctrl();
         $this->dcl_gui_object = $a_dcl_object;
         $this->lng = $DIC->language();
         $this->http = $DIC->http();
         $this->refinery = $DIC->refinery();
         $this->main_tpl = $DIC->ui()->mainTemplate();
         $this->ui_factory = $DIC->ui()->factory();
         $this->renderer = $DIC->ui()->renderer();
 
         $this->record_id = null;
         if ($this->http->wrapper()->query()->has('record_id')) {
             $this->record_id = $this->http->wrapper()->query()->retrieve(
                 'record_id',
                 $this->refinery->kindlyTo()->int()
             );
         }
         if ($this->http->wrapper()->post()->has('record_id')) {
             $this->record_id = $this->http->wrapper()->post()->retrieve(
                 'record_id',
                 $this->refinery->kindlyTo()->int()
             );
         }
         $ref_id = $this->dcl_gui_object->getRefId();
 
         if ($this->record_id) {
             $this->record_obj = ilDclCache::getRecordCache($this->record_id);
             $this->table = $this->record_obj->getTable();
             if (!$this->record_obj->hasPermissionToView($ref_id)) {
                 $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('dcl_msg_no_perm_view'), true);
                 $this->ctrl->redirectByClass(ilDclRecordListGUI::class, "show");
             }
         }
 
         // 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();
 
         // Comments
         $repId = $this->dcl_gui_object->getDataCollectionObject()->getId();
         $objId = $this->record_id;
         $this->commentGUI = new ilCommentGUI($repId, $objId);
         $this->commentGUI->enablePublicNotes();
         $this->commentGUI->enablePublicNotesDeletion();
         $this->ctrl->setParameterByClass(ilCommentGUI::class, "record_id", $this->record_id);
         $this->ctrl->setParameterByClass(ilCommentGUI::class, "rep_id", $repId);
 
         $this->tableview_id = $tableview_id;
 
         if ($this->http->wrapper()->query()->has('disable_paging')
             && $this->http->wrapper()->query()->retrieve('disable_paging', $this->refinery->kindlyTo()->bool())) {
             $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 416 of file class.ilDclDetailedViewGUI.php.

References $ref_id, $tableview_id, and ilDclDetailedViewDefinition\isActive().

Referenced by executeCommand().

                                     : bool
     {
         $ref_id = $this->dcl_gui_object->getRefId();
         $has_accass = ilObjDataCollectionAccess::hasAccessTo($ref_id, $this->table->getId(), $this->tableview_id);
         $is_active = ilDclDetailedViewDefinition::isActive($this->tableview_id);
         return $has_accass && $is_active;
     }

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 319 of file class.ilDclDetailedViewGUI.php.

References ilSession\get(), ilSession\has(), and loadSession().

Referenced by __construct().

                                                  : void
     {
         if (!ilSession::has("dcl_record_ids") || ilSession::get('dcl_record_ids') != $this->table->getId()) {
             $this->loadSession();
         }
 
         if (ilSession::has("dcl_record_ids") && count(ilSession::get("dcl_record_ids"))) {
             $this->record_ids = ilSession::get("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 ( array $found )

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

References ilDclCache\getRecordCache(), and ilObjDataCollectionAccess\hasWriteAccess().

                                               : ?string
     {
         $ref_rec_ids = $this->record_obj->getRecordFieldValue($this->currentField->getId());
         if (!is_array($ref_rec_ids)) {
             $ref_rec_ids = [$ref_rec_ids];
         }
         if (!count($ref_rec_ids) || !$ref_rec_ids) {
             return null;
         }
         $ref_recs = [];
         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->getRefId())) {
                 $this->main_tpl->setOnScreenMessage(
                     'info',
                     "Bad Viewdefinition at [ext tableOf=\"" . $found[1] . "\" ...]",
                     true
                 );
             }
 
             return null;
         }
 
         foreach ($ref_recs as $ref_record) {
             $tpl->setCurrentBlock("reference");
             $tpl->setVariable("CONTENT", $ref_record->getRecordFieldHTML($field->getId()));
             $tpl->parseCurrentBlock();
         }
         return $tpl->get();
     }

Here is the call graph for this function:

◆ doReplace()

ilDclDetailedViewGUI::doReplace ( array $found )

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

References setOptions().

                                            : string
     {
         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 115 of file class.ilDclDetailedViewGUI.php.

References checkAccess(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and offerAlternativeViews().

                                     : void
     {
         $this->ctrl->setParameter($this, 'tableview_id', $this->tableview_id);
 
         if (!$this->checkAccess()) {
             if ($this->table->getVisibleTableViews(0, true)) {
                 $this->offerAlternativeViews();
             } else {
                 $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
             }
 
             return;
         }
 
         $cmd = $this->ctrl->getCmd();
         $cmdClass = $this->ctrl->getCmdClass();
         switch (strtolower($cmdClass)) {
             case 'ilcommentgui':
                 $this->commentGUI->executeCommand();
                 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 393 of file class.ilDclDetailedViewGUI.php.

References $tableview_id.

Referenced by determineNextPrevRecords().

                                   : void
     {
         $list = new ilDclRecordListTableGUI(
             new ilDclRecordListGUI($this->dcl_gui_object, $this->table->getId(), $this->tableview_id),
             "listRecords",
             $this->table,
             $this->tableview_id
         );
         $list->initFilter();
         $list->determineOffsetAndOrder();
         $this->table->getPartialRecords(
             (string) $this->table->getId(),
             $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 141 of file class.ilDclDetailedViewGUI.php.

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

Referenced by executeCommand().

                                               : void
     {
         global $DIC;
         $tpl = $DIC['tpl'];
         $this->main_tpl->setOnScreenMessage('info', $this->lng->txt('dcl_msg_info_alternatives'));
         $table_gui = new ilDclTableViewTableGUI($this, 'renderRecord', $this->table, $this->dcl_gui_object->getRefId());
         $tpl->setContent($table_gui->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderComments()

ilDclDetailedViewGUI::renderComments ( bool $edit = false )

protected

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

Referenced by renderRecord().

                                                          : string
     {
         if (!$edit) {
             return $this->commentGUI->getListHTML();
         } else {
             return $this->commentGUI->addNoteForm();
         }
     }

Here is the caller graph for this function:

◆ renderPrevNextLinks()

ilDclDetailedViewGUI::renderPrevNextLinks ( )

protected

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

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

References $DIC, $next_record_id, $out, $prev_record_id, $url, and ILIAS\Repository\lng().

Referenced by renderRecord().

                                             : string
     {
         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 call graph for this function:

Here is the caller graph for this function:

◆ renderRecord()

ilDclDetailedViewGUI::renderRecord ( bool $editComments = false )

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

References $current_record_position, $DIC, $ref_id, $tableview_id, ilDclTable\getRecordFields(), ilDclCache\getTableCache(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ilDclRecordEditGUI\REDIRECT_DETAIL, ILIAS\Repository\refinery(), renderComments(), renderPrevNextLinks(), renderSelectOptions(), and setOptions().

                                                             : void
     {
         global $DIC;
         $x = $DIC->help();
         $DIC->help()->setScreenId('dcl_record');
         $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::class, "listRecords");
         }
 
         // see ilObjDataCollectionGUI->executeCommand about instantiation
         $pageObj = new ilDclDetailedViewDefinitionGUI($this->tableview_id);
         $pageObj->setOutputMode($pageObj::PRESENTATION);
 
         $html = $pageObj->showPage();
         $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, [$this, "doReplace"], $html);
             }
 
             $pattern = '/\[ext tableOf="' . preg_quote($field->getTitle(), "/") . '" field="(.*?)"\]/';
             if (preg_match($pattern, $html)) {
                 $this->currentField = $field;
                 $html = preg_replace_callback($pattern, [$this, "doExtReplace"], $html);
             }
 
             $html = str_ireplace(
                 "[" . $field->getTitle() . "]",
                 $this->record_obj->getRecordFieldSingleHTML($field->getId(), ['tableview_id' => $this->tableview_id]),
                 $html
             );
         }
         foreach ($table->getStandardFields() as $field) {
             $html = str_ireplace(
                 "[" . $field->getId() . "]",
                 $this->record_obj->getRecordFieldSingleHTML($field->getId(), ['tableview_id' => $this->tableview_id]),
                 $html
             );
         }
         $rctpl->setVariable("CONTENT", $html);
 
         //Permanent Link
         $tpl->setPermanentLink(
             'dcl',
             filter_input(INPUT_GET, 'ref_id', FILTER_VALIDATE_INT),
             $this->table->getId() . '_' . $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
         $ref_id = $this->http->wrapper()->query()->retrieve('ref_id', $this->refinery->kindlyTo()->int());
 
         if ($this->record_obj->hasPermissionToEdit($ref_id)) {
             $ilCtrl->setParameterByClass(ilDclRecordEditGUI::class, 'table_id', $this->table->getId());
             $ilCtrl->setParameterByClass(ilDclRecordEditGUI::class, 'tableview_id', $this->tableview_id);
             $ilCtrl->setParameterByClass(ilDclRecordEditGUI::class, 'redirect', ilDclRecordEditGUI::REDIRECT_DETAIL);
             $ilCtrl->saveParameterByClass(ilDclRecordEditGUI::class, 'record_id');
             $edit_button = $this->ui_factory->button()->standard(
                 $this->lng->txt('dcl_edit_record'),
                 $ilCtrl->getLinkTargetByClass(ilDclRecordEditGUI::class, 'edit')
             );
             $rctpl->setVariable('EDIT_RECORD_BUTTON', $this->renderer->render($edit_button));
         }
 
         // Comments
         if ($this->table->getPublicCommentsEnabled()) {
             $rctpl->setVariable('COMMENTS', $this->renderComments($editComments));
         }
 
         $tpl->setContent($rctpl->get());
     }

Here is the call graph for this function:

◆ renderSelectOptions()

ilDclDetailedViewGUI::renderSelectOptions ( )

protected

Render select options.

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

References $out, and $record_id.

Referenced by renderRecord().

                                             : string
     {
         $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 ( string $link_name )

private

setOptions string $link_name

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

Referenced by doReplace(), and renderRecord().

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