Parent class of all container content GUIs. More...

Inheritance diagram for ilContainerContentGUI:

Collaboration diagram for ilContainerContentGUI:

Public Member Functions
	getContainerObject ()

	getContainerGUI ()

	setOutput ()
	This method sets the output of the right and main column in the global standard template. More...

	getMainContent ()
	Get content HTML for main column, this one must be overwritten in derived classes. More...

	determinePageEmbeddedBlocks (string $a_container_page_html)
	Determine all blocks that are embedded in the container page. More...

	addEmbeddedBlock (string $block_type, $block_parameter)
	Add embedded block. More...

	getEmbeddedBlocks ()

	renderPageEmbeddedBlocks ()

	renderItem (array $a_item_data, int $a_position=0, bool $a_force_icon=false, string $a_pos_prefix="", string $item_group_list_presentation="")
	Render an item. More...

	renderCard (array $a_item_data, int $a_position=0, bool $a_force_icon=false, string $a_pos_prefix="")

	insertPageEmbeddedBlocks (string $a_output_html)
	Insert blocks into container page. More...

	getSingleTypeBlockAsynch (string $type)
	Render single block. More...

	getGroupedObjTypes ()
	Get grouped repository object types. More...

	getIntroduction ()

	getItemGroupsHTML (int $a_pos=0)

	renderItemGroup (array $a_itgr)

Data Fields
const	DETAILS_DEACTIVATED = 0

const	DETAILS_TITLE = 1

const	DETAILS_ALL = 2

const	VIEW_MODE_LIST = 0

const	VIEW_MODE_TILE = 1

ilContainerGUI	$container_gui

ilContainer	$container_obj

bool	$adminCommands = false

Protected Member Functions
	getViewMode ()

	getDetailsLevel (int $a_item_id)

	getRightColumnHTML ()

	getCenterColumnHTML ()

	initRenderer ()
	Init container renderer. More...

	clearAdminCommandsDetermination ()

	determineAdminCommands (int $a_ref_id, bool $a_admin_com_included_in_list=false)

	getItemGUI (array $item_data)

	hasForcedOrderByStartDate (string $type)

	handleSessionExpand ()

Protected Attributes
ilGlobalTemplateInterface	$tpl

ilCtrl	$ctrl

ilObjUser	$user

ilLanguage	$lng

ilAccessHandler	$access

ilDBInterface	$db

ilRbacSystem	$rbacsystem

ilSetting	$settings

ilObjectDefinition	$obj_definition

int	$details_level = self::DETAILS_DEACTIVATED

ilContainerRenderer	$renderer

ilLogger	$log

int	$view_mode

array	$embedded_block = []

array	$items = []

array	$list_gui = []

ClipboardManager	$clipboard

StandardGUIRequest	$request

ItemManager	$item_manager

BlockSessionRepository	$block_repo

Private Member Functions
	forwardToColumnGUI ()
	Get columngui output. More...

Detailed Description

Parent class of all container content GUIs.

These classes are responsible for displaying the content, i.e. the side column and main column and its subitems in container objects.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 32 of file class.ilContainerContentGUI.php.

Member Function Documentation

◆ addEmbeddedBlock()

ilContainerContentGUI::addEmbeddedBlock	(	string	$block_type,
			$block_parameter
	)

Add embedded block.

Parameters

string	$block_type
string \| int	$block_parameter

Definition at line 420 of file class.ilContainerContentGUI.php.

     : void {
        $this->embedded_block[$block_type][] = $block_parameter;
    }

◆ clearAdminCommandsDetermination()

ilContainerContentGUI::clearAdminCommandsDetermination ( )

protected

Definition at line 327 of file class.ilContainerContentGUI.php.

                                                        : void
    {
        $this->adminCommands = false;
    }

Referenced by ilContainerByTypeContentGUI\renderItemList(), ilContainerSessionsContentGUI\showMaterials(), and ilContainerObjectiveGUI\showObjectives().

Here is the caller graph for this function:

◆ determineAdminCommands()

ilContainerContentGUI::determineAdminCommands	(	int	$a_ref_id,
		bool	$a_admin_com_included_in_list = `false`
	)

protected

Definition at line 332 of file class.ilContainerContentGUI.php.

     : void {
        $rbacsystem = $this->rbacsystem;
 
        if (!$this->adminCommands) {
            if (!$this->getContainerGUI()->isActiveAdministrationPanel()) {
                if ($rbacsystem->checkAccess("delete", $a_ref_id)) {
                    $this->adminCommands = true;
                }
            } else {
                $this->adminCommands = $a_admin_com_included_in_list;
            }
        }
    }

References $rbacsystem, ilRbacSystem\checkAccess(), and getContainerGUI().

Here is the call graph for this function:

◆ determinePageEmbeddedBlocks()

ilContainerContentGUI::determinePageEmbeddedBlocks ( string $a_container_page_html )

Determine all blocks that are embedded in the container page.

Definition at line 393 of file class.ilContainerContentGUI.php.

     : void {
        $type_grps = $this->getGroupedObjTypes();
 
        // iterate all types
        foreach ($type_grps as $type => $v) {
            // set template (overall or type specific)
            if (is_int(strpos($a_container_page_html, "[list-" . $type . "]"))) {
                $this->addEmbeddedBlock("type", $type);
            }
        }
 
        // determine item groups
        while (preg_match('~\[(item-group-([0-9]*))\]~i', $a_container_page_html, $found)) {
            $this->addEmbeddedBlock("itgr", (int) $found[2]);
 
            $html = ''; // This was never defined before
            $a_container_page_html = preg_replace('~\[' . $found[1] . '\]~i', $html, $a_container_page_html);
        }
    }

References $type.

◆ forwardToColumnGUI()

ilContainerContentGUI::forwardToColumnGUI ( )

private

Get columngui output.

Definition at line 294 of file class.ilContainerContentGUI.php.

                                         : string
    {
        $ilCtrl = $this->ctrl;
        $html = "";
 
        // this gets us the subitems we need in setColumnSettings()
        // todo: this should be done in ilCourseGUI->getSubItems
 
        $obj_id = ilObject::_lookupObjId($this->getContainerObject()->getRefId());
        $obj_type = ilObject::_lookupType($obj_id);
 
        if (!$ilCtrl->isAsynch()) {
            if (ilColumnGUI::getScreenMode() !== IL_SCREEN_SIDE) {
                // right column wants center
                if (ilColumnGUI::getCmdSide() === IL_COL_RIGHT) {
                    $column_gui = new ilColumnGUI($obj_type, IL_COL_RIGHT);
                    $this->getContainerGUI()->setColumnSettings($column_gui);
                    $html = $ilCtrl->forwardCommand($column_gui);
                }
                // left column wants center
                if (ilColumnGUI::getCmdSide() === IL_COL_LEFT) {
                    $column_gui = new ilColumnGUI($obj_type, IL_COL_LEFT);
                    $this->getContainerGUI()->setColumnSettings($column_gui);
                    $html = $ilCtrl->forwardCommand($column_gui);
                }
            } else {
                $html = $this->getMainContent();
            }
        }
 
        return $html;
    }

References $ctrl, ilObject\_lookupObjId(), ilObject\_lookupType(), ilColumnGUI\getCmdSide(), getContainerGUI(), getContainerObject(), getMainContent(), ilColumnGUI\getScreenMode(), IL_COL_LEFT, IL_COL_RIGHT, and IL_SCREEN_SIDE.

Referenced by getCenterColumnHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCenterColumnHTML()

ilContainerContentGUI::getCenterColumnHTML ( )

protected

Definition at line 223 of file class.ilContainerContentGUI.php.

                                            : string
    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $ilDB = $this->db;
 
        $ilCtrl->saveParameterByClass("ilcolumngui", "col_return");
 
        $tpl->addOnLoadCode("il.Object.setRedrawListItemUrl('" .
            $ilCtrl->getLinkTarget($this->container_gui, "redrawListItem", "", true) . "');");
 
        $tpl->addOnLoadCode("il.Object.setRatingUrl('" .
            $ilCtrl->getLinkTargetByClass(
                [get_class($this->container_gui), "ilcommonactiondispatchergui", "ilratinggui"],
                "saveRating",
                "",
                true,
                false
            ) . "');");
 
        switch ($ilCtrl->getNextClass()) {
            case "ilcolumngui":
                $this->container_gui->setSideColumnReturn();
                $html = $this->forwardToColumnGUI();
                break;
 
            default:
                $ilDB->useSlave(true);
                $html = $this->getMainContent();
                $ilDB->useSlave(false);
                break;
        }
 
        return $html;
    }

References $ctrl, $db, $ilDB, $tpl, ilGlobalTemplateInterface\addOnLoadCode(), forwardToColumnGUI(), and getMainContent().

Referenced by setOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getContainerGUI()

ilContainerContentGUI::getContainerGUI ( )

Definition at line 134 of file class.ilContainerContentGUI.php.

                                     : ilContainerGUI
    {
        return $this->container_gui;
    }

References $container_gui.

Referenced by determineAdminCommands(), forwardToColumnGUI(), ilContainerByTypeContentGUI\getDetailsLevel(), ilContainerSessionsContentGUI\getDetailsLevel(), ilContainerByTypeContentGUI\getMainContent(), ilContainerObjectiveGUI\getMainContent(), getRightColumnHTML(), initRenderer(), ilContainerByTypeContentGUI\renderItemList(), ilContainerSessionsContentGUI\showMaterials(), and ilContainerObjectiveGUI\showObjectives().

Here is the caller graph for this function:

◆ getContainerObject()

ilContainerContentGUI::getContainerObject ( )

Definition at line 129 of file class.ilContainerContentGUI.php.

                                        : ilContainer
    {
        return $this->container_obj;
    }

References $container_obj.

Referenced by forwardToColumnGUI(), ilContainerByTypeContentGUI\getMainContent(), ilContainerObjectiveGUI\getMainContent(), getRightColumnHTML(), ilContainerByTypeContentGUI\initDetails(), initRenderer(), setOutput(), ilContainerSessionsContentGUI\showMaterials(), and ilContainerObjectiveGUI\showObjectives().

Here is the caller graph for this function:

◆ getDetailsLevel()

ilContainerContentGUI::getDetailsLevel ( int $a_item_id )

protected

Reimplemented in ilContainerByTypeContentGUI, ilContainerObjectiveGUI, ilContainerSessionsContentGUI, and ilContainerSimpleContentGUI.

Definition at line 124 of file class.ilContainerContentGUI.php.

                                                      : int
    {
        return $this->details_level;
    }

References $details_level.

◆ getEmbeddedBlocks()

ilContainerContentGUI::getEmbeddedBlocks ( )

Definition at line 427 of file class.ilContainerContentGUI.php.

                                       : array
    {
        return $this->embedded_block;
    }

◆ getGroupedObjTypes()

ilContainerContentGUI::getGroupedObjTypes ( )

Get grouped repository object types.

Definition at line 780 of file class.ilContainerContentGUI.php.

                                        : array
    {
        $objDefinition = $this->obj_definition;
 
        if (empty($this->type_grps)) {
            $this->type_grps =
                $objDefinition::getGroupedRepositoryObjectTypes($this->getContainerObject()->getType());
        }
        return $this->type_grps;
    }

Referenced by ilContainerByTypeContentGUI\renderItemList().

Here is the caller graph for this function:

◆ getIntroduction()

ilContainerContentGUI::getIntroduction ( )

Definition at line 791 of file class.ilContainerContentGUI.php.

                                     : string
    {
        $lng = $this->lng;
 
        $lng->loadLanguageModule("rep");
 
        $tpl = new ilTemplate("tpl.rep_intro.html", true, true, "Services/Repository");
        $tpl->setVariable("IMG_REP_LARGE", ilObject::_getIcon(0, "big", "root"));
        $tpl->setVariable("TXT_WELCOME", $lng->txt("rep_intro"));
        $tpl->setVariable("TXT_INTRO_1", $lng->txt("rep_intro1"));
        $tpl->setVariable("TXT_INTRO_2", $lng->txt("rep_intro2"));
        $tpl->setVariable("TXT_INTRO_3", sprintf($lng->txt("rep_intro3"), $lng->txt("add")));
        $tpl->setVariable("TXT_INTRO_4", sprintf($lng->txt("rep_intro4"), $lng->txt("cat_add")));
        $tpl->setVariable("TXT_INTRO_5", $lng->txt("rep_intro5"));
        $tpl->setVariable("TXT_INTRO_6", $lng->txt("rep_intro6"));
 
        return $tpl->get();
    }

References $lng, $tpl, and ilObject\_getIcon().

Referenced by ilContainerByTypeContentGUI\getMainContent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getItemGroupsHTML()

ilContainerContentGUI::getItemGroupsHTML ( int $a_pos = 0 )

Definition at line 810 of file class.ilContainerContentGUI.php.

                                                     : int
    {
        if (isset($this->items["itgr"]) && is_array($this->items["itgr"])) {
            foreach ($this->items["itgr"] as $itgr) {
                if (!$this->renderer->hasCustomBlock($itgr["child"])) {
                    $this->renderItemGroup($itgr);
 
                    $this->renderer->setBlockPosition($itgr["ref_id"], ++$a_pos);
                }
            }
        }
        return $a_pos;
    }

Referenced by ilContainerByTypeContentGUI\renderItemList(), and ilContainerSessionsContentGUI\showMaterials().

Here is the caller graph for this function:

◆ getItemGUI()

ilContainerContentGUI::getItemGUI ( array $item_data )

protected

Definition at line 349 of file class.ilContainerContentGUI.php.

                                                   : ilObjectListGUI
    {
        // get item list gui object
        if (!isset($this->list_gui[$item_data["type"]])) {
            $item_list_gui = ilObjectListGUIFactory::_getListGUIByType($item_data["type"]);
            $item_list_gui->setContainerObject($this->getContainerGUI());
            $this->list_gui[$item_data["type"]] = &$item_list_gui;
        } else {
            $item_list_gui = &$this->list_gui[$item_data["type"]];
        }
 
        // unique js-ids
        $item_list_gui->setParentRefId((int) ($item_data["parent"] ?? 0));
 
        $item_list_gui->setDefaultCommandParameters([]);
        $item_list_gui->disableTitleLink(false);
        $item_list_gui->resetConditionTarget();
 
        if ($this->container_obj->isClassificationFilterActive()) {
            $item_list_gui->enablePath(
                true,
                $this->container_obj->getRefId(),
                new ilSessionClassificationPathGUI()
            );
        }
 
        // activate common social commands
        $item_list_gui->enableComments(true);
        $item_list_gui->enableNotes(true);
        $item_list_gui->enableTags(true);
        $item_list_gui->enableRating(true);
 
        // reset
        $item_list_gui->forceVisibleOnly(false);
 
        // container specific modifications
        $this->getContainerGUI()->modifyItemGUI($item_list_gui, $item_data);
 
        return $item_list_gui;
    }

References ilObjectListGUIFactory\_getListGUIByType().

Here is the call graph for this function:

◆ getMainContent()

ilContainerContentGUI::getMainContent ( )

abstract

Get content HTML for main column, this one must be overwritten in derived classes.

Reimplemented in ilContainerByTypeContentGUI, ilContainerObjectiveGUI, ilContainerSessionsContentGUI, and ilContainerSimpleContentGUI.

Referenced by forwardToColumnGUI(), and getCenterColumnHTML().

Here is the caller graph for this function:

◆ getRightColumnHTML()

ilContainerContentGUI::getRightColumnHTML ( )

protected

Definition at line 181 of file class.ilContainerContentGUI.php.

                                           : string
    {
        $ilCtrl = $this->ctrl;
        $html = "";
 
        $ilCtrl->saveParameterByClass("ilcolumngui", "col_return");
 
        $obj_id = ilObject::_lookupObjId($this->getContainerObject()->getRefId());
        $obj_type = ilObject::_lookupType($obj_id);
 
        $column_gui = new ilColumnGUI($obj_type, IL_COL_RIGHT);
 
        if ($column_gui::getScreenMode() === IL_SCREEN_FULL) {
            return "";
        }
 
        $this->getContainerGUI()->setColumnSettings($column_gui);
 
        if ($ilCtrl->getNextClass() === "ilcolumngui" &&
            $column_gui::getCmdSide() === IL_COL_RIGHT &&
            $column_gui::getScreenMode() === IL_SCREEN_SIDE) {
            $html = $ilCtrl->forwardCommand($column_gui);
        } else {
            if (!$ilCtrl->isAsynch()) {
                $html = "";
 
                // user interface plugin slot + default rendering
                $uip = new ilUIHookProcessor(
                    "Services/Container",
                    "right_column",
                    ["container_content_gui" => $this]
                );
                if (!$uip->replaced()) {
                    $html = $ilCtrl->getHTML($column_gui);
                }
                $html = $uip->getHTML($html);
            }
        }
 
        return $html;
    }

References $ctrl, ilObject\_lookupObjId(), ilObject\_lookupType(), getContainerGUI(), getContainerObject(), IL_COL_RIGHT, IL_SCREEN_FULL, IL_SCREEN_SIDE, and ilCtrl\saveParameterByClass().

Referenced by setOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSingleTypeBlockAsynch()

ilContainerContentGUI::getSingleTypeBlockAsynch ( string $type )

Render single block.

Definition at line 730 of file class.ilContainerContentGUI.php.

     : string {
        $this->initRenderer();
        // get all sub items
        $this->items = $this->getContainerObject()->getSubItems(
            $this->getContainerGUI()->isActiveAdministrationPanel()
        );
 
 
        $ref_ids = $this->request->getAlreadyRenderedRefIds();
 
        // iterate all types
        if (is_array($this->items[$type]) &&
            $this->renderer->addTypeBlock($type)) {
            //$this->renderer->setBlockPosition($type, ++$pos);
 
            $position = 1;
            $counter = 1;
            foreach ($this->items[$type] as $item_data) {
                $item_ref_id = $item_data["child"];
 
                if (in_array($item_ref_id, $ref_ids)) {
                    continue;
                }
 
                if ($this->block_limit > 0 && $counter == $this->block_limit + 1) {
                    if ($counter == $this->block_limit + 1) {
                        // render more button
                        $this->renderer->addShowMoreButton($type);
                    }
                    continue;
                }
 
                if (!$this->renderer->hasItem($item_ref_id)) {
                    $html = $this->renderItem($item_data, $position++);
                    if ($html != "") {
                        $counter++;
                        $this->renderer->addItemToBlock($type, $item_data["type"], $item_ref_id, $html);
                    }
                }
            }
        }
 
        return $this->renderer->renderSingleTypeBlock($type);
    }

References $type.

◆ getViewMode()

ilContainerContentGUI::getViewMode ( )

protected

Definition at line 119 of file class.ilContainerContentGUI.php.

                                    : int
    {
        return $this->view_mode;
    }

References $view_mode.

Referenced by ilContainerGUI\getContentGUI().

Here is the caller graph for this function:

◆ handleSessionExpand()

ilContainerContentGUI::handleSessionExpand ( )

protected

Definition at line 921 of file class.ilContainerContentGUI.php.

                                            : void
    {
        $expand = $this->request->getExpand();
        if ($expand > 0) {
            $this->item_manager->setExpanded(abs($expand), self::DETAILS_ALL);
        } elseif ($expand < 0) {
            $this->item_manager->setExpanded(abs($expand), self::DETAILS_TITLE);
        }
    }

Referenced by ilContainerByTypeContentGUI\initDetails().

Here is the caller graph for this function:

◆ hasForcedOrderByStartDate()

ilContainerContentGUI::hasForcedOrderByStartDate ( string $type )

protected

Definition at line 473 of file class.ilContainerContentGUI.php.

                                                              : bool
    {
        return $type === 'sess' && get_class($this) === ilContainerSessionsContentGUI::class;
    }

References $type.

◆ initRenderer()

ilContainerContentGUI::initRenderer ( )

protected

Init container renderer.

Definition at line 268 of file class.ilContainerContentGUI.php.

                                     : void
    {
        $sorting = ilContainerSorting::_getInstance($this->getContainerObject()->getId());
 
        $this->renderer = new ilContainerRenderer(
            ($this->getContainerGUI()->isActiveAdministrationPanel() && !$this->clipboard->hasEntries()),
            $this->getContainerGUI()->isMultiDownloadEnabled(),
            $this->getContainerGUI()->isActiveOrdering() && (get_class($this) !== "ilContainerObjectiveGUI") // no block sorting in objective view
            ,
            $sorting->getBlockPositions(),
            $this->container_gui,
            $this->getViewMode(),
            $this->getContainerGUI()->isActiveAdministrationPanel()
        );
 
        // all event items are included per session rendering
        // and should return true for hasItem
        $event_items = ilEventItems::_getItemsOfContainer($this->container_obj->getRefId());
        foreach ($event_items as $ev) {
            $this->renderer->addItemId($ev);
        }
    }

References ilContainerSorting\_getInstance(), ilEventItems\_getItemsOfContainer(), getContainerGUI(), getContainerObject(), and ILIAS\Survey\Mode\getId().

Referenced by ilContainerObjectiveGUI\getMainContent(), ilContainerByTypeContentGUI\renderItemList(), and ilContainerSessionsContentGUI\showMaterials().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insertPageEmbeddedBlocks()

ilContainerContentGUI::insertPageEmbeddedBlocks ( string $a_output_html )

Insert blocks into container page.

Definition at line 696 of file class.ilContainerContentGUI.php.

                                                                   : string
    {
        $this->determinePageEmbeddedBlocks($a_output_html);
        $this->renderPageEmbeddedBlocks();
 
        // iterate all types
        foreach ($this->getGroupedObjTypes() as $type => $v) {
            // set template (overall or type specific)
            if (is_int(strpos($a_output_html, "[list-" . $type . "]"))) {
                $a_output_html = preg_replace(
                    '~\[list-' . $type . '\]~i',
                    $this->renderer->renderSingleTypeBlock($type),
                    $a_output_html
                );
            }
        }
 
        // insert all item groups
        while (preg_match('~\[(item-group-([0-9]*))\]~i', $a_output_html, $found)) {
            $itgr_ref_id = (int) $found[2];
 
            $a_output_html = preg_replace(
                '~\[' . $found[1] . '\]~i',
                $this->renderer->renderSingleCustomBlock($itgr_ref_id),
                $a_output_html
            );
        }
 
        return $a_output_html;
    }

References $type, and ILIAS\Repository\int().

Referenced by ilContainerByTypeContentGUI\renderItemList(), ilContainerSessionsContentGUI\showMaterials(), and ilContainerObjectiveGUI\showObjectives().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderCard()

ilContainerContentGUI::renderCard	(	array	$a_item_data,
		int	$a_position = `0`,
		bool	$a_force_icon = `false`,
		string	$a_pos_prefix = `""`
	)

Definition at line 661 of file class.ilContainerContentGUI.php.

     : ?\ILIAS\UI\Component\Card\RepositoryObject {
        $item_list_gui = $this->getItemGUI($a_item_data);
        $item_list_gui->setAjaxHash(ilCommonActionDispatcherGUI::buildAjaxHash(
            ilCommonActionDispatcherGUI::TYPE_REPOSITORY,
            $a_item_data['ref_id'],
            $a_item_data['type'],
            (int) $a_item_data['obj_id']
        ));
        $item_list_gui->initItem(
            (int) $a_item_data['ref_id'],
            (int) $a_item_data['obj_id'],
            (string) $a_item_data['type'],
            (string) $a_item_data['title'],
            (string) $a_item_data['description']
        );
 
        // actions
        $item_list_gui->insertCommands();
        return $item_list_gui->getAsCard(
            $a_item_data['ref_id'],
            (int) $a_item_data['obj_id'],
            (string) $a_item_data['type'],
            (string) $a_item_data['title'],
            (string) $a_item_data['description']
        );
    }

◆ renderItem()

ilContainerContentGUI::renderItem	(	array	$a_item_data,
		int	$a_position = `0`,
		bool	$a_force_icon = `false`,
		string	$a_pos_prefix = `""`,
		string	$item_group_list_presentation = `""`
	)

Render an item.

Returns: \ILIAS\UI\Component\Card\RepositoryObject|string|null

Definition at line 482 of file class.ilContainerContentGUI.php.

      {
        $ilSetting = $this->settings;
        $ilAccess = $this->access;
        $ilCtrl = $this->ctrl;
 
        // Pass type, obj_id and tree to checkAccess method to improve performance
        if (!$ilAccess->checkAccess('visible', '', $a_item_data['ref_id'], $a_item_data['type'], $a_item_data['obj_id'], $a_item_data['tree'])) {
            return '';
        }
 
        $view_mode = $this->getViewMode();
        if ($item_group_list_presentation != "") {
            $view_mode = ($item_group_list_presentation === "tile")
                ? self::VIEW_MODE_TILE
                : self::VIEW_MODE_LIST;
        }
 
        if ($view_mode === self::VIEW_MODE_TILE) {
            return $this->renderCard($a_item_data, $a_position, $a_force_icon, $a_pos_prefix);
        }
 
        $item_list_gui = $this->getItemGUI($a_item_data);
        if ($a_item_data["type"] === "sess" ||
            $a_force_icon ||
            $ilSetting->get("icon_position_in_lists") === "item_rows") {
            $item_list_gui->enableIcon(true);
        }
 
        if ($this->getContainerGUI()->isActiveAdministrationPanel() && !$this->clipboard->hasEntries()) {
            $item_list_gui->enableCheckbox(true);
        } elseif ($this->getContainerGUI()->isMultiDownloadEnabled()) {
            // display multi download checkboxes
            $item_list_gui->enableDownloadCheckbox((int) $a_item_data["ref_id"]);
        }
 
        if ($this->getContainerGUI()->isActiveItemOrdering() && !$this->hasForcedOrderByStartDate($a_item_data['type'])) {
            $item_list_gui->setPositionInputField(
                $a_pos_prefix . "[" . $a_item_data["ref_id"] . "]",
                sprintf('%d', $a_position * 10)
            );
        }
 
        if ($a_item_data['type'] === 'sess' && get_class($this) !== 'ilContainerObjectiveGUI') {
            switch ($this->getDetailsLevel($a_item_data['obj_id'])) {
                case self::DETAILS_TITLE:
                    $item_list_gui->setDetailsLevel(ilObjectListGUI::DETAILS_MINIMAL);
                    $item_list_gui->enableExpand(true);
                    $item_list_gui->setExpanded(false);
                    $item_list_gui->enableDescription(false);
                    $item_list_gui->enableProperties(true);
                    break;
 
                case self::DETAILS_ALL:
                    $item_list_gui->setDetailsLevel(ilObjectListGUI::DETAILS_ALL);
                    $item_list_gui->enableExpand(true);
                    $item_list_gui->setExpanded(true);
                    $item_list_gui->enableDescription(true);
                    $item_list_gui->enableProperties(true);
                    break;
 
                default:
                    $item_list_gui->setDetailsLevel(ilObjectListGUI::DETAILS_ALL);
                    $item_list_gui->enableExpand(true);
                    $item_list_gui->enableDescription(true);
                    $item_list_gui->enableProperties(true);
                    break;
            }
        }
 
        if (method_exists($this, "addItemDetails")) {
            $this->addItemDetails($item_list_gui, $a_item_data);
        }
 
        // show subitems
        if ($a_item_data['type'] === 'sess' && (
            $this->getDetailsLevel($a_item_data['obj_id']) !== self::DETAILS_TITLE ||
            $this->getContainerGUI()->isActiveAdministrationPanel() ||
            $this->getContainerGUI()->isActiveItemOrdering()
        )) {
            $pos = 1;
 
            $items = ilObjectActivation::getItemsByEvent($a_item_data['obj_id']);
            $items = ilContainerSorting::_getInstance($this->getContainerObject()->getId())->sortSubItems('sess', $a_item_data['obj_id'], $items);
            $items = ilContainer::getCompleteDescriptions($items);
 
            $item_readable = $ilAccess->checkAccess('read', '', $a_item_data['ref_id']);
 
            foreach ($items as $item) {
                // TODO: this should be removed and be handled by if(strlen($sub_item_html))
                //      see mantis: 0003944
                if (!$ilAccess->checkAccess('visible', '', $item['ref_id'])) {
                    continue;
                }
 
                $item_list_gui2 = $this->getItemGUI($item);
                $item_list_gui2->enableIcon(true);
                $item_list_gui2->enableItemDetailLinks(false);
 
                // unique js-ids
                $item_list_gui2->setParentRefId((int) ($a_item_data['ref_id'] ?? 0));
 
                // @see mantis 10488
                if (!$item_readable && !$ilAccess->checkAccess('write', '', $item['ref_id'])) {
                    $item_list_gui2->forceVisibleOnly(true);
                }
 
                if ($this->getContainerGUI()->isActiveAdministrationPanel() && !$this->clipboard->hasEntries()) {
                    $item_list_gui2->enableCheckbox(true);
                } elseif ($this->getContainerGUI()->isMultiDownloadEnabled()) {
                    // display multi download checkbox
                    $item_list_gui2->enableDownloadCheckbox((int) $item['ref_id']);
                }
 
                if ($this->getContainerGUI()->isActiveItemOrdering()) {
                    $item_list_gui2->setPositionInputField(
                        "[sess][" . $a_item_data['obj_id'] . "][" . $item["ref_id"] . "]",
                        sprintf('%d', $pos * 10)
                    );
                    $pos++;
                }
 
                // #10611
                ilObjectActivation::addListGUIActivationProperty($item_list_gui2, $item);
 
                $sub_item_html = $item_list_gui2->getListItemHTML(
                    $item['ref_id'],
                    $item['obj_id'],
                    $item['title'],
                    $item['description']
                );
 
                $this->determineAdminCommands($item["ref_id"], $item_list_gui2->adminCommandsIncluded());
                if ($sub_item_html !== '') {
                    $item_list_gui->addSubItemHTML($sub_item_html);
                }
            }
        }
 
        $asynch = false;
        $asynch_url = '';
        if ($ilSetting->get("item_cmd_asynch")) {
            $asynch = true;
            $ilCtrl->setParameter($this->container_gui, "cmdrefid", $a_item_data['ref_id']);
            $asynch_url = $ilCtrl->getLinkTarget(
                $this->container_gui,
                "getAsynchItemList",
                "",
                true,
                false
            );
            $ilCtrl->setParameter($this->container_gui, "cmdrefid", "");
        }
 
        ilObjectActivation::addListGUIActivationProperty($item_list_gui, $a_item_data);
 
        $html = $item_list_gui->getListItemHTML(
            (int) $a_item_data['ref_id'],
            (int) $a_item_data['obj_id'],
            (string) $a_item_data['title'],
            (string) $a_item_data['description'],
            $asynch,
            false,
            $asynch_url
        );
        $this->determineAdminCommands(
            $a_item_data["ref_id"],
            $item_list_gui->adminCommandsIncluded()
        );
 
 
        return $html;
    }

References $ilSetting, ILIAS\LTI\ToolProvider\$settings, ilContainerSorting\_getInstance(), ilObjectActivation\addListGUIActivationProperty(), ilObjectListGUI\DETAILS_ALL, ilObjectListGUI\DETAILS_MINIMAL, ilContainer\getCompleteDescriptions(), ILIAS\Survey\Mode\getId(), and ilObjectActivation\getItemsByEvent().

Referenced by ilContainerByTypeContentGUI\renderItemList(), and ilContainerSessionsContentGUI\showMaterials().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderItemGroup()

ilContainerContentGUI::renderItemGroup ( array $a_itgr )

Definition at line 824 of file class.ilContainerContentGUI.php.

                                                  : void
    {
        $ilAccess = $this->access;
        $ilUser = $this->user;
 
        // #16493
        $perm_ok = ($ilAccess->checkAccess("visible", "", $a_itgr['ref_id']) &&
             $ilAccess->checkAccess("read", "", $a_itgr['ref_id']));
 
        $items = ilObjectActivation::getItemsByItemGroup($a_itgr['ref_id']);
 
        // get all valid ids (this is filtered)
        $all_ids = array_map(static function (array $i): int {
            return (int) $i["child"];
        }, $this->items["_all"]);
 
        // remove filtered items
        $items = array_filter($items, static function (array $i) use ($all_ids): bool {
            return in_array($i["ref_id"], $all_ids);
        });
 
        // if no permission is given, set the items to "rendered" but
        // do not display the whole block
        if (!$perm_ok) {
            foreach ($items as $item) {
                $this->renderer->hideItem($item["child"]);
            }
            return;
        }
 
        $item_list_gui = $this->getItemGUI($a_itgr);
        $item_list_gui->enableNotes(false);
        $item_list_gui->enableTags(false);
        $item_list_gui->enableComments(false);
        $item_list_gui->enableTimings(false);
        $item_list_gui->getListItemHTML(
            $a_itgr["ref_id"],
            $a_itgr["obj_id"],
            $a_itgr["title"],
            $a_itgr["description"]
        );
        $commands_html = $item_list_gui->getCommandsHTML();
 
        // determine behaviour
        $item_group = new ilObjItemGroup($a_itgr["ref_id"]);
        $beh = $item_group->getBehaviour();
        $stored_val = $this->block_repo->getProperty(
            "itgr_" . $a_itgr["ref_id"],
            $ilUser->getId(),
            "opened"
        );
        if ($stored_val !== "" && $beh !== ilItemGroupBehaviour::ALWAYS_OPEN) {
            $beh = ($stored_val === "1")
                ? ilItemGroupBehaviour::EXPANDABLE_OPEN
                : ilItemGroupBehaviour::EXPANDABLE_CLOSED;
        }
 
        $data = [
            "behaviour" => $beh,
            "store-url" => "./ilias.php?baseClass=ilcontainerblockpropertiesstoragegui&cmd=store" .
                "&cont_block_id=itgr_" . $a_itgr['ref_id']
        ];
        if (ilObjItemGroup::lookupHideTitle($a_itgr["obj_id"]) &&
            !$this->getContainerGUI()->isActiveAdministrationPanel()) {
            $this->renderer->addCustomBlock($a_itgr["ref_id"], "", $commands_html, $data);
        } else {
            $this->renderer->addCustomBlock($a_itgr["ref_id"], $a_itgr["title"], $commands_html, $data);
        }
 
 
        // render item group sub items
 
        $items = ilContainerSorting::_getInstance(
            $this->getContainerObject()->getId()
        )->sortSubItems('itgr', $a_itgr['obj_id'], $items);
 
        // #18285
        $items = ilContainer::getCompleteDescriptions($items);
 
        $position = 1;
        foreach ($items as $item) {
            // we are NOT using hasItem() here, because item might be in multiple item groups
 
            $it_pres = $item_group->getListPresentation();
            if ($this->getContainerGUI()->isActiveOrdering() ||
                $this->getContainerGUI()->isActiveAdministrationPanel()) {
                $it_pres = "list";
            }
 
            $html2 = $this->renderItem($item, $position++, false, "[itgr][" . $a_itgr['obj_id'] . "]", $it_pres);
            if ($html2 != "") {
                // :TODO: show it multiple times?
                $this->renderer->addItemToBlock($a_itgr["ref_id"], $item["type"], $item["child"], $html2, true);
            }
        }
    }

References $data, $i, $ilUser, ilContainerSorting\_getInstance(), ilItemGroupBehaviour\ALWAYS_OPEN, ilItemGroupBehaviour\EXPANDABLE_CLOSED, ilItemGroupBehaviour\EXPANDABLE_OPEN, ilContainer\getCompleteDescriptions(), ILIAS\Survey\Mode\getId(), ilObjectActivation\getItemsByItemGroup(), and ilObjItemGroup\lookupHideTitle().

Here is the call graph for this function:

◆ renderPageEmbeddedBlocks()

ilContainerContentGUI::renderPageEmbeddedBlocks ( )

Definition at line 432 of file class.ilContainerContentGUI.php.

                                              : void
    {
        // item groups
        if (isset($this->embedded_block["itgr"]) && is_array($this->embedded_block["itgr"])) {
            $item_groups = [];
            if (isset($this->items["itgr"]) && is_array($this->items["itgr"])) {
                foreach ($this->items["itgr"] as $ig) {
                    $item_groups[$ig["ref_id"]] = $ig;
                }
            }
 
            foreach ($this->embedded_block["itgr"] as $ref_id) {
                if (isset($item_groups[$ref_id])) {
                    $this->renderItemGroup($item_groups[$ref_id]);
                }
            }
        }
 
        // type specific blocks
        if (isset($this->embedded_block["type"]) && is_array($this->embedded_block["type"])) {
            foreach ($this->embedded_block["type"] as $type) {
                if (isset($this->items[$type]) && is_array($this->items[$type]) && $this->renderer->addTypeBlock($type)) {
                    if ($this->hasForcedOrderByStartDate($type)) {
                        $this->items['sess'] = ilArrayUtil::sortArray($this->items['sess'], 'start', 'ASC', true, true);
                    }
 
                    $position = 1;
 
                    foreach ($this->items[$type] as $item_data) {
                        if (!$this->renderer->hasItem($item_data["child"])) {
                            $html = $this->renderItem($item_data, $position++);
                            if ($html != "") {
                                $this->renderer->addItemToBlock($type, $item_data["type"], $item_data["child"], $html);
                            }
                        }
                    }
                }
            }
        }
    }

References $ref_id, $type, and ilArrayUtil\sortArray().

Here is the call graph for this function:

◆ setOutput()

ilContainerContentGUI::setOutput ( )

This method sets the output of the right and main column in the global standard template.

Definition at line 143 of file class.ilContainerContentGUI.php.

                               : void
    {
        $tpl = $this->tpl;
        $ilCtrl = $this->ctrl;
 
        // note: we do not want to get the center html in case of
        // asynchronous calls to blocks in the right column (e.g. news)
        // see #13012
        if ($ilCtrl->getNextClass() === "ilcolumngui" &&
            $ilCtrl->isAsynch()) {
            $tpl->setRightContent($this->getRightColumnHTML());
        }
 
        // BEGIN ChangeEvent: record read event.
        $ilUser = $this->user;
 
        $obj_id = ilObject::_lookupObjId($this->getContainerObject()->getRefId());
        ilChangeEvent::_recordReadEvent(
            $this->getContainerObject()->getType(),
            $this->getContainerObject()->getRefId(),
            $obj_id,
            $ilUser->getId()
        );
        // END ChangeEvent: record read event.
 
        $html = $this->getCenterColumnHTML();
        if ($html !== '') {
            $tpl->setContent($html);
        }
 
        // see above, all other cases (this was the old position of setRightContent,
        // maybe the position above is ok and all ifs can be removed)
        if ($ilCtrl->getNextClass() !== "ilcolumngui" ||
            !$ilCtrl->isAsynch()) {
            $tpl->setRightContent($this->getRightColumnHTML());
        }
    }